paperap.models.saved_view.queryset module

METADATA:

File: queryset.py
Project: paperap

Created: 2025-03-04
Version: 0.0.5

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann

LAST MODIFIED:

2025-03-04 By Jess Mann

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

Bases: StandardQuerySet[SavedView], HasOwner

QuerySet for Paperless-ngx saved views 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 saved views by name.

Parameters:

name – The saved view name to filter by
exact (bool) – If True, match the exact name, otherwise use contains
value (str)
case_insensitive (bool)

Return type:

Self

Returns:

Filtered SavedViewQuerySet

show_in_sidebar(show=True)[source]

Filter saved views by sidebar visibility.

Parameters:: show (bool) – If True, get views shown in sidebar, otherwise those hidden
Return type:: Self
Returns:: Filtered SavedViewQuerySet

show_on_dashboard(show=True)[source]

Filter saved views by dashboard visibility.

Parameters:: show (bool) – If True, get views shown on dashboard, otherwise those hidden
Return type:: Self
Returns:: Filtered SavedViewQuerySet

sort_field(field, *, exact=True, case_insensitive=True)[source]

Filter saved views by sort field.

Parameters:

field (str) – The field to sort by
exact (bool) – If True, match the exact field, otherwise use contains
case_insensitive (bool)

Return type:

Self

Returns:

Filtered SavedViewQuerySet

sort_reverse(reverse=True)[source]

Filter saved views by sort direction.

Parameters:: reverse (bool) – If True, get views sorted in reverse order
Return type:: Self
Returns:: Filtered SavedViewQuerySet

page_size(size)[source]

Filter saved views by page size.

Parameters:: size (int) – The number of items per page
Return type:: Self
Returns:: Filtered SavedViewQuerySet

page_size_under(size)[source]

Filter saved views by page size under a limit.

Parameters:: size (int) – The maximum number of items per page
Return type:: Self
Returns:: Filtered SavedViewQuerySet

page_size_over(size)[source]

Filter saved views by page size over a limit.

Parameters:: size (int) – The minimum number of items per page
Return type:: Self
Returns:: Filtered SavedViewQuerySet

page_size_between(min_size, max_size)[source]

Filter saved views by page size within a range.

Parameters:

min_size (int) – The minimum number of items per page
max_size (int) – The maximum number of items per page

Return type:

Self

Returns:

Filtered SavedViewQuerySet

display_mode(mode)[source]

Filter saved views by display mode.

Parameters:: mode (str) – The display mode to filter by
Return type:: Self
Returns:: Filtered SavedViewQuerySet

user_can_change(can_change=True)[source]

Filter saved views by user change permissions.

Parameters:: can_change (bool) – If True, get views that can be changed by the user
Return type:: Self
Returns:: Filtered SavedViewQuerySet