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 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
指定的端点
- 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。