Class LocalKernelClient

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

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:56

Properties

`Private`_connectionFile

_connectionFile: string

Path to the kernel connection file

`Private`_disposed

_disposed: boolean = false

Indicates whether this client has been disposed

`Private` `Optional`_documentUri

_documentUri?: Uri

Optional document URI for setting kernel working directory

`Private`_kernelInfo

_kernelInfo: NativeKernelInfo

Kernel information including Python path and kernel spec

`Private`_kernelProcess

_kernelProcess: ChildProcess

The spawned kernel process

`Private`_realKernel

_realKernel: IKernelConnection

The JupyterLab kernel connection instance

`Private`_restarting

_restarting: boolean = false

Indicates whether a restart is in progress

Methods

`Private`createConnectionFile

createConnectionFile(): Promise<{ config: IKernelConnection; file: string }>
Create a kernel connection file with random ports.

Returns Promise<{ config: IKernelConnection; file: string }>
Object containing the connection file path and configuration
- Defined in src/services/kernel/localKernelClient.ts:184

dispose

dispose(): void
Dispose of the kernel client and clean up resources.

Note: For local kernels, we skip the shutdown() API call because:
- Local kernels don't have a Jupyter server running
- We use direct ZMQ connections, so shutdown() would fail with "Failed to parse URL"
- We kill the kernel process directly with SIGTERM instead
Returns void
- Defined in src/services/kernel/localKernelClient.ts:385

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

`Private`findFreePort

findFreePort(): Promise<number>
Find a free port by letting the OS assign one.

Returns Promise<number>
A free port number assigned by the operating system
- Defined in src/services/kernel/localKernelClient.ts:218

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:285

`Private`getKernelWorkingDirectory

getKernelWorkingDirectory(): string
Get the working directory for the kernel process.
- For file URIs: Returns the parent directory of the file
- For virtual URIs (datalayer://): Returns workspace root folder
- If no URI or workspace: Returns undefined (uses process cwd)
Returns string
Absolute path to use as kernel working directory
- Defined in src/services/kernel/localKernelClient.ts:94

getNativeKernelInfo

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

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

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:298

restart

restart(): Promise<void>
Restart the kernel by killing the current process and starting a new one. If the client has been disposed, it will be re-initialized.

Note: For local kernels, we skip the shutdown() API call because:
- Local kernels don't have a Jupyter server running
- We use direct ZMQ connections, so shutdown() would fail with "Failed to parse URL"
- We kill the kernel process directly with SIGTERM instead
Returns Promise<void>
- Defined in src/services/kernel/localKernelClient.ts:318

`Private`spawnKernelProcess

spawnKernelProcess(): Promise<void>
Spawn the ipykernel process and create ZMQ connection.

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

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:65

Class LocalKernelClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocalKernelClient

Properties

Private_connectionFile

Private_disposed

Private Optional_documentUri

Private_kernelInfo

Private_kernelProcess

Private_realKernel

Private_restarting

Methods

PrivatecreateConnectionFile

Returns Promise<{ config: IKernelConnection; file: string }>

dispose

Returns void

executeCode

Parameters

Returns Promise<void>

Throws

PrivatefindFreePort

Returns Promise<number>

getKernel

Returns IKernelConnection

getKernelInfo

Returns Promise<unknown>

Throws

PrivategetKernelWorkingDirectory

Returns string

getNativeKernelInfo

Returns NativeKernelInfo

interrupt

Returns Promise<void>

Throws

restart

Returns Promise<void>

PrivatespawnKernelProcess

Returns Promise<void>

start

Returns Promise<void>

Throws

Settings

On This Page

`Private`_connectionFile

`Private`_disposed

`Private` `Optional`_documentUri

`Private`_kernelInfo

`Private`_kernelProcess

`Private`_realKernel

`Private`_restarting

`Private`createConnectionFile

`Private`findFreePort

`Private`getKernelWorkingDirectory

`Private`spawnKernelProcess