bokeh.client.connection

实现与 Bokeh 服务器通信的底层机制。

用户始终需要使用 ClientSession 用于标准使用场景。

class ClientConnection(session: ClientSession, websocket_url: str, io_loop: IOLoop | None = None, arguments: dict[str, str] | None = None, max_message_size: int = 20971520)

用于连接到 Bokeh 服务器的底层类。

__init__(session: ClientSession, websocket_url: str, io_loop: IOLoop | None = None, arguments: dict[str, str] | None = None, max_message_size: int = 20971520) → None

打开与服务器的 websocket 连接。

close(why: str = 'closed') → None

关闭 Websocket 连接。

force_roundtrip() → None

强制对服务器进行一次往返请求/回复，有时需要避免竞争条件。 主要用于测试。

在测试套件之外，此方法会影响性能，不应需要。

返回值：

None

loop_until_closed() → None

执行阻塞循环，运行并执行事件回调，直到连接关闭（例如，通过按下 Ctrl-C）。

虽然此方法可用于在“Bokeh 服务器”外部运行 Bokeh 应用程序代码，但强烈不建议在任何实际用例中使用此方法。

pull_doc(document: Document) → None

从服务器拉取文档，覆盖传入的文档

参数:

document – (Document) 要用服务器内容覆盖的文档。

返回值：

None

push_doc(document: Document) → Message[Any]

将文档推送到服务器，覆盖任何现有的服务器端文档。

参数:

document – (Document) 要推送到服务器的文档

返回值：

服务器回复

request_server_info() → ServerInfo

请求有关服务器的信息。

返回值：

服务器属性的字典。

property connected: bool

我们是否已连接 Websocket 并交换了初始握手消息。

property error_code: int | None

如果出现导致断开连接的错误，此属性将保存错误代码。否则为 None。

property error_detail: str

如果出现导致断开连接的错误，此属性将保存错误详细信息。否则为空字符串。

property error_reason: ErrorReason | None

连接丢失的原因，以 DISCONNECTED.ErrorReason 枚举值形式编码

property io_loop: IOLoop

此连接正在使用的 Tornado IOLoop。

property url: str

此连接所连接的 websocket 的 URL。