mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-08-15 03:04:27 +08:00
61 lines
2.1 KiB
Python
61 lines
2.1 KiB
Python
"""Ready-to-use and customizable users management for FastAPI."""
|
|
|
|
from typing import Any, Callable, Type
|
|
|
|
from fastapi import APIRouter
|
|
|
|
from fastapi_users.authentication import BaseAuthentication
|
|
from fastapi_users.db import BaseUserDatabase
|
|
from fastapi_users.models import BaseUser, BaseUserDB
|
|
from fastapi_users.router import get_user_router
|
|
|
|
|
|
class FastAPIUsers:
|
|
"""
|
|
Main object that ties together the component for users authentication.
|
|
|
|
:param db: Database adapter instance.
|
|
:param auth: Authentication logic instance.
|
|
:param user_model: Pydantic model of a user.
|
|
:param on_after_forgot_password: Hook called after a forgot password request.
|
|
:param reset_password_token_secret: Secret to encode reset password token.
|
|
:param reset_password_token_lifetime_seconds: Lifetime of reset password token.
|
|
|
|
:attribute router: FastAPI router exposing authentication routes.
|
|
:attribute get_current_user: Dependency callable to inject authenticated user.
|
|
"""
|
|
|
|
db: BaseUserDatabase
|
|
auth: BaseAuthentication
|
|
router: APIRouter
|
|
get_current_user: Callable[..., BaseUserDB]
|
|
|
|
def __init__(
|
|
self,
|
|
db: BaseUserDatabase,
|
|
auth: BaseAuthentication,
|
|
user_model: Type[BaseUser],
|
|
on_after_forgot_password: Callable[[BaseUserDB, str], Any],
|
|
reset_password_token_secret: str,
|
|
reset_password_token_lifetime_seconds: int = 3600,
|
|
):
|
|
self.db = db
|
|
self.auth = auth
|
|
self.router = get_user_router(
|
|
self.db,
|
|
user_model,
|
|
self.auth,
|
|
on_after_forgot_password,
|
|
reset_password_token_secret,
|
|
reset_password_token_lifetime_seconds,
|
|
)
|
|
|
|
get_current_user = self.auth.get_current_user(self.db)
|
|
self.get_current_user = get_current_user # type: ignore
|
|
|
|
get_current_active_user = self.auth.get_current_active_user(self.db)
|
|
self.get_current_active_user = get_current_active_user # type: ignore
|
|
|
|
get_current_superuser = self.auth.get_current_superuser(self.db)
|
|
self.get_current_superuser = get_current_superuser # type: ignore
|