Coverage for src/paperap/models/storage_path/model.py: 95%

1""" 

2---------------------------------------------------------------------------- 

3 

4 METADATA: 

5 

6 File: storage_path.py 

7 Project: paperap 

8 Created: 2025-03-04 

9 Version: 0.0.7 

10 Author: Jess Mann 

11 Email: jess@jmann.me 

12 Copyright (c) 2025 Jess Mann 

13 

14---------------------------------------------------------------------------- 

15 

16 LAST MODIFIED: 

17 

18 2025-03-04 By Jess Mann 

19 

20""" 

21 

22from __future__ import annotations 

23 

24from datetime import datetime 

25from typing import TYPE_CHECKING, Any 

26 

27from paperap.const import MatchingAlgorithmType 

28from paperap.models.abstract.model import StandardModel 

29from paperap.models.mixins.models import MatcherMixin 

30from paperap.models.storage_path.queryset import StoragePathQuerySet 

31 

32if TYPE_CHECKING: 

33 from paperap.models.document import Document, DocumentQuerySet 

34 

35 

36class StoragePath(StandardModel, MatcherMixin): 

37 """ 

38 Represents a storage path in Paperless-NgX. 

39 """ 

40 

41 name: str 

42 slug: str | None = None 

43 path: str | None = None 

44 document_count: int = 0 

45 owner: int | None = None 

46 user_can_change: bool | None = None 

47 

48 class Meta(StandardModel.Meta): 

49 # Fields that should not be modified 

50 read_only_fields = {"slug", "document_count"} 

51 queryset = StoragePathQuerySet 

52 

53 @property 

54 def documents(self) -> "DocumentQuerySet": 

55 """ 

56 Get documents in this storage path. 

57 """ 

58 return self._client.documents().all().storage_path_id(self.id)