bokeh.command.util#

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

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

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

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

参数:

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

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

返回:

Application

抛出:

RuntimeError –

注释

如果 path 以文件 main.py 结尾，则会打印警告，提示通过传递目录来运行目录样式的应用程序。

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

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

此函数迭代 paths 和 argvs，并对每个调用 build_single_handler_application() 以生成映射。

参数:

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

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

返回:

dict[str, Application]

抛出:

RuntimeError –

die(message: str, status: int = 1) → Never[source]#

打印错误消息并退出。

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

参数:

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

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

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

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

参数:

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

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

示例

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

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