models.py

"""Data models used by FolderVisualizer's folder scanner."""

from __future__ import annotations

from dataclasses import dataclass, field
from typing import Any


@dataclass
class FileNode:
    """A file or directory in the scanned tree."""

    name: str
    path: str
    is_directory: bool
    size: int = 0
    children: list["FileNode"] = field(default_factory=list)
    error: str | None = None

    def to_dict(self) -> dict[str, Any]:
        """Return a JSON-serializable representation of this node."""

        data: dict[str, Any] = {
            "name": self.name,
            "path": self.path,
            "type": "directory" if self.is_directory else "file",
            "size": self.size,
            "children": [child.to_dict() for child in self.children],
        }
        if self.error is not None:
            data["error"] = self.error
        return data


@dataclass
class ScanResult:
    """The tree and summary produced by one folder scan."""

    root: FileNode
    total_size: int
    file_count: int
    directory_count: int
    errors: list[str] = field(default_factory=list)

    def to_dict(self) -> dict[str, Any]:
        """Return a JSON-serializable representation of the scan result."""

        return {
            "root": self.root.to_dict(),
            "total_size": self.total_size,
            "file_count": self.file_count,
            "directory_count": self.directory_count,
            "errors": list(self.errors),
        }