Coverage for src/paperap/models/tag/model.py: 100%

21 statements  

« prev     ^ index     » next       coverage.py v7.6.12, created at 2025-03-20 13:17 -0400

1""" 

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

3 

4 METADATA: 

5 

6 File: tag.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, Optional 

26 

27from pydantic import Field, field_validator 

28 

29from paperap.models.abstract.model import StandardModel 

30from paperap.models.mixins.models import MatcherMixin 

31from paperap.models.tag.queryset import TagQuerySet 

32 

33if TYPE_CHECKING: 

34 from paperap.models.document import Document, DocumentQuerySet 

35 

36 

37class Tag(StandardModel, MatcherMixin): 

38 """ 

39 Represents a tag in Paperless-NgX. 

40 """ 

41 

42 name: str | None = None 

43 slug: str | None = None 

44 colour: str | int | None = Field(alias="color", default=None) 

45 is_inbox_tag: bool | None = None 

46 document_count: int = 0 

47 owner: int | None = None 

48 user_can_change: bool | None = None 

49 

50 class Meta(StandardModel.Meta): 

51 # Fields that should not be modified 

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

53 queryset = TagQuerySet 

54 

55 @property 

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

57 """ 

58 Get documents with this tag. 

59 

60 Returns: 

61 List of documents. 

62 

63 """ 

64 return self._client.documents().all().tag_id(self.id)