The kernel anyMessage signal, proxied from the current kernel.
The kernel connectionStatusChanged signal, proxied from the current kernel.
A signal emitted when the object is disposed.
Unique id of the session.
The kernel iopubMessage signal, proxied from the current kernel.
The kernel.
This is a read-only property, and can be altered by [changeKernel].
A number of kernel signals are proxied through the session from whatever the current kernel is for convenience.
A signal emitted when the kernel changes.
The model associated with the session.
The current name associated with the session.
The current path associated with the session.
A signal emitted when a session property changes.
The server settings of the session.
The kernel statusChanged signal, proxied from the current kernel.
The type of the session.
The kernel unhandledMessage signal, proxied from the current kernel.
Change the kernel.
The name or id of the new kernel.
A promise that resolves with the new kernel model.
This shuts down the existing kernel and creates a new kernel, keeping the existing session ID and path. The session assumes it owns the kernel.
To start now kernel, pass an empty dictionary.
Dispose of the resources held by the object.
If the object's dispose method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Change the session name.
A promise that resolves when the session has renamed.
This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.
Change the session path.
The new session path.
A promise that resolves when the session has renamed.
This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.
Change the session type.
A promise that resolves when the session has renamed.
This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.
Kill the kernel and shutdown the session.
A promise that resolves when the session is shut down.
This uses the Jupyter REST API, and the response is validated. The promise is fulfilled on a valid response and rejected otherwise.
Generated using TypeDoc
Interface of a session object.
A session object represents a live connection to a session kernel.
This represents a persistent kernel connection with a particular key, that persists across changing kernels and kernels getting terminated. As such, a number of signals are proxied from the current kernel for convenience.
The kernel is owned by the session, in that the session creates the kernel and manages its lifecycle.