Class PyodideInlineKernel

Inline Pyodide kernel that creates Web Worker from Blob URL.

Implements

IKernelConnection

Constructors

constructor

new PyodideInlineKernel(
_options: any,
serverSettings: ISettings,
): PyodideInlineKernel
Parameters
- _options: any
- serverSettings: ISettings
Returns PyodideInlineKernel
- Defined in webview/services/pyodideInlineKernel.ts:161

Properties

`Readonly`clientId

clientId: string

The client unique id.

Notes

This should be unique for a particular kernel connection object.

`Readonly`handleComms

handleComms: boolean = true

Whether the kernel connection handles comm messages.

Notes

The comm message protocol currently has implicit assumptions that only one kernel connection is handling comm messages. This option allows a kernel connection to opt out of handling comms.

See https://github.com/jupyter/jupyter_client/issues/263

`Readonly`id

id: string

The id of the server-side kernel.

`Readonly`model

model: IModel

The kernel model, for convenience.

`Readonly`name

name: string

The name of the server-side kernel.

`Readonly`serverSettings

serverSettings: ISettings

The server settings for the kernel.

subshellId

subshellId: string = null

The subshell ID, main shell has null.

`Readonly`username

username: string = ""

The client username.

Accessors

anyMessage

get anyMessage(): ISignal<this, any>
Signal emitted for any sent or received message.

Returns ISignal<this, any>
Implementation of Kernel.IKernelConnection.anyMessage
- Defined in webview/services/pyodideInlineKernel.ts:607

connectionStatus

get connectionStatus(): ConnectionStatus
Current connection status of the worker.

Returns ConnectionStatus
Implementation of Kernel.IKernelConnection.connectionStatus
- Defined in webview/services/pyodideInlineKernel.ts:565

connectionStatusChanged

get connectionStatusChanged(): ISignal<this, ConnectionStatus>
Signal emitted when connection status changes.

Returns ISignal<this, ConnectionStatus>
Implementation of Kernel.IKernelConnection.connectionStatusChanged
- Defined in webview/services/pyodideInlineKernel.ts:593

disposed

get disposed(): ISignal<this, void>
Signal emitted when the kernel is disposed.

Returns ISignal<this, void>
Implementation of Kernel.IKernelConnection.disposed
- Defined in webview/services/pyodideInlineKernel.ts:572

hasPendingInput

get hasPendingInput(): boolean
Whether the kernel has pending input requests.

Returns boolean
Implementation of Kernel.IKernelConnection.hasPendingInput
- Defined in webview/services/pyodideInlineKernel.ts:1164

info

get info(): Promise<any>
Promise resolving to kernel info metadata.

Returns Promise<any>
Implementation of Kernel.IKernelConnection.info
- Defined in webview/services/pyodideInlineKernel.ts:523

iopubMessage

get iopubMessage(): ISignal<this, any>
Signal emitted for IOPub channel messages.

Returns ISignal<this, any>
Implementation of Kernel.IKernelConnection.iopubMessage
- Defined in webview/services/pyodideInlineKernel.ts:579

isDisposed

get isDisposed(): boolean
Whether this kernel has been disposed.

Returns boolean
Implementation of Kernel.IKernelConnection.isDisposed
- Defined in webview/services/pyodideInlineKernel.ts:621

pendingInput

get pendingInput(): ISignal<this, boolean>
Signal emitted when pending input state changes.

Returns ISignal<this, boolean>
Implementation of Kernel.IKernelConnection.pendingInput
- Defined in webview/services/pyodideInlineKernel.ts:600

spec

get spec(): Promise<any>
Promise resolving to the kernel spec model.

Returns Promise<any>
Implementation of Kernel.IKernelConnection.spec
- Defined in webview/services/pyodideInlineKernel.ts:546

status

get status(): Status
Current execution status of the Pyodide kernel.

Returns Status
Implementation of Kernel.IKernelConnection.status
- Defined in webview/services/pyodideInlineKernel.ts:558

statusChanged

get statusChanged(): ISignal<this, Status>
Signal emitted when kernel status changes.

Returns ISignal<this, Status>
Implementation of Kernel.IKernelConnection.statusChanged
- Defined in webview/services/pyodideInlineKernel.ts:586

supportsSubshells

get supportsSubshells(): boolean
Whether the kernel supports subshells.

