npm 包 jupyterlab-kernel-message 使用教程

简述

npm 包 jupyterlab-kernel-message 是一款用于在前端使用 Jupyter kernel 与 Jupyter Notebook 进行通信的工具。本教程旨在帮助前端工程师快速掌握 jupyterlab-kernel-message 的使用方法。

安装

jupyterlab-kernel-message 可以通过 npm 进行安装，打开终端，输入以下命令进行安装：

npm install jupyterlab-kernel-message

安装后，就可以在项目中引入 jupyterlab-kernel-message。

使用

jupyterlab-kernel-message 主要包括两个类： KernelMessage 和 SocketKernel.

示例代码

-- -------------------- ---- -------
------ - -------------- ------------ - ---- ----------------------------

----- ------ - --- ---------------------------------------------------------------------
----- ------ - --- ---------------------

------------------------------- ----- -- -- -
  ----- ----------------- - -----------------------------
    ------- -
      --------- ----------------------
      -------- ---
    --
  ---
  ----- -------- - ----- ----------------------------------
  ----------------------
---

KernelMessage 类

KernelMessage 类主要用于创建和处理 Jupyter kernel 的消息。Jupyter kernel 消息是序列化后的 JSON 对象，具有以下结构：

-- -------------------- ---- -------
-
  --------- -
    --------- ------- ------------
    ----------- -------------
    ---------- --------- -----
    ----------- ----- -------
    ---------- -------- ---------
  --
  ---------- ----- ----------
  ---------- --
-

header 中的 msg_type 字段表示消息类型，例如执行代码的请求、接收到代码的执行结果等等。content 字段则是消息的内容。

创建消息

可以使用 KernelMessage.createMessage 方法创建一条 Jupyter kernel 消息，例如：

const kernelInfoRequest = KernelMessage.createMessage({
  header: {
    msg_type: 'kernel_info_request',
    content: {},
  },
});

以上代码创建了一条 Jupyter kernel 信息请求。msg_type 为 kernel_info_request。

解析消息

可以使用 KernelMessage.parse 方法将收到的 Jupyter kernel 消息解析为 JSON。

const message = await kernel.receive();
const parsedMessage = KernelMessage.parse(message);

SocketKernel 类

SocketKernel 类主要用于创建和管理 WebSocket 连接，发送和接收 Jupyter kernel 消息。

创建连接

可以使用以下代码创建连接：

const socket = new WebSocket('ws://localhost:8888/api/kernels/xxxxxxxxxxxxxx/channels');
const kernel = new SocketKernel(socket);

其中，ws://localhost:8888/api/kernels/xxxxxxxxxxxxxx/channels 是连接到 Jupyter Notebook kernel 的 URL。Jupyter Notebook 启动时，会为每一个 Notebook 创建唯一的 kernel，每个 kernel 都有一个唯一的连接URL。xxxxxxxxxxxxxx 则是 kernel ID。

发送请求

要发送请求，可以调用 SocketKernel.request 方法：

const kernelInfoRequest = KernelMessage.createMessage({
  header: {
    msg_type: 'kernel_info_request',
    content: {},
  },
});
const response = await kernel.request(kernelInfoRequest);

以上代码发送了一条请求并等待响应。

接收消息

要接收消息，可以调用 SocketKernel.receive 方法。

const message = await kernel.receive();

以上代码将会阻塞程序，直到收到一条 Jupyter kernel 消息。

更多操作

除了上述方法，SocketKernel 类还提供其他方法，例如：

• SocketKernel.send: 发送一条 Jupyter kernel 消息。
• SocketKernel.setSession: 设置会话 ID。
• SocketKernel.shutdown: 关闭连接。

总结

本教程介绍了 npm 包 jupyterlab-kernel-message 的安装和使用方法，详细阐述了 KernelMessage 和 SocketKernel 类的相关操作。通过本教程，前端工程师可以更方便地与 Jupyter kernel 通信，并在实践中运用本教程所介绍的方法。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600672663660cf7123b36519