@jupyterlite

***`

@jupyterlite / @jupyterlite/kernel / BaseKernel

类: ``abstract BaseKernel#

定义于: packages/kernel/src/base.ts:10

处理基本内核消息的基内核类。

实现#

构造函数#

构造函数#

**new BaseKernel**(options): BaseKernel

定义于: packages/kernel/src/base.ts:16

构造一个新的 BaseKernel。

参数#

选项#

IOptions

BaseKernel 的实例化选项。

返回#

BaseKernel

访问器#

disposed#

获取签名#

**get** **disposed**(): ISignal<this, void>

定义于: packages/kernel/src/base.ts:41

内核被销毁时发出的信号。

返回#

ISignal<this, void>

对象被销毁时发出的信号。

实现#

IKernel.disposed

`***

executionCount#

获取签名#

get executionCount(): number

定义于: packages/kernel/src/base.ts:69

当前执行计数

返回#

number

***`

id#

获取签名#

**get** **id**(): string

定义于: packages/kernel/src/base.ts:48

获取内核 ID

返回#

string

服务器端内核的 ID。

实现#

IKernel.id

`***

isDisposed#

获取签名#

get isDisposed(): boolean

定义于: packages/kernel/src/base.ts:34

返回内核是否已销毁。

返回#

boolean

测试对象是否已被销毁。

备注#

此属性始终可以安全访问。

实现#

IKernel.isDisposed

***`

location#

获取签名#

**get** **location**(): string

定义于: packages/kernel/src/base.ts:62

内核从虚拟文件系统启动的位置。

返回#

string

内核从虚拟文件系统启动的位置。

实现于#

IKernel.location

`***

name#

获取签名#

get name(): string

定义于: packages/kernel/src/base.ts:55

获取内核名称

返回#

string

服务器端内核的名称。

实现#

IKernel.name

***`

parent#

获取签名#

**get** **parent**(): undefined | IMessage<MessageType>

定义于: packages/kernel/src/base.ts:83

获取最后一条父消息（模仿 ipykernel 的 get_parent）

返回#

undefined | IMessage<MessageType>

`***

parentHeader#

获取签名#

get parentHeader(): undefined | IHeader<MessageType>

定义于: packages/kernel/src/base.ts:76

获取最后一条父消息头

返回#

undefined | IHeader<MessageType>

***`

ready#

获取签名#

**get** **ready**(): Promise<void>

定义于: packages/kernel/src/base.ts:27

内核准备就绪时完成的 Promise。

返回#

Promise<void>

内核准备就绪时完成的 Promise。

实现#

IKernel.ready

方法#

clearOutput()#

protected **clearOutput**(content, parentHeader): void

定义于: packages/kernel/src/base.ts:392

向客户端发送 clear_output 消息。

参数#

内容#

clear_output 内容。

等待#

boolean

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

`***

commClose()#

abstract commClose(msg): Promise<void>

定义于: packages/kernel/src/base.ts:231

发送 comm_close 消息。

参数#

msg#

ICommCloseMsg

返回#

Promise<void>

***`

commInfoRequest()#

abstract **commInfoRequest**(content): Promise<ReplyContent<ICommInfoReply>>

定义于: packages/kernel/src/base.ts:201

处理 comm_info_request 消息。

参数#

内容#

请求的内容。

target_name?#

string

用于过滤返回的 comm 的 comm 目标名称

返回#

Promise<ReplyContent<ICommInfoReply>>

一个解析为响应消息的 Promise。

`***

commMsg()#

abstract commMsg(msg): Promise<void>

定义于: packages/kernel/src/base.ts:224

发送 comm_msg 消息。

参数#

msg#

ICommMsgMsg

comm_msg 消息。

返回#

Promise<void>

***`

commOpen()#

abstract **commOpen**(msg): Promise<void>

定义于: packages/kernel/src/base.ts:217

发送 comm_open 消息。

参数#

msg#

ICommOpenMsg

comm_open 消息。

返回#

Promise<void>

`***

completeRequest()#

abstract completeRequest(content): Promise<ReplyContent<ICompleteReply>>

定义于: packages/kernel/src/base.ts:168

处理 complete_request 消息。

参数#

内容#

请求的内容。

代码#

string

cursor_pos#

number

返回#

Promise<ReplyContent<ICompleteReply>>

***`

displayData()#

protected **displayData**(content, parentHeader): void

定义于: packages/kernel/src/base.ts:264

向客户端发送 display_data 消息。

参数#

内容#

display_data 内容。

data#

IMimeBundle

metadata#

PartialJSONObject

transient?#

{ display_id: string; }

transient.display_id?#

string

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

`***

dispose()#

dispose()：void

定义于: packages/kernel/src/base.ts:90