Returns boolean
Implementation of Kernel.IKernelConnection.supportsSubshells
- Defined in webview/services/pyodideInlineKernel.ts:1271

unhandledMessage

get unhandledMessage(): ISignal<this, IMessage<MessageType>>
Signal emitted for unhandled kernel messages.

Returns ISignal<this, IMessage<MessageType>>
Implementation of Kernel.IKernelConnection.unhandledMessage
- Defined in webview/services/pyodideInlineKernel.ts:614

Methods

clone

clone(_options?: any): IKernelConnection
Clone the kernel connection (not supported for Pyodide).
Parameters
- Optional_options: any
  Clone options (unused).
Returns IKernelConnection
Never returns, always throws.

Throws
Always throws because Pyodide kernels do not support cloning.
Implementation of Kernel.IKernelConnection.clone
- Defined in webview/services/pyodideInlineKernel.ts:644

createComm

createComm(_targetName: string, _commId?: string): any
Create a comm (not supported for Pyodide).
Parameters
- _targetName: string
  Comm target name (unused).
- Optional_commId: string
  Optional comm ID (unused).
Returns any
Throws
Always throws because Pyodide does not support comms.
Implementation of Kernel.IKernelConnection.createComm
- Defined in webview/services/pyodideInlineKernel.ts:1247

dispose

dispose(): void
Terminate the worker and dispose resources.

Returns void
Implementation of Kernel.IKernelConnection.dispose
- Defined in webview/services/pyodideInlineKernel.ts:628

hasComm

hasComm(_commId: string): boolean
Check if a comm exists (always false for Pyodide).
Parameters
- _commId: string
  Comm ID to check (unused).
Returns boolean
Always false.
Implementation of Kernel.IKernelConnection.hasComm
- Defined in webview/services/pyodideInlineKernel.ts:1257

interrupt

interrupt(): Promise<void>
Interrupt execution (not supported, web workers cannot be interrupted).

Returns Promise<void>
Implementation of Kernel.IKernelConnection.interrupt
- Defined in webview/services/pyodideInlineKernel.ts:1280

reconnect

reconnect(): Promise<void>
Reconnect to the kernel (no-op for Pyodide).

Returns Promise<void>
Implementation of Kernel.IKernelConnection.reconnect
- Defined in webview/services/pyodideInlineKernel.ts:1156

registerCommTarget

registerCommTarget(
_targetName: string,
_callback: (comm: any, msg: any) => void | PromiseLike<void>,
): void
Register a comm target (no-op for Pyodide).
Parameters
- _targetName: string
  Comm target name (unused).
- _callback: (comm: any, msg: any) => void | PromiseLike<void>
  Handler for comm open messages (unused).
Returns void
Implementation of Kernel.IKernelConnection.registerCommTarget
- Defined in webview/services/pyodideInlineKernel.ts:1110

registerMessageHook

registerMessageHook(
_msgId: string,
_hook: (msg: any) => boolean | PromiseLike<boolean>,
): void
Register a message hook (no-op for Pyodide).
Parameters
- _msgId: string
  Message ID to hook (unused).
- _hook: (msg: any) => boolean | PromiseLike<boolean>
  Hook function (unused).
Returns void
Implementation of Kernel.IKernelConnection.registerMessageHook
- Defined in webview/services/pyodideInlineKernel.ts:1134

removeCommTarget

removeCommTarget(
_targetName: string,
_callback: (comm: any, msg: any) => void | PromiseLike<void>,
): void
Remove a comm target (no-op for Pyodide).
Parameters
- _targetName: string
  Comm target name (unused).
- _callback: (comm: any, msg: any) => void | PromiseLike<void>
  Handler to remove (unused).
Returns void
Implementation of Kernel.IKernelConnection.removeCommTarget
- Defined in webview/services/pyodideInlineKernel.ts:1122

removeInputGuard

removeInputGuard(): void
Remove input guard (no-op for Pyodide).

Returns void
Implementation of Kernel.IKernelConnection.removeInputGuard
- Defined in webview/services/pyodideInlineKernel.ts:1264

removeMessageHook

removeMessageHook(
_msgId: string,
_hook: (msg: any) => boolean | PromiseLike<boolean>,
): void
Remove a message hook (no-op for Pyodide).
Parameters
- _msgId: string
  Message ID to unhook (unused).
