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

Bases: StandardQuerySet[Task]

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)

task_id(value)[source]

Filter tasks by task_id.

Parameters:

value (int) – The task_id to filter by

Returns:

The filtered queryset

Return type:

TaskQuerySet

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

Filter tasks by task_file_name.

Parameters:

  • value (str) – The task_file_name to filter by

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

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

Returns:

The filtered queryset

Return type:

TaskQuerySet

date_done(value)[source]

Filter tasks by date_done.

Parameters:

value (str | None) – The date_done to filter by

Returns:

The filtered queryset

Return type:

TaskQuerySet

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

Filter tasks by type.

Parameters:

  • value (str) – The type to filter by

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

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

Returns:

The filtered queryset

Return type:

TaskQuerySet

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

Filter tasks by status.

Parameters:

  • value (str) – The status to filter by

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

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

Returns:

The filtered queryset

Return type:

TaskQuerySet

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

Filter tasks by result.

Parameters:

  • value (str | None) – The result to filter by

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

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

Returns:

The filtered queryset

Return type:

TaskQuerySet

acknowledged(value)[source]

Filter tasks by acknowledged.

Parameters:

value (bool) – The acknowledged to filter by

Returns:

The filtered queryset

Return type:

TaskQuerySet

related_document(value)[source]

Filter tasks by related_document.

Parameters:

value (int | list[int]) – The related_document to filter by

Returns:

The filtered queryset

Return type:

TaskQuerySet