paperap.models.ui_settings.queryset module


METADATA:

File: queryset.py

Project: paperap

Created: 2025-03-21

Version: 0.0.9

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann


LAST MODIFIED:

2025-03-21 By Jess Mann

class paperap.models.ui_settings.queryset.UISettingsQuerySet(resource, filters=None, _cache=None, _fetch_all=False, _next_url=None, _last_response=None, _iter=None, _urls_fetched=None)[source]

Bases: StandardQuerySet[UISettings]

A lazy-loaded, chainable query interface for Paperless NGX resources.

BaseQuerySet provides pagination, filtering, and caching functionality similar to Django’s BaseQuerySet. It’s designed to be lazy - only fetching data when it’s actually needed.

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)

count()[source]

Count the number of UI settings.

UISettings only ever returns one element.

Returns:

The number of UI settings

Return type:

int

has_permission(value)[source]

Filter UI settings by permissions.

Parameters:

value (str) – The permissions to filter by

Returns:

The filtered queryset

Return type:

UISettingsQuerySet