paperap.models.storage_path.queryset module

METADATA:

File: queryset.py

Project: paperap

Created: 2025-03-04

Version: 0.0.8

Author: Jess Mann Email: jess@jmann.me

Copyright (c) 2025 Jess Mann

LAST MODIFIED:

2025-03-04 By Jess Mann

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

Bases: StandardQuerySet[StoragePath], HasStandard

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

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

Filter storage paths by their actual path value.

Parameters:

  • value (str) – The path to filter by

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

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

Return type:

Self

Returns:

Filtered StoragePathQuerySet

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

Filter storage paths by match value.

Parameters:

  • value (str) – The match value to filter by

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

Return type:

Self

Returns:

Filtered StoragePathQuerySet

matching_algorithm(value)[source]

Filter storage paths by matching algorithm.

Parameters:

value (int) – The matching algorithm to filter by

Return type:

Self

Returns:

Filtered StoragePathQuerySet

case_insensitive(insensitive=True)[source]

Filter storage paths by case sensitivity setting.

Parameters:

insensitive (bool) – If True, get storage paths with case insensitive matching

Return type:

Self

Returns:

Filtered StoragePathQuerySet

user_can_change(can_change=True)[source]

Filter storage paths by user change permission.

Parameters:

can_change (bool) – If True, get storage paths that can be changed by user

Return type:

Self

Returns:

Filtered StoragePathQuerySet