paperap.models.document.metadata.model module
METADATA:
- File: metadata.py
Project: paperap
- Created: 2025-03-18
Version: 0.0.9
Author: Jess Mann Email: jess@jmann.me
Copyright (c) 2025 Jess Mann
LAST MODIFIED:
2025-03-18 By Jess Mann
- class paperap.models.document.metadata.model.MetadataElement(**data)[source]
Bases:
BaseModelRepresents metadata for a document in Paperless-NgX.
This is a key-value pair of metadata information.
- Parameters:
data (
Any)
- key: str
- value: str
- model_config: ClassVar[ConfigDict] = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class paperap.models.document.metadata.model.DocumentMetadata(**data)[source]
Bases:
StandardModelRepresents a Paperless-NgX document’s metadata.
- original_checksum
The checksum of the original document.
- original_size
The size of the original document in bytes.
- original_mime_type
The MIME type of the original document.
- media_filename
The filename of the media file.
- has_archive_version
Whether the document has an archive version.
- original_metadata
Metadata of the original document.
- archive_checksum
The checksum of the archived document.
- archive_media_filename
The filename of the archived media file.
- original_filename
The original filename of the document.
- lang
The language of the document.
- archive_size
The size of the archived document in bytes.
- archive_metadata
Metadata of the archived document.
- Parameters:
data (
Any)
- original_checksum: str | None
- original_size: int | None
- original_mime_type: str | None
- media_filename: str | None
- has_archive_version: bool | None
- original_metadata: list[MetadataElement]
- archive_checksum: str | None
- archive_media_filename: str | None
- original_filename: str | None
- lang: str | None
- archive_size: int | None
- archive_metadata: list[MetadataElement]
- class Meta(model)[source]
Bases:
Meta- Parameters:
model (type[_Self])
- read_only_fields: ClassVar[set[str]] = {'archive_checksum', 'archive_media_filename', 'archive_metadata', 'archive_size', 'has_archive_version', 'id', 'lang', 'media_filename', 'original_checksum', 'original_filename', 'original_metadata', 'original_mime_type', 'original_size'}
- blacklist_filtering_params: ClassVar[set[str]] = {}
- field_map: dict[str, str] = {}
- filtering_disabled: ClassVar[set[str]] = {}
- filtering_fields: ClassVar[set[str]] = {'_resource', 'archive_checksum', 'archive_media_filename', 'archive_metadata', 'archive_size', 'has_archive_version', 'id', 'lang', 'media_filename', 'original_checksum', 'original_filename', 'original_metadata', 'original_mime_type', 'original_size'}
- supported_filtering_params: ClassVar[set[str]] = {'id', 'id__in', 'limit'}
- model: type[_Self]
- name: str
- 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