mirror of
https://github.com/fastapi-users/fastapi-users.git
synced 2025-11-01 01:48:46 +08:00
51 lines
1.6 KiB
Python
51 lines
1.6 KiB
Python
from typing import Any, Generic
|
|
|
|
from fastapi_users.models import ID, OAP, UOAP, UP
|
|
from fastapi_users.types import DependencyCallable
|
|
|
|
|
|
class BaseUserDatabase(Generic[UP, ID]):
|
|
"""Base adapter for retrieving, creating and updating users from a database."""
|
|
|
|
async def get(self, id: ID) -> UP | None:
|
|
"""Get a single user by id."""
|
|
raise NotImplementedError()
|
|
|
|
async def get_by_email(self, email: str) -> UP | None:
|
|
"""Get a single user by email."""
|
|
raise NotImplementedError()
|
|
|
|
async def get_by_oauth_account(self, oauth: str, account_id: str) -> UP | None:
|
|
"""Get a single user by OAuth account id."""
|
|
raise NotImplementedError()
|
|
|
|
async def create(self, create_dict: dict[str, Any]) -> UP:
|
|
"""Create a user."""
|
|
raise NotImplementedError()
|
|
|
|
async def update(self, user: UP, update_dict: dict[str, Any]) -> UP:
|
|
"""Update a user."""
|
|
raise NotImplementedError()
|
|
|
|
async def delete(self, user: UP) -> None:
|
|
"""Delete a user."""
|
|
raise NotImplementedError()
|
|
|
|
async def add_oauth_account(
|
|
self: "BaseUserDatabase[UOAP, ID]", user: UOAP, create_dict: dict[str, Any]
|
|
) -> UOAP:
|
|
"""Create an OAuth account and add it to the user."""
|
|
raise NotImplementedError()
|
|
|
|
async def update_oauth_account(
|
|
self: "BaseUserDatabase[UOAP, ID]",
|
|
user: UOAP,
|
|
oauth_account: OAP,
|
|
update_dict: dict[str, Any],
|
|
) -> UOAP:
|
|
"""Update an OAuth account on a user."""
|
|
raise NotImplementedError()
|
|
|
|
|
|
UserDatabaseDependency = DependencyCallable[BaseUserDatabase[UP, ID]]
|