Class LocalKernelClient

Client for local Python kernels using direct ZMQ communication. Works with environments that only have ipykernel installed (no jupyter-server needed).

Index

Constructors

Methods

dispose executeCode getKernel getKernelInfo getNativeKernelInfo interrupt restart start

Constructors

constructor

new LocalKernelClient(
kernelInfo: NativeKernelInfo,
documentUri?: Uri,
): LocalKernelClient
Creates a new LocalKernelClient instance.
Parameters
- kernelInfo: NativeKernelInfo
  Kernel information including Python path and kernel spec.
- OptionaldocumentUri: Uri
  Optional document URI for setting kernel working directory.
Returns LocalKernelClient
- Defined in src/services/kernel/localKernelClient.ts:58

Methods

dispose

dispose(): void
Releases all kernel resources by killing the process via SIGTERM and closing ZMQ sockets, bypassing Jupyter shutdown API.

Returns void
- Defined in src/services/kernel/localKernelClient.ts:381

executeCode

executeCode(code: string): Promise<void>
Execute code on the kernel.
Parameters
- code: string
  The code to execute.
Returns Promise<void>
Throws
Error if kernel not started.
- Defined in src/services/kernel/localKernelClient.ts:240

getKernel

getKernel(): IKernelConnection
Get the underlying kernel connection.

Returns IKernelConnection
The JupyterLab kernel connection instance, or undefined if not started.
- Defined in src/services/kernel/localKernelClient.ts:253

getKernelInfo

getKernelInfo(): Promise<unknown>
Get kernel information from the running kernel.

Returns Promise<unknown>
Kernel information object.

Throws
Error if kernel not started.
- Defined in src/services/kernel/localKernelClient.ts:287

getNativeKernelInfo

getNativeKernelInfo(): NativeKernelInfo
Get native kernel information (Python path, kernel spec, etc.).

Returns NativeKernelInfo
Native kernel information.
- Defined in src/services/kernel/localKernelClient.ts:277

interrupt

interrupt(): Promise<void>
Interrupt the kernel by sending SIGINT signal.

Returns Promise<void>
Throws
Error if kernel process not running.
- Defined in src/services/kernel/localKernelClient.ts:300

restart

restart(): Promise<void>
Restarts the kernel by killing the current process and starting a new one. Skips Jupyter shutdown API and uses direct SIGTERM since local kernels communicate via ZMQ rather than through a Jupyter server.

Returns Promise<void>
- Defined in src/services/kernel/localKernelClient.ts:316

start

start(): Promise<void>
Start the local kernel by spawning ipykernel and connecting via ZMQ.

Returns Promise<void>
Throws
Error if the client has been disposed or if kernel type is jupyter-server.
- Defined in src/services/kernel/localKernelClient.ts:67