bokeh.server.server

提供使用Tornado的基本Bokeh服务器对象 HTTPServer 和 BokeTornado Tornado应用程序为Bokeh服务器应用程序提供服务。此模块中有两个公共类：

BaseServer

这是一个轻量级类，用于显式地协调运行Bokeh服务器（a BokehTornado 实例和龙卷风 HTTPServer 还有龙卷风 IOLoop ）

Server

这个更高级的便利类只需要配置Bokeh Application 实例，并将自动创建和协调较低级别的Tornado组件。

class BaseServer(io_loop, tornado_app, http_server)[源代码]

明确协调运行Bokeh服务器所需的Tornado组件级别：

  • 龙卷风 IOLoop 运行Bokeh服务器机器。

  • 一 BokehTornado 定义Bokeh服务器机器的Tornado应用程序。

  • 龙卷风 HTTPServer 定向HTTP请求

所有三个组件都必须传递给 BaseServer ，它将初始化 BokehTornado 实例上 io_loop . 这个 http_server 必须以前用 BokehTornado 实例。

__init__(io_loop, tornado_app, http_server)[源代码]

创建一个 BaseServer 实例。

参数

  • io_loop (IOLoop) -- 龙卷风 IOLoop 在上运行Bokeh Tornado应用程序。

  • tornado_app (BokehTornado) -- 生成Bokeh文档和会话的Bokeh Tornado应用程序的实例。

  • http_server (HTTPServer) -- 龙卷风 HTTPServer 为Bokeh应用程序的HTTP请求提供服务。应该已经配置为 tornado_app 创建时。

get_session(app_path, session_id)[源代码]

通过名称应用程序路径和会话ID获取活动的会话。

参数

  • app_path (str) -- 要为其返回会话的应用程序配置的应用程序路径。

  • session_id (str) -- 要检索的会话的会话ID。

返回

ServerSession

get_sessions(app_path=None)[源代码]

获取应用程序的所有当前活动会话。

参数

app_path (str, optional) -- 要为其返回会话的应用程序配置的应用程序路径。如果没有，则返回所有应用程序的活动会话。（默认值：无）

返回

列表 [ServerSession]

run_until_shutdown()[源代码]

运行Bokeh服务器，直到用户通过键盘中断（Ctrl-C）或SIGTERM请求关闭。

调用此方法将启动龙卷风 IOLoop 并阻止调用过程中的所有执行。

返回

没有

show(app_path, browser=None, new='tab')[源代码]

在浏览器窗口或选项卡中打开应用程序。

此方法对于在本地计算机上测试或运行Bokeh服务器应用程序很有用，但在实际部署中运行Bokeh服务器时不应调用此方法。

参数

  • app_path (str) -- 打开URL后面部分的应用程序路径主机名：端口，带正斜杠。

  • browser (str, optional) -- 要显示的浏览器（默认值：无）对于支持它的系统 浏览器 参数允许指定要在哪个浏览器中显示，例如“safari”、“firefox”、“opera”、“windows default”（请参阅 webbrowser 有关更多详细信息，请参阅标准库中的模块文档）。

  • new (str, optional) -- 窗口或选项卡（默认：“选项卡”）如果 new 是“tab”，然后打开一个新选项卡。如果 new 是“窗口”，然后打开一个新窗口。

返回

没有

start()[源代码]

在Tornado上安装Bokeh服务器及其后台任务 IOLoop .

这个方法可以 not 阻止并做 not 影响龙卷风的状态 IOLoop 您必须自己启动和停止循环，也就是说，当您已经显式地管理 IOLoop 你自己。

要启动Bokeh服务器并立即以阻塞方式“永远运行”，请参见 run_until_shutdown() .

stop(wait=True)[源代码]

停止Bokeh服务器。

这将停止并删除所有Bokeh服务器 IOLoop 回调，以及停止 HTTPServer 用于配置此实例的。

参数

fast (bool) -- 是否等待有序清理（默认值：True）

返回

没有

unlisten()[源代码]

停止监听端口。调用此函数后，服务器将不再可用。

返回

没有

property address

服务器侦听HTTP请求的配置地址

property index

指向Jinja2模板的路径，该模板用于“/”处的索引

property io_loop

