bokeh.server.tornado

提供Bokeh服务器Tornado应用程序。

class BokehTornado(applications, prefix=None, extra_websocket_origins=None, extra_patterns=None, secret_key=None, sign_sessions=False, generate_session_ids=True, keep_alive_milliseconds=37000, check_unused_sessions_milliseconds=17000, unused_session_lifetime_milliseconds=15000, stats_log_frequency_milliseconds=15000, mem_log_frequency_milliseconds=0, use_index=True, redirect_root=True, websocket_max_message_size_bytes=20971520, index=None, auth_provider=<bokeh.server.auth_provider.NullAuth object>, xsrf_cookies=False, include_headers=None, include_cookies=None, exclude_headers=None, exclude_cookies=None, session_token_expiration=300, **kwargs)[源代码]

用于实现Bokeh服务器的Tornado应用程序。

参数

  • applications (dict[str,Application] or Application) -- 从小路到 Application 实例。如果值是单个应用程序，则生成以下映射：。。代码块：：python applications={'/'：applications}当连接进入给定路径时，关联应用程序将用于为会话生成新文档。

  • prefix (str, optional) -- 用于所有Bokeh服务器路径的URL前缀。（默认值：无）

  • extra_websocket_origins (list[str], optional) -- 可以连接到websocket的主机列表。当使用将Bokeh服务器应用程序嵌入到外部网站中时，这通常是必需的 server_document() 或者类似的。如果没有， ["localhost"] 将假定（默认值：无）

  • extra_patterns (seq[tuple], optional) -- （str、http或websocket处理程序）的元组列表使用此参数向Bokeh服务器的自定义部署添加其他端点。如果没有，那么 [] 将被使用。（默认值：无）

  • secret_key (str, optional) -- 用于签名会话ID的密钥。默认为环境变量的当前值 BOKEH_SECRET_KEY

  • sign_sessions (bool, optional) -- 是否对会话ID进行加密签名默认为环境变量的当前值 BOKEH_SIGN_SESSIONS .如果 True 然后 secret_key 还必须提供（通过环境设置或作为参数值传递）

  • generate_session_ids (bool, optional) -- 如果未提供会话ID，是否生成会话ID（默认值：True）

  • keep_alive_milliseconds (int, optional) -- 保持活动ping（默认值：37000）ping之间的毫秒数通常需要保持websocket打开。设置为0可禁用ping。

  • check_unused_sessions_milliseconds (int, optional) -- 检查未使用会话之间的毫秒数（默认值：17000）

  • unused_session_lifetime_milliseconds (int, optional) -- 未使用会话生存期的毫秒数（默认值：15000）

  • stats_log_frequency_milliseconds (int, optional) -- 日志记录统计之间的毫秒数（默认值：15000）

  • mem_log_frequency_milliseconds (int, optional) -- 启用此功能时，记录内存信息（默认值：0）之间的毫秒数需要可选依赖项 psutil 待安装。

  • use_index (bool, optional) -- 是否生成正在运行的应用程序的索引 RootHandler （默认值：True）

  • index (str, optional) -- 如果use_index为True，则作为“/”索引的Jinja2模板的路径。如果没有，则使用基本的内置应用程序索引模板。（默认值：无）

  • redirect_root (bool, optional) -- 当只有一个正在运行的应用程序时，是否将请求重定向到 "/" 如果配置了多个Bokeh应用程序，则此选项无效。

  • websocket_max_message_size_bytes (int, optional) -- 设置龙卷风 websocket_max_message_size 价值观。（默认值：20971520）

  • index -- 用于根URL的Jinja2模板的路径

  • auth_provider (AuthProvider, optional) -- AuthProvider实例

  • include_headers (list, optional) -- 要包含在会话上下文中的请求头的列表（默认情况下包括所有头）

  • exclude_headers (list, optional) -- 要在会话上下文中排除的请求头的列表（默认情况下包括所有头）

  • include_cookies (list, optional) -- 会话上下文中要包含的Cookie列表（默认情况下包括所有Cookie）

  • exclude_cookies (list, optional) -- 会话上下文中要排除的Cookie列表（默认情况下包括所有Cookie）

  • session_token_expiration (int, optional) -- 新会话的有效持续时间为秒。过期后，令牌将无法创建新会话（默认值：300）

任何其他关键字参数都传递给 tornado.web.Application .

get_session(app_path, session_id)[源代码]

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

参数

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

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

返回

ServerSession

get_sessions(app_path)[源代码]

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

参数

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

返回

列表 [ServerSession]

initialize(io_loop)[源代码]

在给定的Tornado IOLoop上启动Bokeh服务器Tornado应用程序。

resources(absolute_url=None)[源代码]

提供一个 Resources 它指定Bokeh应用程序会话从何处加载BokehJS资源。

参数

absolute_url (bool) -- 用于定位资源的绝对URL前缀。如果没有，则使用相对URL（默认值：无）

start()[源代码]

启动Bokeh服务器应用程序。

启动Bokeh服务器Tornado应用程序将定期运行统计记录、清理、ping等的回调。此外，还将运行由配置的Bokeh应用程序定义的任何启动挂钩。

stop(wait=True)[源代码]

停止应用程序服务器。

参数

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

返回

没有

property app_paths

此Bokeh服务器实例上配置的所有Bokeh应用程序的所有应用程序路径的列表。

property applications

配置的应用程序

property exclude_cookies

要在会话上下文中排除的请求cookie列表。

property exclude_headers

会话上下文中要排除的请求标头列表。

property generate_session_ids

此Bokeh服务器Tornado应用程序是否已配置为自动生成会话ID。

property include_cookies

要在会话上下文中可用的请求cookie列表。

property include_headers

要在会话上下文中可用的请求头的列表。

property index

作为索引“/”的Jinja2模板的路径

property io_loop

运行此Bokeh服务器Tornado应用程序的Tornado IOLoop。

property prefix

此Bokeh服务器Tornado应用程序的URL前缀，用于所有路径

property secret_key

此Bokeh服务器Tornado应用程序在签名会话ID时使用的密钥（如果已配置）。

property session_token_expiration

新会话令牌对会话创建有效的持续时间（秒）。

在过期后，将无法创建新的令牌。

property sign_sessions

此Bokeh服务器Tornado应用程序是否已配置为对会话ID进行加密签名

如果 True 然后 secret_key 也必须已配置。

property websocket_origins

允许连接到此服务器的websocket源的列表。