rwx/rwx/fs/__init__.py

"""Operations involving FileSystems."""

import os
import shutil
from pathlib import Path

from rwx import ps

CHARSET = "UTF-8"


def create_image(file_path: str, size_bytes: int) -> None:
    """Create a virtual device image file."""
    ps.run(
        ("qemu-img", "create"),
        ("-f", "qcow2"),
        (file_path, size_bytes),
    )


def empty_file(path: str) -> None:
    """Empty the file at provided path."""
    write(path, "")


def get_mount_uuid(path: str) -> str:
    """Return the filesystem UUID of a mountpoint path."""
    return ps.run_line(
        ("findmnt",),
        ("--noheadings",),
        ("--output", "UUID"),
        (path,),
    )


def get_path_mount(path: str) -> str:
    """Return the mountpoint path of an arbitrary path."""
    return ps.run_line(
        ("stat",),
        ("--format", "%m"),
        (path,),
    )


def get_path_uuid(path: str) -> str:
    """Return the filesystem UUID of an arbitrary path."""
    return get_mount_uuid(get_path_mount(path))


def make_directory(path: str) -> None:
    """Make a directory (and its parents) from a path."""
    Path(path).mkdir(exist_ok=True, parents=True)


def read_file_bytes(file_path: str) -> bytes:
    """Read whole file bytes."""
    with Path(file_path).open("br") as file_object:
        return file_object.read()


def read_file_lines(file_path: str, charset: str = CHARSET):
    return read_file_text(file_path).split(os.linesep)


def read_file_text(file_path: str, charset: str = CHARSET):
    return read_file_bytes(file_path).decode(charset)


def wipe(path: str) -> None:
    """Wipe provided path, whether directory or file."""
    try:
        shutil.rmtree(path)
    except NotADirectoryError:
        Path(path).unlink(missing_ok=True)
    except FileNotFoundError:
        pass


def write(file_path: str, text: str, charset: str = CHARSET) -> None:
    """Write text into a file."""
    with Path(file_path).open(encoding=charset, mode="w") as file_object:
        file_object.write(text)