bokeh.server.auth_provider

提供一个钩子，用于向 Bokeh 服务器提供授权机制。

class AuthModule(module_path: PathLike)

从 Python 模块配置的 AuthProvider。

以下属性如果存在，则返回模块中的相应值，否则返回 None

• get_login_url,

• get_user

• get_user_async

• login_url

• logout_url

login_handler 属性将返回模块中的 LoginHandler 类，否则返回 None。

logout_handler 属性将返回模块中的 LogoutHandler 类，否则返回 None。

property get_login_url

一个计算 URL 的函数，用于将未经身份验证的用户重定向到登录页面。

如果提供了 login_url，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并为未经身份验证的用户返回一个登录 URL。

property get_user

一个获取当前已验证用户的函数。

如果提供了 get_user_async 函数，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并返回当前已验证用户。

property get_user_async

一个异步函数，用于获取当前已验证用户。

如果提供了 get_user 函数，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并返回当前已验证用户。

property login_handler

一个用于登录页面的请求处理程序类。

如果提供了 login_url，则此属性可能会返回 None。

如果返回一个类，它必须是 RequestHandler 的子类，该子类将用于由 logout_url 指定的端点

property login_url

一个用于将未经身份验证的用户重定向到登录页面的 URL。

如果提供了 get_login_url 函数，则此属性可能会返回 None。

property logout_handler

一个用于注销页面的请求处理程序类。

此属性可能会返回 None。

如果返回一个类，它必须是 RequestHandler 的子类，该子类将用于由 logout_url 指定的端点

property logout_url

一个用于将已验证用户重定向到注销页面的 URL。

此属性可能会返回 None。

class AuthProvider

实现授权钩子的抽象基类。

子类必须提供以下之一：get_user 或 get_user_async。

子类还必须提供以下之一 login_url 或 get_login_url。

可选地，如果 login_url 提供了一个相对 URL，那么也可以提供 login_handler。

属性 logout_url 和 get_logout_handler 与相应的登录属性类似，并且是可选的。

property endpoints: list[tuple[str, type[RequestHandler]]]

登录/注销端点的 URL 模式。

property get_login_url: Callable[[HTTPServerRequest], str] | None

一个计算 URL 的函数，用于将未经身份验证的用户重定向到登录页面。

如果提供了 login_url，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并为未经身份验证的用户返回一个登录 URL。

property get_user: Callable[[HTTPServerRequest], User] | None

一个获取当前已验证用户的函数。

如果提供了 get_user_async 函数，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并返回当前已验证用户。

property get_user_async: Callable[[HTTPServerRequest], Awaitable[User]] | None

一个异步函数，用于获取当前已验证用户。

如果提供了 get_user 函数，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并返回当前已验证用户。

property login_handler: type[RequestHandler] | None

一个用于登录页面的请求处理程序类。

如果提供了 login_url，则此属性可能会返回 None。

如果返回一个类，它必须是 RequestHandler 的子类，该子类将用于由 logout_url 指定的端点

property login_url: str | None

一个用于将未经身份验证的用户重定向到登录页面的 URL。

如果提供了 get_login_url 函数，则此属性可能会返回 None。

property logout_handler: type[RequestHandler] | None

一个用于注销页面的请求处理程序类。

此属性可能会返回 None。

如果返回一个类，它必须是 RequestHandler 的子类，该子类将用于由 logout_url 指定的端点

property logout_url: str | None

一个用于将已验证用户重定向到注销页面的 URL。

此属性可能会返回 None。

class NullAuth

默认无身份验证的 AuthProvider。

此提供者的所有属性均返回 None。

property get_login_url

一个计算 URL 的函数，用于将未经身份验证的用户重定向到登录页面。

如果提供了 login_url，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并为未经身份验证的用户返回一个登录 URL。

property get_user

一个获取当前已验证用户的函数。

如果提供了 get_user_async 函数，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并返回当前已验证用户。

property get_user_async

一个异步函数，用于获取当前已验证用户。

如果提供了 get_user 函数，则此属性可能会返回 None。

如果返回一个函数，它应该接受一个 RequestHandler 并返回当前已验证用户。

property login_handler

一个用于登录页面的请求处理程序类。

如果提供了 login_url，则此属性可能会返回 None。

如果返回一个类，它必须是 RequestHandler 的子类，该子类将用于由 logout_url 指定的端点

property login_url

一个用于将未经身份验证的用户重定向到登录页面的 URL。

如果提供了 get_login_url 函数，则此属性可能会返回 None。

property logout_handler

一个用于注销页面的请求处理程序类。

此属性可能会返回 None。

如果返回一个类，它必须是 RequestHandler 的子类，该子类将用于由 logout_url 指定的端点

property logout_url

一个用于将已验证用户重定向到注销页面的 URL。

此属性可能会返回 None。