paperap.models.custom_field.queryset module

METADATA:

File: queryset.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.custom_field.queryset.CustomFieldQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]

Bases: StandardQuerySet[CustomField], HasDocumentCount

QuerySet for Paperless-ngx custom fields with specialized filtering methods.

Parameters:

  • resource (BaseResource[_Model, Self])

  • filters (dict[str, Any] | None)

  • _cache (list[_Model] | None)

  • _fetch_all (bool)

  • _next_url (str | None)

  • _last_response (ClientResponse)

  • _iter (Iterator[_Model] | None)

  • _urls_fetched (list[str] | None)

name(value, *, exact=True, case_insensitive=True)[source]

Filter custom fields by name.

Parameters:

  • value (str) – The custom field name to filter by

  • exact (bool) – If True, match the exact name, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered CustomFieldQuerySet

data_type(value, *, exact=True, case_insensitive=True)[source]

Filter custom fields by data type.

Parameters:

  • value (str) – The data type to filter by (e.g., “string”, “integer”, “boolean”, “date”)

  • exact (bool) – If True, match the exact data type, otherwise use contains

  • case_insensitive (bool) – If True, ignore case when matching

Return type:

Self

Returns:

Filtered CustomFieldQuerySet

extra_data(key, value)[source]

Filter custom fields by a key-value pair in extra_data.

Parameters:

  • key (str) – The key in extra_data to filter by

  • value (Any) – The value to filter by

Return type:

Self

Returns:

Filtered CustomFieldQuerySet