- _hook: (msg: any) => boolean | PromiseLike<boolean>
  Hook function to remove (unused).
Returns void
Implementation of Kernel.IKernelConnection.removeMessageHook
- Defined in webview/services/pyodideInlineKernel.ts:1146

requestCommInfo

requestCommInfo(_content: any): Promise<any>
Request comm info (returns empty for Pyodide).
Parameters
- _content: any
  Comm info request content (unused).
Returns Promise<any>
Promise resolving to empty comms.
Implementation of Kernel.IKernelConnection.requestCommInfo
- Defined in webview/services/pyodideInlineKernel.ts:1077

requestComplete

requestComplete(content: any): Promise<any>
Request code completion suggestions.
Parameters
- content: any
  Completion request with cursor position.
Returns Promise<any>
Promise resolving to completion matches.
Implementation of Kernel.IKernelConnection.requestComplete
- Defined in webview/services/pyodideInlineKernel.ts:669

requestCreateSubshell

requestCreateSubshell(
_content: Record<string, unknown>,
_disposeOnDone?: boolean,
): any
Request subshell creation (not supported for Pyodide).
Parameters
- _content: Record<string, unknown>
  Subshell creation request (unused).
- Optional_disposeOnDone: boolean
  Whether to dispose after done (unused).
Returns any
Throws
Always throws because Pyodide does not support subshells.
Implementation of Kernel.IKernelConnection.requestCreateSubshell
- Defined in webview/services/pyodideInlineKernel.ts:1205

requestDebug

requestDebug(_content: {}, _disposeOnDone?: boolean): any
Request debugging (not supported for Pyodide).
Parameters
- _content: {}
  Debug request content (unused).
- Optional_disposeOnDone: boolean
  Whether to dispose after done (unused).
Returns any
Throws
Always throws because Pyodide does not support debugging.
Implementation of Kernel.IKernelConnection.requestDebug
- Defined in webview/services/pyodideInlineKernel.ts:1191

requestDeleteSubshell

requestDeleteSubshell(_content: {}, _disposeOnDone?: boolean): any
Request subshell deletion (not supported for Pyodide).
Parameters
- _content: {}
  Subshell deletion request (unused).
- Optional_disposeOnDone: boolean
  Whether to dispose after done (unused).
Returns any
Throws
Always throws because Pyodide does not support subshells.
Implementation of Kernel.IKernelConnection.requestDeleteSubshell
- Defined in webview/services/pyodideInlineKernel.ts:1219

requestExecute

requestExecute(content: any, _disposeOnDone?: boolean, _metadata?: any): any
Execute code in the Pyodide kernel via worker.
Parameters
- content: any
  Execution request with code string.
- Optional_disposeOnDone: boolean
  Whether to dispose future after completion (unused).
- Optional_metadata: any
  Optional metadata for the request (unused).
Returns any
Kernel future tracking execution progress.
Implementation of Kernel.IKernelConnection.requestExecute
- Defined in webview/services/pyodideInlineKernel.ts:801

requestHistory

requestHistory(_content: any): Promise<any>
Request command history (returns empty for Pyodide).
Parameters
- _content: any
  History request content (unused).
Returns Promise<any>
Promise resolving to empty history.
Implementation of Kernel.IKernelConnection.requestHistory
- Defined in webview/services/pyodideInlineKernel.ts:695

requestInspect

requestInspect(_content: any): Promise<any>
Request object inspection (not supported for Pyodide).
Parameters
- _content: any
  Inspection request content (unused).
Returns Promise<any>
Promise resolving to empty inspection result.
Implementation of Kernel.IKernelConnection.requestInspect
- Defined in webview/services/pyodideInlineKernel.ts:685

requestIsComplete

requestIsComplete(_content: any): Promise<any>
Check if code is complete (always returns complete for Pyodide).
Parameters
- _content: any
  Is-complete request content (unused).
Returns Promise<any>
Promise resolving to complete status.
Implementation of Kernel.IKernelConnection.requestIsComplete
- Defined in webview/services/pyodideInlineKernel.ts:1067

requestKernelInfo

requestKernelInfo(): Promise<any>
Request kernel info metadata.

