user_login_manager.dal

Data acess layer (DAL) between fastapi endpoint and sql database for user data.

Functions

get_user_data(→ app.db.UserSQL | None)	Get user by username.
update_user_data(→ app.db.UserSQL | None)	Update existing user entry.
get_user_from_token(→ app.db.UserSQL | None)	Get user from token.
get_all_users(→ list[app.db.UserSQL])	Get a list of all existing users.
add_user(user)	Create a new user entry in database.
delete_user_data(→ bool)	Delete user by username.

Module Contents

async user_login_manager.dal.get_user_data(username: str) → app.db.UserSQL | None

Get user by username.

Parameters:

username – Username as entered by the user. Primary key in db.

Return type:

Database orm model of User or none

async user_login_manager.dal.update_user_data(username: str, data: dict) → app.db.UserSQL | None

Update existing user entry.

Parameters:

• username – Primary key of the entry in db to be updated.

• data – Data to be written. Does not need to contain all columns.

Return type:

Database orm model of updated user

async user_login_manager.dal.get_user_from_token(access_token: str) → app.db.UserSQL | None

Get user from token.

Parameters:

token – Token. Unique in database.

Return type:

The user as read from database or None if the token is not found.

async user_login_manager.dal.get_all_users() → list[app.db.UserSQL]

Get a list of all existing users.

Return type:

List of database orm models

async user_login_manager.dal.add_user(user: app.db.UserSQL)

Create a new user entry in database.

Parameters:

user – UserSQL ORM model.

Return type:

User database entry

async user_login_manager.dal.delete_user_data(username: str) → bool

Delete user by username.

Parameters:

username – Username of the user to be deleted

Return type:

Success of deletion