paperap.models.tag.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.tag.queryset.TagQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]

Bases: StandardQuerySet[Tag], HasStandard

QuerySet for Paperless-ngx tags 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)

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

Filter tags by color.

Parameters:

  • value (str | int) – The color to filter by (string or integer)

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

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

Return type:

Self

Returns:

Filtered TagQuerySet

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

Filter tags by match value.

Parameters:

  • value (str) – The value to filter by

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

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

Return type:

Self

Returns:

Filtered TagQuerySet

matching_algorithm(value)[source]

Filter tags by matching algorithm.

Parameters:

value (int) – The matching algorithm to filter by

Return type:

Self

Returns:

Filtered TagQuerySet

case_insensitive(value=True)[source]

Filter tags by case insensitivity.

Parameters:

value (bool) – If True, filter tags that are case insensitive

Return type:

Self

Returns:

Filtered TagQuerySet

is_inbox_tag(value=True)[source]

Filter tags by inbox status.

Parameters:

value (bool) – If True, get inbox tags, otherwise non-inbox tags

Return type:

Self

Returns:

Filtered TagQuerySet

user_can_change(value=True)[source]

Filter tags by user change permission.

Parameters:

value (bool) – If True, get tags that can be changed by user

Return type:

Self

Returns:

Filtered TagQuerySet