Returns Promise<any>
Promise resolving to kernel info reply.
Implementation of Kernel.IKernelConnection.requestKernelInfo
- Defined in webview/services/pyodideInlineKernel.ts:659

requestListSubshell

requestListSubshell(
_content: Record<string, unknown>,
_disposeOnDone?: boolean,
): any
Request subshell listing (not supported for Pyodide).
Parameters
- _content: Record<string, unknown>
  Subshell list request (unused).
- Optional_disposeOnDone: boolean
  Whether to dispose after done (unused).
Returns any
Throws
Always throws because Pyodide does not support subshells.
Implementation of Kernel.IKernelConnection.requestListSubshell
- Defined in webview/services/pyodideInlineKernel.ts:1233

restart

restart(): Promise<void>
Restart the Pyodide kernel by terminating and recreating the worker.

Returns Promise<void>
Implementation of Kernel.IKernelConnection.restart
- Defined in webview/services/pyodideInlineKernel.ts:1294

sendControlMessage

sendControlMessage<T extends ControlMessageType>(
    _msg: IControlMessage<T>,
    _expectReply?: boolean,
    _disposeOnDone?: boolean,
): any
Send control message (not supported for Pyodide).
Type Parameters
- T extends ControlMessageType
Parameters
- _msg: IControlMessage<T>
  Control message to send (unused).
- Optional_expectReply: boolean
  Whether to expect a reply (unused).
- Optional_disposeOnDone: boolean
  Whether to dispose after done (unused).
Returns any
Throws
Always throws because Pyodide does not support control messages.
Implementation of Kernel.IKernelConnection.sendControlMessage
- Defined in webview/services/pyodideInlineKernel.ts:1176

sendInputReply

sendInputReply(_content: any): void
Send input reply (no-op for Pyodide).
Parameters
- _content: any
  Input reply content (unused).
Returns void
Implementation of Kernel.IKernelConnection.sendInputReply
- Defined in webview/services/pyodideInlineKernel.ts:1085

sendShellMessage

sendShellMessage(
    _msg: any,
    _expectReply?: boolean,
    _disposeOnDone?: boolean,
): any
Send shell message (not supported for Pyodide).
Parameters
- _msg: any
  Shell message to send (unused).
- Optional_expectReply: boolean
  Whether to expect a reply (unused).
- Optional_disposeOnDone: boolean
  Whether to dispose after done (unused).
Returns any
Throws
Always throws because Pyodide does not support direct shell messaging.
Implementation of Kernel.IKernelConnection.sendShellMessage
- Defined in webview/services/pyodideInlineKernel.ts:1097

shutdown

shutdown(): Promise<void>
Shut down the Pyodide kernel and dispose resources.

Returns Promise<void>
Implementation of Kernel.IKernelConnection.shutdown
- Defined in webview/services/pyodideInlineKernel.ts:651

Class PyodideInlineKernel

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PyodideInlineKernel

Properties

ReadonlyclientId

Notes

ReadonlyhandleComms

Notes

Readonlyid

Readonlymodel

Readonlyname

ReadonlyserverSettings

subshellId

Readonlyusername

Accessors

anyMessage

Returns ISignal<this, any>

connectionStatus

Returns ConnectionStatus

connectionStatusChanged

Returns ISignal<this, ConnectionStatus>

disposed

Returns ISignal<this, void>

hasPendingInput

Returns boolean

info

Returns Promise<any>

iopubMessage

Returns ISignal<this, any>

isDisposed

Returns boolean

pendingInput

Returns ISignal<this, boolean>

spec

Returns Promise<any>

status

Returns Status

statusChanged

Returns ISignal<this, Status>

supportsSubshells

Returns boolean

unhandledMessage

Returns ISignal<this, IMessage<MessageType>>

Methods

clone

Parameters

Returns IKernelConnection

Throws

createComm

Parameters

Returns any

Throws

dispose

Returns void

hasComm

Parameters

Returns boolean

interrupt

Returns Promise<void>

reconnect

Returns Promise<void>

registerCommTarget

Parameters

Returns void

registerMessageHook

Parameters

Returns void

removeCommTarget

Parameters

Returns void

removeInputGuard

Returns void

`Readonly`clientId

`Readonly`handleComms

`Readonly`id

`Readonly`model

`Readonly`name

`Readonly`serverSettings

`Readonly`username