models

User

class msdss_users_api.models.User(*, id: pydantic.types.UUID4 = None, email: pydantic.networks.EmailStr, is_active: bool = True, is_superuser: bool = False, is_verified: bool = False)

See User model from fastapi-users.

Example

from msdss_users_api.models import *
from pprint import pprint

fields = User.__fields__
pprint(fields)

{'email': ModelField(name='email', type=EmailStr, required=True),
 'id': ModelField(name='id', type=UUID4, required=False, default_factory='<function uuid4>'),
 'is_active': ModelField(name='is_active', type=bool, required=False, default=True),
 'is_superuser': ModelField(name='is_superuser', type=bool, required=False, default=False),
 'is_verified': ModelField(name='is_verified', type=bool, required=False, default=False)}

UserCreate

class msdss_users_api.models.UserCreate(*, email: pydantic.networks.EmailStr, password: str, is_active: bool = True, is_superuser: bool = False, is_verified: bool = False)

See UserCreate model from fastapi-users.

Example

from msdss_users_api.models import *
from pprint import pprint

fields = UserCreate.__fields__
pprint(fields)

{'email': ModelField(name='email', type=EmailStr, required=True),
 'is_active': ModelField(name='is_active', type=Optional[bool], required=False, default=True),
 'is_superuser': ModelField(name='is_superuser', type=Optional[bool], required=False, default=False),
 'is_verified': ModelField(name='is_verified', type=Optional[bool], required=False, default=False),
 'password': ModelField(name='password', type=str, required=True)}

UserUpdate

class msdss_users_api.models.UserUpdate(*, password: str = None, email: pydantic.networks.EmailStr = None, is_active: bool = None, is_superuser: bool = None, is_verified: bool = None)

See UserUpdate model from fastapi-users.

Example

from msdss_users_api.models import *
from pprint import pprint

fields = UserUpdate.__fields__
pprint(fields)

{'email': ModelField(name='email', type=Optional[EmailStr], required=False, default=None),
 'is_active': ModelField(name='is_active', type=Optional[bool], required=False, default=None),
 'is_superuser': ModelField(name='is_superuser', type=Optional[bool], required=False, default=None),
 'is_verified': ModelField(name='is_verified', type=Optional[bool], required=False, default=None),
 'password': ModelField(name='password', type=Optional[str], required=False, default=None)}

UserDB

class msdss_users_api.models.UserDB(*, id: pydantic.types.UUID4 = None, email: pydantic.networks.EmailStr, is_active: bool = True, is_superuser: bool = False, is_verified: bool = False, hashed_password: str)

See UserDB model from fastapi-users.

Example

from msdss_users_api.models import *
from pprint import pprint

fields = UserDB.__fields__
pprint(fields)

{'email': ModelField(name='email', type=EmailStr, required=True),
 'hashed_password': ModelField(name='hashed_password', type=str, required=True),
 'id': ModelField(name='id', type=UUID4, required=False, default_factory='<function uuid4>'),
 'is_active': ModelField(name='is_active', type=bool, required=False, default=True),
 'is_superuser': ModelField(name='is_superuser', type=bool, required=False, default=False),
 'is_verified': ModelField(name='is_verified', type=bool, required=False, default=False)}

UserTable

class msdss_users_api.models.UserTable(**kwargs)

See UserTable model from fastapi-users.

Example

from msdss_users_api.models import *

table = UserTable.__table__
columns = table.c

for c in columns:
    print(c)

user.id
user.email
user.hashed_password
user.is_active
user.is_superuser
user.is_verified

UserManager

class msdss_users_api.managers.UserManager(user_db: fastapi_users.db.base.BaseUserDatabase[fastapi_users.models.UD])

See UserManager model from fastapi-users.

Example

from msdss_users_api.managers import *
from pprint import pprint

pprint(dir(UserManager))

['__annotations__',
 '__class__',
 '__class_getitem__',
 '__delattr__',
 '__dict__',
 '__dir__',
 '__doc__',
 '__eq__',
 '__format__',
 '__ge__',
 '__getattribute__',
 '__gt__',
 '__hash__',
 '__init__',
 '__init_subclass__',
 '__le__',
 '__lt__',
 '__module__',
 '__ne__',
 '__new__',
 '__orig_bases__',
 '__parameters__',
 '__reduce__',
 '__reduce_ex__',
 '__repr__',
 '__setattr__',
 '__sizeof__',
 '__slots__',
 '__str__',
 '__subclasshook__',
 '__weakref__',
 '_is_protocol',
 '_update',
 'authenticate',
 'create',
 'delete',
 'forgot_password',
 'get',
 'get_by_email',
 'get_by_oauth_account',
 'oauth_callback',
 'on_after_forgot_password',
 'on_after_register',
 'on_after_request_verify',
 'on_after_reset_password',
 'on_after_update',
 'on_after_verify',
 'request_verify',
 'reset_password',
 'reset_password_token_audience',
 'reset_password_token_lifetime_seconds',
 'update',
 'user_db_model',
 'validate_password',
 'verification_token_audience',
 'verification_token_lifetime_seconds',
 'verify']