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。