bokeh.server.views

auth_mixin

提供一个mixin类来向请求处理程序添加授权钩子。

class AuthMixin

此mixin添加了预期的Tornado授权挂钩：

• get_login_url

• get_current_user

• 准备

所有这些都委托给 AuthProvider 在Bokeh tornado应用程序上确认。

get_current_user()

委托给同步 get_user 身份验证提供程序的方法

get_login_url()

委托到身份验证提供程序的“getu loginu url”方法，或 login_url 属性。

async prepare()

的异步对应项 get_current_user

autoload_js_handler

提供返回显示文档的页面的请求处理程序。

class AutoloadJsHandler(tornado_app, *args, **kw)

为autoload JS块实现一个自定义Tornado处理程序

async options(*args, **kwargs)

浏览器在一个GET请求之前暗中发出OPTIONS请求

set_default_headers()

重写此项以在请求开始时设置HTTP头。

例如，这是设置自定义 Server 标题。请注意，在正常的请求处理流中设置这样的头可能不会满足您的需要，因为在错误处理期间头可能会被重置。

doc_handler

提供返回显示文档的页面的请求处理程序。

class DocHandler(tornado_app, *args, **kw)

实现文档显示页的自定义Tornado处理程序

autoload_metadata_handler

提供一个请求处理程序，它从应用程序返回带有元数据信息的json

class MetadataHandler(tornado_app, *args, **kw)

实现文档显示页的自定义Tornado处理程序

root_handler

提供一个请求处理程序，列出应用程序（如果不止一个）或（如果只有一个）重定向到该应用程序的路由。

class RootHandler(application: tornado.web.Application, request: tornado.httputil.HTTPServerRequest, **kwargs: Any)

实现一个自定义Tornado处理程序，以在只有一个应用程序重定向到该应用程序路由时显示可用的应用程序

get_current_user()

委托给同步 get_user 身份验证提供程序的方法

get_login_url()

委托到身份验证提供程序的“getu loginu url”方法，或 login_url 属性。

async prepare()

的异步对应项 get_current_user

session_handler

处理bokeh会话id的抽象请求处理程序

class SessionHandler(tornado_app, *args, **kw)

实现文档显示页的自定义Tornado处理程序

get_current_user()

委托给同步 get_user 身份验证提供程序的方法

get_login_url()

委托到身份验证提供程序的“getu loginu url”方法，或 login_url 属性。

async prepare()

的异步对应项 get_current_user

static_handler

提供返回显示文档的页面的请求处理程序。

class StaticHandler(tornado_app, *args, **kw)

为BokehJS JavaScript和CSS资源实现自定义Tornado静态文件处理程序。

WS

为Bokeh服务器应用程序提供一个web套接字处理程序。

class WSHandler(tornado_app, *args, **kw)

为Bokeh服务器实现自定义Tornado WebSocketHandler。

check_origin(origin)

对Tornado调用执行check_origin策略。

提供的源将与Bokeh服务器allowlist进行比较。如果原点不允许，将记录一个错误并 False 将被退回。

参数

origin (str) -- 连接源的URL

返回

bool，如果允许连接，则为True，否则为False

on_close()

连接关闭时进行清理。

async on_message(fragment)

处理一个单独的有线协议片段。

websocketrfc指定用于区分文本帧和二进制帧的操作码。Tornado给我们一个文本或二进制字符串，这取决于操作码，我们必须查看片段的类型，看看我们得到了什么。

参数

fragment (unicode or bytes) -- 要处理的导线碎片

on_pong(data)

当接收到对ping帧的响应时调用。

open()

初始化与客户端的连接。

返回

没有

select_subprotocol(subprotocols)

重写以实现子协议协商。

subprotocols 是一个字符串列表，用于标识客户端建议的子协议。可以重写此方法以返回其中一个字符串来选择它，或者 None 不选择子协议。

选择子协议失败不会自动中止连接，但如果未选择任何建议的子协议，则客户端可能会关闭连接。

列表可能为空，在这种情况下，此方法必须返回“无”。即使没有提出子协议，也始终只调用一次此方法，这样就可以通知处理程序这一事实。

在 5.1 版更改: 以前，如果客户机没有建议任何子协议，则使用包含空字符串而不是空列表的列表调用此方法。

async send_message(message)

向连接的客户端发送Bokeh服务器协议消息。

参数

message (Message) -- 要发送的消息

async write_message(message, binary=False, locked=True)

重写父写u消息，该版本在写入之前获取写入锁。