销毁内核。

返回#

void

实现#

IKernel.dispose

***`

executeRequest()#

abstract **executeRequest**(content): Promise<ReplyContent<IExecuteReply> & IExecuteCount>

定义于: packages/kernel/src/base.ts:159

处理 execute_request 消息。

参数#

内容#

execute_request 内核消息的内容

allow_stdin?#

boolean

是否允许 stdin 请求。默认值为 true。

代码#

string

要执行的代码。

silent?#

boolean

是否尽可能安静地执行代码。默认值为 false。

stop_on_error?#

boolean

发生错误时是否中止执行队列。默认值为 false。

store_history?#

boolean

是否存储执行历史记录。如果 silent 为 False，则默认值为 true。如果 silent 为 true，则强制为 false 。

user_expressions?#

JSONObject

名称到表达式的映射，用于在内核的交互式命名空间中进行评估。

返回#

Promise<ReplyContent<IExecuteReply> & IExecuteCount>

`***

handleComm()#

protected handleComm(type, content, metadata, buffers, parentHeader): void

定义于: packages/kernel/src/base.ts:416

向客户端发送 comm 消息。

参数#

type#

"comm_close" | "comm_msg" | "comm_open"

内容#
comm_id#

string

data#

JSONObject

metadata#

JSONObject

buffers#

undefined | (ArrayBuffer | ArrayBufferView)[]

parentHeader#

undefined | IHeader<MessageType>

返回#

void

***`

handleMessage()#

**handleMessage**(msg): Promise<void>

定义于: packages/kernel/src/base.ts:103

处理来自客户端的传入消息。

参数#

msg#

IMessage

要处理的消息

返回#

Promise<void>

实现#

IKernel.handleMessage

`***

inputReply()#

abstract inputReply(content): void

定义于: packages/kernel/src/base.ts:210

发送 input_reply 消息。

参数#

内容#

ReplyContent<IInputReply>

回复的内容。

返回#

void

***`

inputRequest()#

protected **inputRequest**(content, parentHeader): void

定义于: packages/kernel/src/base.ts:292

向客户端发送 input_request 消息。

参数#

内容#

input_request 内容。

password#

boolean

请求是否是密码。如果是，前端不应回显输入。

prompt#

string

在提示符处显示的文本。

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

`***

inspectRequest()#

abstract inspectRequest(content): Promise<ReplyContent<IInspectReply>>

定义于: packages/kernel/src/base.ts:179

处理 inspect_request 消息。

参数#

内容#

请求的内容。

代码#

string

cursor_pos#

number

detail_level#

0 | 1

返回#

Promise<ReplyContent<IInspectReply>>

一个解析为响应消息的 Promise。

***`

isCompleteRequest()#

abstract **isCompleteRequest**(content): Promise<ReplyContent<IIsCompleteReplyIncomplete | IIsCompleteReplyOther>>

定义于: packages/kernel/src/base.ts:190

处理 is_complete_request 消息。

参数#

内容#

请求的内容。

代码#

string

返回#

Promise<ReplyContent<IIsCompleteReplyIncomplete | IIsCompleteReplyOther>>

一个解析为响应消息的 Promise。

`***

kernelInfoRequest()#

abstract kernelInfoRequest(): Promise<ReplyContent<IInfoReply>>

定义于: packages/kernel/src/base.ts:152

处理 kernel_info_request 消息。

返回#

Promise<ReplyContent<IInfoReply>>

一个解析为内核信息的 Promise。

***`

publishExecuteError()#

protected **publishExecuteError**(content, parentHeader): void

定义于: packages/kernel/src/base.ts:342

向客户端发送 error 消息。

参数#

内容#

错误内容。

ename#

string

evalue#

string

traceback#

string[]

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

`***

publishExecuteResult()#

protected publishExecuteResult(content, parentHeader): void

定义于: packages/kernel/src/base.ts:317

发送 execute_result 消息。

参数#

内容#

执行结果内容。

data#

IMimeBundle

execution_count#

ExecutionCount

metadata#

PartialJSONObject

transient?#

{ display_id: string; }

transient.display_id?#

string

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

***`

stream()#

protected **stream**(content, parentHeader): void

定义于: packages/kernel/src/base.ts:239

从内核流式传输事件

参数#

内容#

流内容。

name#

"stdout" | "stderr"

text#

string

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

`***

updateDisplayData()#

protected updateDisplayData(content, parentHeader): void

定义于: packages/kernel/src/base.ts:367

向客户端发送 update_display_data 消息。

参数#

内容#

object & object

update_display_data 内容。

parentHeader#

父消息头。

undefined | IHeader<MessageType>

返回#

void

本页内容
在 GitHub 上编辑

此页面