kaparoo-python 0.1.12__py3-none-any.whl → 0.2.1__py3-none-any.whl

kaparoo/data/{files/base.py → sequence.py}

@@ -1,45 +1,39 @@
-from __future__ import annotations
-
-__all__ = ("DataSequence",)
-
-from abc import abstractmethod
-from collections.abc import Sequence
-from typing import TYPE_CHECKING, overload
-
-from kaparoo.utils.types import T_co
-
-if TYPE_CHECKING:
-    from typing import Self
-
-    from kaparoo.filesystem.types import StrPath
-
-
-class DataSequence(Sequence[T_co]):
-    @abstractmethod
-    def __init__(self: Self, path: StrPath) -> None:
-        raise NotImplementedError
-
-    @abstractmethod
-    def __len__(self: Self) -> int:
-        raise NotImplementedError
-
-    @overload
-    def __getitem__(self: Self, index: int, /) -> T_co:
-        pass
-
-    @overload
-    def __getitem__(self: Self, index: slice, /) -> Sequence[T_co]:
-        pass
-
-    def __getitem__(self: Self, index: int | slice, /) -> T_co | Sequence[T_co]:
-        if isinstance(index, slice):
-            start, stop, step = index.indices(len(self))
-            return self.by_indices(range(start, stop, step))
-        return self.by_index(index)
-
-    @abstractmethod
-    def by_index(self: Self, index: int) -> T_co:
-        raise NotImplementedError
-
-    def by_indices(self: Self, indices: Sequence[int]) -> Sequence[T_co]:
-        return [self.by_index(index) for index in indices]
+from __future__ import annotations
+
+__all__ = ("DataSequence",)
+
+from abc import abstractmethod
+from collections.abc import Sequence
+from typing import TYPE_CHECKING, overload
+
+if TYPE_CHECKING:
+    from kaparoo.filesystem.types import StrPath
+
+
+class DataSequence[T](Sequence[T]):
+    @abstractmethod
+    def __init__(self, path: StrPath) -> None:
+        raise NotImplementedError
+
+    @abstractmethod
+    def __len__(self) -> int:
+        raise NotImplementedError
+
+    @overload
+    def __getitem__(self, index: int, /) -> T: ...
+
+    @overload
+    def __getitem__(self, index: slice, /) -> Sequence[T]: ...
+
+    def __getitem__(self, index: int | slice, /) -> T | Sequence[T]:
+        if isinstance(index, slice):
+            start, stop, step = index.indices(len(self))
+            return self.by_indices(range(start, stop, step))
+        return self.by_index(index)
+
+    @abstractmethod
+    def by_index(self, index: int) -> T:
+        raise NotImplementedError
+
+    def by_indices(self, indices: Sequence[int]) -> Sequence[T]:
+        return [self.by_index(index) for index in indices]

kaparoo/data/utils.py

@@ -1,49 +1,46 @@
-from __future__ import annotations
-
-__all__ = ("generate_batches",)
-
-from typing import TYPE_CHECKING
-
-from kaparoo.utils.optional import replace_if_none
-
-if TYPE_CHECKING:
-    from collections.abc import Generator, Sequence
-    from typing import Any
-
-    from kaparoo.utils.types import T_co
-
-
-def generate_batches(
-    sequence: Sequence[T_co],
-    size: int,
-    step: int = 1,
-    skip: int = 1,
-    start: int = 0,
-    stop: int | None = None,
-    *,
-    drop_last: bool = True,
-) -> Generator[Sequence[T_co], Any, None]:
-    def die_if_not_positive(name: str, value: int) -> None:
-        if value <= 0:
-            raise ValueError(f"{name} must be positive (got {value})")
-
-    die_if_not_positive("size", size)
-    die_if_not_positive("step", step)
-    die_if_not_positive("skip", skip)
-
-    stop = replace_if_none(stop, len_ := len(sequence))
-    if not (start < stop <= len_ and start >= 0):
-        raise ValueError(
-            f"invalid range [{start}, {stop}) for sequence of length {len_}"
-        )
-
-    head = start
-    tail = head + (size - 1) * skip + 1
-
-    while tail <= stop:
-        yield sequence[head:tail:skip]
-        head += step
-        tail += step
-
-    if not drop_last and head < stop:
-        yield sequence[head:tail:skip]
+from __future__ import annotations
+
+__all__ = ("generate_batches",)
+
+from typing import TYPE_CHECKING
+
+from kaparoo.utils.optional import replace_if_none
+
+if TYPE_CHECKING:
+    from collections.abc import Iterator, Sequence
+
+
+def generate_batches[T](
+    sequence: Sequence[T],
+    size: int,
+    step: int = 1,
+    skip: int = 1,
+    start: int = 0,
+    stop: int | None = None,
+    *,
+    drop_last: bool = True,
+) -> Iterator[Sequence[T]]:
+    def die_if_not_positive(name: str, value: int) -> None:
+        if value <= 0:
+            msg = f"{name} must be positive (got {value})"
+            raise ValueError(msg)
+
+    die_if_not_positive("size", size)
+    die_if_not_positive("step", step)
+    die_if_not_positive("skip", skip)
+
+    stop = replace_if_none(stop, len_ := len(sequence))
+    if not (start < stop <= len_ and start >= 0):
+        msg = f"invalid range [{start}, {stop}) for sequence of length {len_}"
+        raise ValueError(msg)
+
+    head = start
+    tail = head + (size - 1) * skip + 1
+
+    while tail <= stop:
+        yield sequence[head:tail:skip]
+        head += step
+        tail += step
+
+    if not drop_last and head < stop:
+        yield sequence[head:tail:skip]

