paperap.models.user.model module
METADATA:
- File: user.py
Project: paperap
- Created: 2025-03-04
Version: 0.0.9
Author: Jess Mann Email: jess@jmann.me
Copyright (c) 2025 Jess Mann
LAST MODIFIED:
2025-03-04 By Jess Mann
- class paperap.models.user.model.Group(**data)[source]
Bases:
StandardModelRepresents a user group in Paperless-NgX.
- Parameters:
data (
Any)
- name: str | None
- permissions: list[str]
- class Meta(model)[source]
Bases:
Meta- Parameters:
model (type[_Self])
- queryset
alias of
GroupQuerySet
- blacklist_filtering_params: ClassVar[set[str]] = {}
- field_map: dict[str, str] = {}
- filtering_disabled: ClassVar[set[str]] = {}
- filtering_fields: ClassVar[set[str]] = {'_resource', 'id', 'name', 'permissions'}
- read_only_fields: ClassVar[set[str]] = {'id'}
- supported_filtering_params: ClassVar[set[str]] = {'id', 'id__in', 'limit'}
- model: type[_Self]
- name: str
- property users: UserQuerySet
Get the users in this group.
- Returns:
The users in this group
- Return type:
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'ignore', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- id: int
- class paperap.models.user.model.User(**data)[source]
Bases:
StandardModelRepresents a user in Paperless-NgX.
- Parameters:
data (
Any)
- username: str | None
- email: str | None
- password: str | None
- first_name: str | None
- last_name: str | None
- date_joined: str | None
- is_staff: bool | None
- is_active: bool | None
- is_superuser: bool | None
- groups: list[int]
- user_permissions: list[str]
- inherited_permissions: list[str]
- class Meta(model)[source]
Bases:
Meta- Parameters:
model (type[_Self])
- queryset
alias of
UserQuerySet
- blacklist_filtering_params: ClassVar[set[str]] = {}
- field_map: dict[str, str] = {}
- filtering_disabled: ClassVar[set[str]] = {}
- filtering_fields: ClassVar[set[str]] = {'_resource', 'date_joined', 'email', 'first_name', 'groups', 'id', 'inherited_permissions', 'is_active', 'is_staff', 'is_superuser', 'last_name', 'password', 'user_permissions', 'username'}
- read_only_fields: ClassVar[set[str]] = {'id'}
- supported_filtering_params: ClassVar[set[str]] = {'id', 'id__in', 'limit'}
- model: type[_Self]
- name: str
- get_groups()[source]
Get the groups this user is a member of.
- Returns:
The groups this user is a member
- Return type:
- model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'extra': 'ignore', 'populate_by_name': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_default': True}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_post_init(context: Any, /) None
We need to both initialize private attributes and call the user-defined model_post_init method.
- id: int