龙卷风 IOLoop 这个Bokeh服务器正在运行。

property port

服务器侦听HTTP请求的配置端口号

property prefix

要用于所有Bokeh服务器路径的已配置URL前缀。

class Server(applications, io_loop=None, http_server_kwargs=None, **kwargs)[源代码]

运行Bokeh服务器的高级便利类。

此类可以自动协调运行Bokeh服务器所需的三个基本级别组件：

  • 龙卷风 IOLoop 运行Bokeh服务器机器。

  • 一 BokehTornado 定义Bokeh服务器机器的Tornado应用程序。

  • 龙卷风 HTTPServer 定向HTTP请求

这个高水平 Server 类有一些限制。特别是，不可能设置显式 io_loop 和 num_procs 而不是同时1个。为此，有必要使用 BaseServer 并明确协调上述三个部分。

__init__(applications, io_loop=None, http_server_kwargs=None, **kwargs)[源代码]

创建一个 Server 实例。

参数

  • applications (dict[str, Application] or Application or callable) -- 从URL路径到应用程序实例的映射，或放在根URL的单个应用程序。应用程序是一个文档工厂，每个会话都会初始化一个新文档。如果应用程序“/”自动映射到一个“应用程序的”路径“/”上，则会自动将其映射到一个“路径”。为了方便起见，还可以提供一个callable，其中将使用 FunctionHandler .

  • io_loop (IOLoop, optional) -- 明显的龙卷风 IOLoop 在上运行Bokeh服务器代码。如果没有， IOLoop.current() 将使用（默认值：无）

  • http_server_kwargs (dict, optional) -- 传递给的额外参数 tornado.httpserver.HTTPServer . 例如。 max_buffer_size 指定最大上载大小。更多详情请访问：http://www.tornarweb.org/en/stable/httpserver.html#http-服务器如果没有，则不传递额外的参数（默认值：无）

另外，可以传递以下选项来配置 Server ：

关键字参数：

地址（班级`~bokeh.core.properties公司.String`）

服务器应侦听HTTP请求的地址。（默认值：无）

允许源站（类`~bokeh.core.properties公司.List`（类`~bokeh.core.properties公司.String`））

可以连接到websocket的主机列表。

当使用将Bokeh服务器应用程序嵌入到外部网站中时，这通常是必需的 server_document() 或者类似的。

如果没有，则使用“localhost”。（默认值：无）

索引（等级`~bokeh.core.properties公司.String`）

用于索引“/”的Jinja2模板的路径（默认值：无）

num_procs（类`~bokeh.core.properties公司.Int`）

要为HTTP服务器启动的工作进程数。如果 io_loop ，则 num_procs=1 是唯一兼容的值。使用 BaseServer 协调 IOLoop 使用多进程HTTP服务器。

值为0将自动检测核心数。

请注意，由于Tornado固有的限制，Windows不支持 num_procs 值大于1！在这种情况下，考虑在负载平衡器后面运行多个Bokeh服务器实例。（默认值：1）

端口（等级`~bokeh.core.properties公司.Int`）

服务器应侦听HTTP请求的端口号。（默认值：5006）

前缀（类`~bokeh.core.properties公司.String`）

用于所有Bokeh服务器路径的URL前缀。（默认值：“”）

ssl证书文件（类`~bokeh.core.properties公司.String`）

SSL终止的证书文件的路径。（默认值：无）

ssl密钥文件（类`~bokeh.core.properties公司.String`）

SSL终止的私钥文件的路径。（默认值：无）

ssl_密码（类`~bokeh.core.properties公司.String`）

解密SSL密钥文件的密码（如果需要）。（默认值：无）

使用前缀（类`~bokeh.core.properties公司.Bool`）

是否让Bokeh服务器覆盖所有请求的远程IP和URI方案和协议 X-Real-Ip ， X-Forwarded-For ， X-Scheme ， X-Forwarded-Proto 标题（如果提供）。（默认值：False）

websocket最大消息大小（类`~bokeh.core.properties公司.Int`）

设置龙卷风 websocket_max_message_size 价值观。（默认值：20971520）

任何剩余的关键字参数都将按原样传递给 BokehTornado .

property address

服务器侦听HTTP请求的配置地址。

property port

服务器侦听HTTP请求的配置端口号。