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

constructor

new LocalKernelClient(kernelInfo: NativeKernelInfo): LocalKernelClient
Parameters
- kernelInfo: NativeKernelInfo
Returns LocalKernelClient
- Defined in src/services/kernel/localKernelClient.ts:33

Properties

`Private`_connectionFile

_connectionFile: string

`Private`_disposed

_disposed: boolean = false

`Private`_kernelInfo

_kernelInfo: NativeKernelInfo

`Private`_kernelProcess

_kernelProcess: ChildProcess

`Private`_realKernel

_realKernel: IKernelConnection

Methods

`Private`createConnectionFile

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

Returns Promise<{ config: IKernelConnection; file: string }>
- Defined in src/services/kernel/localKernelClient.ts:147

dispose

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

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

executeCode

executeCode(code: string): Promise<void>
Execute code on the kernel.
Parameters
- code: string
Returns Promise<void>
- Defined in src/services/kernel/localKernelClient.ts:200

`Private`findFreePort

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

Returns Promise<number>
- Defined in src/services/kernel/localKernelClient.ts:180

getKernel

getKernel(): IKernelConnection
Get the underlying kernel connection.

Returns IKernelConnection
- Defined in src/services/kernel/localKernelClient.ts:227

getKernelInfo

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

Returns Promise<unknown>
- Defined in src/services/kernel/localKernelClient.ts:248

interrupt

interrupt(): Promise<void>
Interrupt the kernel.

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

restart

restart(): Promise<void>
Restart the kernel.

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

`Private`spawnKernelProcess

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

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

start

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

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

Class LocalKernelClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocalKernelClient

Properties

`Private`_connectionFile

`Private`_disposed

`Private`_kernelInfo

`Private`_kernelProcess

`Private`_realKernel

Methods

`Private`createConnectionFile

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

dispose

Returns void

executeCode

Parameters

Returns Promise<void>

`Private`findFreePort

Returns Promise<number>

getKernel

Returns IKernelConnection

getKernelInfo

Returns Promise<unknown>

interrupt

Returns Promise<void>

restart

Returns Promise<void>

`Private`spawnKernelProcess

Returns Promise<void>

start

Returns Promise<void>

Settings

On This Page

Class LocalKernelClient

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocalKernelClient

Properties

Private_connectionFile

Private_disposed

Private_kernelInfo

Private_kernelProcess

Private_realKernel

Methods

PrivatecreateConnectionFile

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

dispose

Returns void

executeCode

Parameters

Returns Promise<void>

PrivatefindFreePort

Returns Promise<number>

getKernel

Returns IKernelConnection

getKernelInfo

Returns Promise<unknown>

interrupt

Returns Promise<void>

restart

Returns Promise<void>

PrivatespawnKernelProcess

Returns Promise<void>

start

Returns Promise<void>

Settings

On This Page

`Private`_connectionFile

`Private`_disposed

`Private`_kernelInfo

`Private`_kernelProcess

`Private`_realKernel

`Private`createConnectionFile

`Private`findFreePort

`Private`spawnKernelProcess