bokeh.command.util

提供用于实现bokeh命令的实用函数。

build_single_handler_application(path: str, argv: list[str] | None = None) → Application

返回一个使用单个处理程序为脚本、笔记本或目录构建的Bokeh应用程序。

通常，一个Bokeh Application 可能有任意数量的处理程序来为新客户端会话初始化 Document 对象。然而，在许多情况下只需要一个处理程序。此函数检查提供的 path，并返回一个使用以下处理程序之一初始化的 Application：

• ScriptHandler 当 path 指向一个 .py 脚本时。

• NotebookHandler 当 path 指向一个 .ipynb Jupyter 笔记本时。

• DirectoryHandler 当 path 指向包含 main.py 脚本的目录时。

Parameters:

• path (str) – 用于创建Bokeh应用程序的文件或目录的路径。

• argv (seq[str], 可选) – 传递给应用程序处理器的命令行参数

Returns:

Application

Raises:

RuntimeError –

注释

如果 path 以文件 main.py 结尾，则会打印一个警告，提示通过传递目录而不是文件来运行目录风格的应用程序。

build_single_handler_applications(paths: list[str], argvs: dict[str, list[str]] | None = None) → dict[str, Application]

返回一个字典，将路由映射到使用单个处理程序构建的Bokeh应用程序，适用于指定的文件或目录。

此函数遍历 paths 和 argvs 并在每个上调用 build_single_handler_application() 以生成映射。

Parameters:

• paths (seq[str]) – 用于创建 Bokeh 应用程序的文件或目录的路径。

• argvs (dict[str, list[str]], optional) – 路径到命令行参数的映射，传递给每个路径的处理程序

Returns:

字典[str, 应用程序]

Raises:

RuntimeError –

die(message: str, status: int = 1) → Never

打印错误信息并退出。

此函数将使用给定的status调用sys.exit，并且进程将终止。

Parameters:

• message (str) – 要打印的错误信息

• status (int) – 传递给 sys.exit 的退出状态

report_server_init_errors(address: str | None = None, port: int | None = None, **kwargs: str) → Iterator[None]

一个上下文管理器，用于在由于网络问题无法启动Server时，帮助打印更具信息性的错误消息。

Parameters:

• address (str) – 服务器将监听的网络地址

• port (int) – 服务器将监听的网络地址

Example

with report_server_init_errors(**server_kwargs):
    server = Server(applications, **server_kwargs)

如果有任何错误（例如端口或地址已被使用），则会记录一个严重错误，并且进程将通过调用sys.exit(1)终止。