ExternalSessionObject   

Listing of External Evaluators »

ExternalSessionObject[…]

represents an external session started by StartExternalSession for use with ExternalEvaluate.

Details

  • ExternalSessionObject[…][prop] returns a property of the external session.
  • The following possible properties can be used:
  • "System"the external system or language to start
    "Version"version of the external system to use (e.g. "3.6")
    "Kernel"the Jupyter kernel name (e.g. "IFSharp")
    "Target"the target to use for evaluating code
    "ReturnType"type of object to return ("String", "Expression", ...)
    "Prolog"code to run before the command
    "Epilog"code to run after the command
    "SessionProlog"code to run before the session
    "SessionEpilog"code to run after the session
  • Available properties can be queried with ExternalSessionObject[…]["Properties"].

Examples

open allclose all

Basic Examples  (2)

Start an external session to get an ExternalSessionObject:

Delete the external session with DeleteObject:

Query properties from an ExternalSessionObject:

Delete the session object:

Scope  (2)

Start a session:

List all possible properties:

Make a dataset of all ExternalSessionObject properties:

Delete the session object:

Evaluate code in a session and see the "EvaluationCount" property increase:

Display how long the session has been running with the "SessionTime" property:

Properties & Relations  (1)

Get all external sessions with ExternalSessions:

Delete the session objects:

Wolfram Research (2017), ExternalSessionObject, Wolfram Language function, https://reference.wolfram.com/language/ref/ExternalSessionObject.html.

Text

Wolfram Research (2017), ExternalSessionObject, Wolfram Language function, https://reference.wolfram.com/language/ref/ExternalSessionObject.html.

CMS

Wolfram Language. 2017. "ExternalSessionObject." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/ExternalSessionObject.html.

APA

Wolfram Language. (2017). ExternalSessionObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/ExternalSessionObject.html

BibTeX

@misc{reference.wolfram_2024_externalsessionobject, author="Wolfram Research", title="{ExternalSessionObject}", year="2017", howpublished="\url{https://reference.wolfram.com/language/ref/ExternalSessionObject.html}", note=[Accessed: 22-December-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_externalsessionobject, organization={Wolfram Research}, title={ExternalSessionObject}, year={2017}, url={https://reference.wolfram.com/language/ref/ExternalSessionObject.html}, note=[Accessed: 22-December-2024 ]}