Interface JupyterInputRequestOutputEvent

Emitted when the kernel asks the user for a value on stdin.

The kernel blocks until the request is answered, or until the execution it belongs to ends.

interface JupyterInputRequestOutputEvent {
    hidesInputValue: boolean;
    inputId: string;
    kernelId?: string;
    prompt: string;
}

Properties

hidesInputValue: boolean

Whether the value should be hidden while it is typed, and never stored.

inputId: string

Identifies the request within the kernel that asked for it.

The id is handed out per kernel, so it identifies a request only together with the kernelId. It is a 64-bit integer, sent as a string because it can exceed the range a JSON number represents exactly.

kernelId?: string

The kernel that asked for the value.

prompt: string

The text the kernel wants shown to the user.

Empty when the kernel asked for a value without one, which is how a bare input() reaches us: the protocol carries no way to tell that apart from a prompt that is absent.