clan-core/pkgs/clan-cli/clan_cli/api/directory.py

import json
import os
from dataclasses import dataclass, field
from pathlib import Path
from typing import Any, Literal

from clan_cli.errors import ClanError
from clan_cli.nix import nix_shell, run_no_stdout

from . import API


@dataclass
class FileFilter:
    title: str | None
    mime_types: list[str] | None
    patterns: list[str] | None
    suffixes: list[str] | None


@dataclass
class FileRequest:
    # Mode of the os dialog window
    mode: Literal["open_file", "select_folder", "save"]
    # Title of the os dialog window
    title: str | None = None
    # Pre-applied filters for the file dialog
    filters: FileFilter | None = None


@API.register
def open_file(file_request: FileRequest) -> str | None:
    """
    Abstract api method to open a file dialog window.
    It must return the name of the selected file or None if no file was selected.
    """
    raise NotImplementedError("Each specific platform should implement this function.")


@dataclass
class File:
    path: str
    file_type: Literal["file", "directory", "symlink"]


@dataclass
class Directory:
    path: str
    files: list[File] = field(default_factory=list)


@API.register
def get_directory(current_path: str) -> Directory:
    curr_dir = Path(current_path)
    directory = Directory(path=str(curr_dir))

    if not curr_dir.is_dir():
        raise ClanError()

    with os.scandir(curr_dir.resolve()) as it:
        for entry in it:
            if entry.is_symlink():
                directory.files.append(
                    File(
                        path=str(curr_dir / Path(entry.name)),
                        file_type="symlink",
                    )
                )
            elif entry.is_file():
                directory.files.append(
                    File(
                        path=str(curr_dir / Path(entry.name)),
                        file_type="file",
                    )
                )

            elif entry.is_dir():
                directory.files.append(
                    File(
                        path=str(curr_dir / Path(entry.name)),
                        file_type="directory",
                    )
                )

    return directory


@dataclass
class BlkInfo:
    name: str
    rm: str
    size: str
    ro: bool
    mountpoints: list[str]
    type_: Literal["disk"]


@dataclass
class Blockdevices:
    blockdevices: list[BlkInfo]


def blk_from_dict(data: dict) -> BlkInfo:
    return BlkInfo(
        name=data["name"],
        rm=data["rm"],
        size=data["size"],
        ro=data["ro"],
        mountpoints=data["mountpoints"],
        type_=data["type"],  # renamed here
    )


@API.register
def show_block_devices() -> Blockdevices:
    """
    Abstract api method to show block devices.
    It must return a list of block devices.
    """
    cmd = nix_shell(["nixpkgs#util-linux"], ["lsblk", "--json"])
    proc = run_no_stdout(cmd)
    res = proc.stdout.strip()

    blk_info: dict[str, Any] = json.loads(res)

    return Blockdevices(
        blockdevices=[blk_from_dict(device) for device in blk_info["blockdevices"]]
    )