kaparoo-python 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

kaparoo/filesystem/__init__.py

@@ -1,12 +1,18 @@
 __all__ = (
     "DirectoryNotFoundError",
     "NotAFileError",
+    "StagedDirectory",
+    "StagedFile",
     "dir_empty",
     "dir_empty_unsafe",
     "dir_exists",
+    "dir_not_empty",
+    "dir_not_empty_unsafe",
     "dirs_empty",
     "dirs_empty_unsafe",
     "dirs_exist",
+    "dirs_not_empty",
+    "dirs_not_empty_unsafe",
     "ensure_dir_exists",
     "ensure_dirs_exist",
     "ensure_file_exists",
@@ -22,6 +28,8 @@ __all__ = (
     "make_dirs",
     "path_exists",
     "paths_exist",
+    "reserve_path",
+    "reserve_paths",
     "search_dirs",
     "search_files",
     "search_paths",
@@ -34,8 +42,12 @@ __all__ = (
 from kaparoo.filesystem.directory import (
     dir_empty,
     dir_empty_unsafe,
+    dir_not_empty,
+    dir_not_empty_unsafe,
     dirs_empty,
     dirs_empty_unsafe,
+    dirs_not_empty,
+    dirs_not_empty_unsafe,
     make_dir,
     make_dirs,
 )
@@ -65,7 +77,10 @@ from kaparoo.filesystem.search import (
     search_files,
     search_paths,
 )
+from kaparoo.filesystem.staged import StagedDirectory, StagedFile
 from kaparoo.filesystem.utils import (
+    reserve_path,
+    reserve_paths,
     stringify_path,
     stringify_paths,
     wrap_path,

kaparoo/filesystem/directory.py

@@ -3,13 +3,18 @@ from __future__ import annotations
 __all__ = (
     "dir_empty",
     "dir_empty_unsafe",
+    "dir_not_empty",
+    "dir_not_empty_unsafe",
     "dirs_empty",
     "dirs_empty_unsafe",
+    "dirs_not_empty",
+    "dirs_not_empty_unsafe",
     "make_dir",
     "make_dirs",
 )
 
 import os
+import shutil
 from pathlib import Path
 from typing import TYPE_CHECKING, overload
 
@@ -39,6 +44,7 @@ def make_dir(
     *,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: Literal[False] = False,
 ) -> Path: ...
 
@@ -49,6 +55,7 @@ def make_dir(
     *,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: Literal[True],
 ) -> str: ...
 
@@ -59,6 +66,7 @@ def make_dir(
     *,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: bool,
 ) -> Path | str: ...
 
@@ -68,6 +76,7 @@ def make_dir(
     *,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: bool = False,
 ) -> Path | str:
     """Recursively create a directory.
@@ -77,6 +86,11 @@ def make_dir(
         mode: The mode to use when creating the directory. Defaults to 0o777.
         exist_ok: Whether to suppress OSError if the path already exists.
             Defaults to False.
+        clean: Whether to recreate the directory empty when it already exists,
+            removing its contents first. Only an existing *directory* is wiped;
+            a non-directory still raises. Because the directory is removed and
+            remade, `clean=True` makes `exist_ok` moot. **Destructive.**
+            Defaults to False.
         stringify: Whether to return the path as a string. Defaults to False.
 
     Returns:
@@ -87,13 +101,16 @@ def make_dir(
         ValueError: If `mode` is outside the range 0o1-0o7777
             (not checked on Windows, where the mode is ignored).
         NotADirectoryError: If the path exists but is not a directory.
-        OSError: If `exist_ok` is False and the path already exists.
+        OSError: If `exist_ok` is False, `clean` is False, and the path
+            already exists.
     """
     _validate_mode(mode)
     path = Path(path)
     if path.exists() and not path.is_dir():
         msg = f"not a directory: {path}"
         raise NotADirectoryError(msg)
+    if clean and path.is_dir():
+        shutil.rmtree(path)
     path.mkdir(mode=mode, parents=True, exist_ok=exist_ok)
     return stringify_path(path) if stringify else path
 
@@ -105,6 +122,7 @@ def make_dirs(
     root: StrPath | None = None,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: Literal[False] = False,
 ) -> Sequence[Path]: ...
 
@@ -116,6 +134,7 @@ def make_dirs(
     root: StrPath | None = None,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: Literal[True],
 ) -> Sequence[str]: ...
 
@@ -127,6 +146,7 @@ def make_dirs(
     root: StrPath | None = None,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: bool,
 ) -> Sequence[Path] | Sequence[str]: ...
 
@@ -137,6 +157,7 @@ def make_dirs(
     root: StrPath | None = None,
     mode: int = 0o777,
     exist_ok: bool = False,
+    clean: bool = False,
     stringify: bool = False,
 ) -> Sequence[Path] | Sequence[str]:
     """Recursively create directories.
@@ -147,6 +168,11 @@ def make_dirs(
         mode: The mode to use when creating the directories. Defaults to 0o777.
         exist_ok: Whether to suppress OSError if any of the paths already exist.
             Defaults to False.
+        clean: Whether to recreate each directory empty when it already exists,
+            removing its contents first. Only an existing *directory* is wiped;
+            a non-directory still raises. Because the directory is removed and
+            remade, `clean=True` makes `exist_ok` moot. **Destructive.**
+            Defaults to False.
         stringify: Whether to return the paths as strings. Defaults to False.
 
     Returns:
@@ -159,13 +185,16 @@ def make_dirs(
         DirectoryNotFoundError: If `root` is provided and does not exist.
         NotADirectoryError: If `root` is provided and is not a directory.
         ValueError: If `root` is provided and any of the paths are absolute.
-        OSError: If `exist_ok` is False and any of the paths already exist.
+        OSError: If `exist_ok` is False, `clean` is False, and any of the
+            paths already exist.
         OSError: If any of the paths are not directories.
     """
     _validate_mode(mode)
     paths = _join_root_if_provided(paths, root)
     directories = [Path(p) for p in paths]
     for directory in directories:
+        if clean and directory.is_dir():
+            shutil.rmtree(directory)
         directory.mkdir(mode=mode, parents=True, exist_ok=exist_ok)
     return stringify_paths(directories) if stringify else directories
 
@@ -224,3 +253,53 @@ def dirs_empty(paths: StrPaths, *, root: StrPath | None = None) -> bool:
     """
     paths = ensure_dirs_exist(paths, root=root)
     return all(dir_empty_unsafe(p) for p in paths)
+
+
+def dir_not_empty_unsafe(path: StrPath) -> bool:
+    """Check if a directory is not empty without existence checks."""
+    return not dir_empty_unsafe(path)
+
+
+def dirs_not_empty_unsafe(paths: StrPaths, *, root: StrPath | None = None) -> bool:
+    """Check if directories are not empty without existence checks."""
+    if root is not None:
+        paths = [Path(root) / p for p in paths]
+    return all(dir_not_empty_unsafe(p) for p in paths)
+
+
+def dir_not_empty(path: StrPath) -> bool:
+    """Check if a directory is not empty.
+
+    Args:
+        path: The directory path to check.
+
+    Returns:
+        True if the directory is not empty, False otherwise.
+
+    Raises:
+        DirectoryNotFoundError: If the path does not exist.
+        NotADirectoryError: If the path is not a directory.
+    """
+    path = ensure_dir_exists(path)
+    return dir_not_empty_unsafe(path)
+
+
+def dirs_not_empty(paths: StrPaths, *, root: StrPath | None = None) -> bool:
+    """Check if directories are not empty.
+
+    Args:
+        paths: A sequence of directory paths to check.
+        root: The root directory to prepend to each path. Defaults to None.
+
+    Returns:
+        True if all directories are not empty, False otherwise.
+
+    Raises:
+        DirectoryNotFoundError: If `root` is provided and does not exist.
+        DirectoryNotFoundError: If any of the paths do not exist.
+        NotADirectoryError: If `root` is provided and is not a directory.
+        NotADirectoryError: If any of the paths are not directories.
+        ValueError: If `root` is provided and any of the paths are absolute.
+    """
+    paths = ensure_dirs_exist(paths, root=root)
+    return all(dir_not_empty_unsafe(p) for p in paths)

kaparoo/filesystem/search/classes.py

@@ -169,7 +169,7 @@ class Search(ABC):
 
         for dirpath, dirnames, filenames in root.walk():
             child_depth = len(dirpath.parts) - root_depth + 1
-            part = stringify_path(dirpath.relative_to(root))
+            part = stringify_path(dirpath, after=root)
 
             if child_depth >= min_depth and cls._filter_part(part, part_filter):
                 names = cls._select_names(dirnames, filenames)