paperap.const module


METADATA:

File: const.py

Project: paperap

Created: 2025-03-04

Version: 0.0.8

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann


LAST MODIFIED:

2025-03-04 By Jess Mann

class paperap.const.ConstModel(**data)[source]

Bases: BaseModel

Parameters:

data (Any)

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.URLS[source]

Bases: object

index: Template = <string.Template object>
token: Template = <string.Template object>
list: Template = <string.Template object>
detail: Template = <string.Template object>
create: Template = <string.Template object>
update: Template = <string.Template object>
delete: Template = <string.Template object>
meta: Template = <string.Template object>
next_asn: Template = <string.Template object>
notes: Template = <string.Template object>
post: Template = <string.Template object>
single: Template = <string.Template object>
suggestions: Template = <string.Template object>
preview: Template = <string.Template object>
thumbnail: Template = <string.Template object>
download: Template = <string.Template object>
class paperap.const.FilteringStrategies(*values)[source]

Bases: StrEnum

WHITELIST = 'whitelist'
BLACKLIST = 'blacklist'
ALLOW_ALL = 'allow_all'
ALLOW_NONE = 'allow_none'
class paperap.const.ModelStatus(*values)[source]

Bases: StrEnum

INITIALIZING = 'initializing'
UPDATING = 'updating'
SAVING = 'saving'
READY = 'ready'
ERROR = 'error'
class paperap.const.CustomFieldTypes(*values)[source]

Bases: StrEnum

STRING = 'string'
BOOLEAN = 'boolean'
INTEGER = 'integer'
FLOAT = 'float'
MONETARY = 'monetary'
DATE = 'date'
URL = 'url'
UNKNOWN = 'unknown'
class paperap.const.CustomFieldValues(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

field: int
value: Any
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.CustomFieldTypedDict[source]

Bases: TypedDict

field: int
value: Any
class paperap.const.DocumentMetadataType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

namespace: str | None
prefix: str | None
key: str | None
value: str | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.DocumentSearchHitType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

score: float | None
highlights: str | None
note_highlights: str | None
rank: int | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.MatchingAlgorithmType(*values)[source]

Bases: IntEnum

NONE = 0
ANY = 1
ALL = 2
LITERAL = 3
REGEX = 4
FUZZY = 5
AUTO = 6
UNKNOWN = -1
class paperap.const.PermissionSetType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

users: list[int]
groups: list[int]
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.PermissionTableType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

view: PermissionSetType
change: PermissionSetType
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.RetrieveFileMode(*values)[source]

Bases: StrEnum

DOWNLOAD = 'download'
PREVIEW = 'preview'
THUMBNAIL = 'thumb'
class paperap.const.SavedViewFilterRuleType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

rule_type: int | None
value: str | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.ShareLinkFileVersionType(*values)[source]

Bases: StrEnum

ARCHIVE = 'archive'
ORIGINAL = 'original'
UNKNOWN = 'unknown'
class paperap.const.StatusType(*values)[source]

Bases: StrEnum

OK = 'OK'
ERROR = 'ERROR'
UNKNOWN = 'UNKNOWN'
class paperap.const.StatusDatabaseMigrationStatusType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

latest_migration: str | None
unapplied_migrations: list[str]
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.StatusDatabaseType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

type: str | None
url: str | None
status: StatusType | None
error: str | None
migration_status: StatusDatabaseMigrationStatusType | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.StatusStorageType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

total: int | None
available: int | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.StatusTasksType(**data)[source]

Bases: ConstModel

Parameters:

data (Any)

redis_url: str | None
redis_status: StatusType | None
redis_error: str | None
celery_status: StatusType | None
index_status: StatusType | None
index_last_modified: datetime | None
index_error: str | None
classifier_status: StatusType | None
classifier_last_trained: datetime | None
classifier_error: str | None
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'from_attributes': 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].

class paperap.const.TaskStatusType(*values)[source]

Bases: StrEnum

PENDING = 'PENDING'
STARTED = 'STARTED'
SUCCESS = 'SUCCESS'
FAILURE = 'FAILURE'
UNKNOWN = 'UNKNOWN'
class paperap.const.WorkflowActionType(*values)[source]

Bases: IntEnum

ASSIGNMENT = 1
UNKNOWN = -1
class paperap.const.WorkflowTriggerType(*values)[source]

Bases: IntEnum

CONSUMPTION = 1
DOCUMENT_ADDED = 2
DOCUMENT_UPDATED = 3
UNKNOWN = -1
class paperap.const.WorkflowTriggerSourceType(*values)[source]

Bases: IntEnum

CONSUME_FOLDER = 1
API_UPLOAD = 2
MAIL_FETCH = 3
UNKNOWN = -1