Перейти к содержанию

Модели данных

Pydantic-модели для работы с данными.

FileStatus

FileStatus

Bases: BaseModel

Статус файла при синхронизации.

Source code in src/sandboxer/wiki_sync/core/models.py 
75
76
77
78
79
80
81
82
83
class FileStatus(BaseModel):
    """Статус файла при синхронизации."""

    slug: str
    file_path: Path
    status: SyncStatus
    title: str = ""
    wiki_modified: datetime | None = None
    error_message: str | None = None

SyncResult

SyncResult

Bases: BaseModel

Результат синхронизации.

Source code in src/sandboxer/wiki_sync/core/models.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class SyncResult(BaseModel):
    """Результат синхронизации."""

    synced: list[FileStatus] = Field(default_factory=list)
    modified: list[FileStatus] = Field(default_factory=list)
    new: list[FileStatus] = Field(default_factory=list)
    conflict: list[FileStatus] = Field(default_factory=list)
    remote_modified: list[FileStatus] = Field(default_factory=list)
    deleted_local: list[FileStatus] = Field(default_factory=list)
    errors: list[FileStatus] = Field(default_factory=list)

    @property
    def total_files(self) -> int:
        """Общее количество файлов."""
        return len(self.synced) + len(self.modified) + len(self.new) + len(self.conflict) + len(self.remote_modified)

    @property
    def has_changes(self) -> bool:
        """Есть ли изменения для синхронизации."""
        return bool(self.modified or self.new or self.conflict or self.remote_modified or self.deleted_local)

    @property
    def has_conflicts(self) -> bool:
        """Есть ли конфликты."""
        return bool(self.conflict)

    @property
    def uploadable_files(self) -> list[FileStatus]:
        """Файлы, которые можно загрузить в Wiki."""
        return self.modified + self.new

total_files property 

total_files

Общее количество файлов.

has_changes property 

has_changes

Есть ли изменения для синхронизации.

has_conflicts property 

has_conflicts

Есть ли конфликты.

uploadable_files property 

uploadable_files

Файлы, которые можно загрузить в Wiki.

PageInfo

PageInfo

Bases: BaseModel

Информация о странице Wiki.

Source code in src/sandboxer/wiki_sync/core/models.py 
22
23
24
25
26
27
28
class PageInfo(BaseModel):
    """Информация о странице Wiki."""

    id: int
    slug: str
    title: str
    page_type: str = "wysiwyg"

PageContent

PageContent

Bases: BaseModel

Контент страницы Wiki.

Source code in src/sandboxer/wiki_sync/core/models.py 
31
32
33
34
35
36
37
38
class PageContent(BaseModel):
    """Контент страницы Wiki."""

    id: int
    slug: str
    title: str
    content: str = ""
    modified_at: datetime | None = None

PageMeta

PageMeta

Bases: BaseModel

Метаданные страницы для локального хранения.

Source code in src/sandboxer/wiki_sync/core/models.py 
41
42
43
44
45
46
47
48
49
50
class PageMeta(BaseModel):
    """Метаданные страницы для локального хранения."""

    id: int
    slug: str
    title: str
    file: str  # Относительный путь к файлу
    content_hash: str
    last_push: datetime | None = None
    last_pull: datetime | None = None

MetaStorage

MetaStorage

Bases: BaseModel

Хранилище метаданных (.wiki-meta.json).

Source code in src/sandboxer/wiki_sync/core/models.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class MetaStorage(BaseModel):
    """Хранилище метаданных (.wiki-meta.json)."""

    version: int = 1
    pages: dict[str, PageMeta] = Field(default_factory=dict)

    def get_page(self, slug: str) -> PageMeta | None:
        """Получить метаданные страницы по slug."""
        return self.pages.get(slug)

    def set_page(self, slug: str, meta: PageMeta) -> None:
        """Установить метаданные страницы."""
        self.pages[slug] = meta

    def remove_page(self, slug: str) -> bool:
        """Удалить метаданные страницы."""
        if slug in self.pages:
            del self.pages[slug]
            return True
        return False

get_page 

get_page(slug)

Получить метаданные страницы по slug.

Source code in src/sandboxer/wiki_sync/core/models.py 
59
60
61
def get_page(self, slug: str) -> PageMeta | None:
    """Получить метаданные страницы по slug."""
    return self.pages.get(slug)

set_page 

set_page(slug, meta)

Установить метаданные страницы.

Source code in src/sandboxer/wiki_sync/core/models.py 
63
64
65
def set_page(self, slug: str, meta: PageMeta) -> None:
    """Установить метаданные страницы."""
    self.pages[slug] = meta

remove_page 

remove_page(slug)

Удалить метаданные страницы.

Source code in src/sandboxer/wiki_sync/core/models.py 
67
68
69
70
71
72
def remove_page(self, slug: str) -> bool:
    """Удалить метаданные страницы."""
    if slug in self.pages:
        del self.pages[slug]
        return True
    return False