kaparoo/filesystem/__init__.py

@@ -1,56 +1,73 @@
-__all__ = (
-    # utils
-    "prepend_path",
-    "prepend_paths",
-    "stringify_path",
-    "stringify_paths",
-    # existence
-    "ensure_dir_exists",
-    "ensure_dirs_exist",
-    "ensure_path_exists",
-    "ensure_paths_exist",
-    "ensure_file_exists",
-    "ensure_files_exist",
-    "dir_exists",
-    "dirs_exist",
-    "file_exists",
-    "files_exist",
-    "path_exists",
-    "paths_exist",
-    # directory
-    "dir_empty",
-    "dirs_empty",
-    "get_dirs",
-    "get_files",
-    "get_paths",
-    "make_dirs",
-)
-
-from kaparoo.filesystem.directory import (
-    dir_empty,
-    dirs_empty,
-    get_dirs,
-    get_files,
-    get_paths,
-    make_dirs,
-)
-from kaparoo.filesystem.existence import (
-    dir_exists,
-    dirs_exist,
-    ensure_dir_exists,
-    ensure_dirs_exist,
-    ensure_file_exists,
-    ensure_files_exist,
-    ensure_path_exists,
-    ensure_paths_exist,
-    file_exists,
-    files_exist,
-    path_exists,
-    paths_exist,
-)
-from kaparoo.filesystem.utils import (
-    prepend_path,
-    prepend_paths,
-    stringify_path,
-    stringify_paths,
-)
+__all__ = (
+    "DirectoryNotFoundError",
+    "NotAFileError",
+    "dir_empty",
+    "dir_empty_unsafe",
+    "dir_exists",
+    "dirs_empty",
+    "dirs_empty_unsafe",
+    "dirs_exist",
+    "ensure_dir_exists",
+    "ensure_dirs_exist",
+    "ensure_file_exists",
+    "ensure_files_exist",
+    "ensure_path_exists",
+    "ensure_paths_exist",
+    "file_exists",
+    "files_exist",
+    "get_dirs",
+    "get_files",
+    "get_paths",
+    "make_dir",
+    "make_dirs",
+    "path_exists",
+    "paths_exist",
+    "search_dirs",
+    "search_files",
+    "search_paths",
+    "stringify_path",
+    "stringify_paths",
+    "wrap_path",
+    "wrap_paths",
+)
+
+from kaparoo.filesystem.directory import (
+    dir_empty,
+    dir_empty_unsafe,
+    dirs_empty,
+    dirs_empty_unsafe,
+    make_dir,
+    make_dirs,
+)
+from kaparoo.filesystem.exceptions import (
+    DirectoryNotFoundError,
+    NotAFileError,
+)
+from kaparoo.filesystem.existence import (
+    dir_exists,
+    dirs_exist,
+    ensure_dir_exists,
+    ensure_dirs_exist,
+    ensure_file_exists,
+    ensure_files_exist,
+    ensure_path_exists,
+    ensure_paths_exist,
+    file_exists,
+    files_exist,
+    path_exists,
+    paths_exist,
+)
+from kaparoo.filesystem.search import (
+    get_dirs,
+    get_files,
+    get_paths,
+    search_dirs,
+    search_files,
+    search_paths,
+)
+from kaparoo.filesystem.utils import (
+    stringify_path,
+    stringify_paths,
+    wrap_path,
+    wrap_paths,
+)