kaparoo-python 0.6.0__tar.gz → 0.7.0__tar.gz

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kaparoo-python
-Version: 0.6.0
+Version: 0.7.0
 Summary: Personally common and useful Python features
 Keywords: filesystem,pathlib,paths,utilities
 Author: Jaewoo Park
@@ -65,7 +65,7 @@ hook for custom filter kinds.
 
 ### [`kaparoo.utils`](https://github.com/kaparoo/kaparoo-python/tree/main/kaparoo/utils)
 
-`Timer` / `SegmentTimer` context-manager-and-decorator timers (with
+`Timer` / `SpanTimer` context-manager-and-decorator timers (with
 `lap`-split and `measure`-block timings); `Aggregator` for nested,
 pluggable metric aggregation (the batch → epoch → run pattern;
 experimental); plus a small family of helpers for working with

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/README.md

@@ -44,7 +44,7 @@ hook for custom filter kinds.
 
 ### [`kaparoo.utils`](https://github.com/kaparoo/kaparoo-python/tree/main/kaparoo/utils)
 
-`Timer` / `SegmentTimer` context-manager-and-decorator timers (with
+`Timer` / `SpanTimer` context-manager-and-decorator timers (with
 `lap`-split and `measure`-block timings); `Aggregator` for nested,
 pluggable metric aggregation (the batch → epoch → run pattern;
 experimental); plus a small family of helpers for working with

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/kaparoo/filesystem/README.md

@@ -10,7 +10,7 @@
   `dir_not_empty(s)` with validation, plus `_unsafe` variants that skip
   pre-checks
 - [`utils`](./utils.py) — `stringify_path(s)`, `wrap_path(s)`,
-  `reserve_path(s)`
+  `reserve_path(s)`, `ensure_file_extension`
 - [`staged`](./staged.py) — `StagedFile` / `StagedDirectory`, safe
   (atomic) writers usable as a context manager or explicitly
 - [`exceptions`](./exceptions.py) — `DirectoryNotFoundError`, `NotAFileError`
@@ -116,6 +116,27 @@ stringify_paths(["data/a.txt", "data/b.txt"], after="data")  # ["a.txt", "b.txt"
 wrap_path("logs", prepend="var", append="server.log")  # var/logs/server.log
 ```
 
+`ensure_file_extension` is a pure (no filesystem) extension check: it
+requires a `.<ext>` final suffix, raising `ValueError` otherwise. `ext` may
+be a single extension or an iterable of acceptable ones; the leading dot is
+optional and the match is case-insensitive. `add=True` mirrors `make` on
+`ensure_dir_exists` — it appends the (first) extension when the path has no
+suffix (`np.save`-style) instead of raising; a *wrong* suffix still raises.
+
+```python
+from kaparoo.filesystem import ensure_file_extension
+
+ensure_file_extension("data.bin", "bin")             # Path("data.bin")
+ensure_file_extension("data.txt", "bin")             # ValueError
+ensure_file_extension("out/00000_phase", "bin")      # ValueError (no suffix)
+
+# Any of several accepted extensions:
+ensure_file_extension("img.jpeg", ("jpg", "jpeg", "png"))  # Path("img.jpeg")
+
+ensure_file_extension("out/00000_phase", "bin", add=True)  # Path("out/00000_phase.bin")
+ensure_file_extension("out/data.txt", "bin", add=True)     # ValueError (wrong suffix)
+```
+
 ## Reserving a destination
 
 `reserve_path` guards a path that should *not* yet exist, so you don't

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/kaparoo/filesystem/__init__.py

@@ -16,6 +16,7 @@ __all__ = (
     "ensure_dir_exists",
     "ensure_dirs_exist",
     "ensure_file_exists",
+    "ensure_file_extension",
     "ensure_files_exist",
     "ensure_path_exists",
     "ensure_paths_exist",
@@ -79,6 +80,7 @@ from kaparoo.filesystem.search import (
 )
 from kaparoo.filesystem.staged import StagedDirectory, StagedFile
 from kaparoo.filesystem.utils import (
+    ensure_file_extension,
     reserve_path,
     reserve_paths,
     stringify_path,

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/kaparoo/filesystem/utils.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 __all__ = (
+    "ensure_file_extension",
     "reserve_path",
     "reserve_paths",
     "stringify_path",
@@ -15,7 +16,7 @@ from pathlib import Path
 from typing import TYPE_CHECKING, overload
 
 if TYPE_CHECKING:
-    from collections.abc import Sequence
+    from collections.abc import Iterable, Sequence
     from typing import Literal
 
     from kaparoo.filesystem.types import StrPath, StrPaths
@@ -357,3 +358,54 @@ def reserve_paths(
         reserve_path(p, exist_ok=exist_ok, make_parents=make_parents) for p in paths
     ]
     return stringify_paths(paths) if stringify else paths
+
+
+def ensure_file_extension(
+    path: StrPath, ext: str | Iterable[str], *, add: bool = False
+) -> Path:
+    """Return `path` as a `Path`, requiring a case-insensitive `.<ext>` suffix.
+
+    A pure path check that never touches the filesystem. `ext` is a single
+    extension or an iterable of acceptable ones (e.g. `("jpg", "jpeg")`); the
+    leading dot on each is optional, so `"bin"` and `".bin"` behave the same.
+    Only the final suffix is considered: `archive.tar.gz` matches `ext="gz"`,
+    not `ext="tar.gz"`.
+
+    `add` mirrors `make` on `ensure_dir_exists`: when False (the default) a
+    path with no suffix raises like any other mismatch; when True, the missing
+    suffix is appended -- the *first* of `ext` when several are given, so pass
+    an ordered list/tuple if that matters. A *wrong* suffix always raises,
+    regardless of `add`.
+
+    Args:
+        path: The path to check.
+        ext: The required extension, or an iterable of acceptable ones, each
+            with or without a leading dot.
+        add: Whether to append the (first) extension when `path` has no
+            suffix, instead of raising. Defaults to False.
+
+    Returns:
+        The path as a Path object, guaranteed to end in an accepted `.<ext>`.
+
+    Raises:
+        ValueError: If `ext` is empty, or `path`'s final suffix is none of the
+            accepted extensions -- except the no-suffix case resolved by
+            `add=True`.
+    """
+    exts = [ext] if isinstance(ext, str) else list(ext)
+    exts = [e.removeprefix(".") for e in exts]
+
+    if not exts:
+        msg = "ext must name at least one extension"
+        raise ValueError(msg)
+
+    path = Path(path)
+    if add and not path.suffix:
+        return path.with_suffix(f".{exts[0]}")
+
+    if path.suffix.lower() not in {f".{e.lower()}" for e in exts}:
+        wanted = " / ".join(f".{e}" for e in exts)
+        msg = f"{path.name} must have a {wanted} extension (got {path.suffix!r})"
+        raise ValueError(msg)
+
+    return path

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/kaparoo/utils/README.md

@@ -4,7 +4,7 @@ Small, focused helpers — not enough material for their own packages.
 
 ## Modules
 
-- [`timer`](./timer.py) — `Timer`, `SegmentTimer`, `SegmentRecord`
+- [`timer`](./timer.py) — `Timer`, `SpanTimer`, `SpanRecord`
 - [`aggregate`](./aggregate.py) — `Aggregator` + the `Reduction` family
   (`Mean`, `Sum`, `Min`, `Max`, `Last`, `Fold`)
 - [`optional`](./optional.py) — helpers for `T | None` values
@@ -47,29 +47,29 @@ with Timer("ms") as t:
     do_work()
 ```
 
-## SegmentTimer
+## SpanTimer
 
-`SegmentTimer` extends `Timer` with named time *segments*. Each segment
-is a `SegmentRecord` (a `TypedDict` with `label`, `duration`,
+`SpanTimer` extends `Timer` with named time *spans*. Each span
+is a `SpanRecord` (a `TypedDict` with `label`, `duration`,
 `total_time`) and is produced in one of two ways:
 
 - **`lap(label)` — split.** Each lap's `duration` is the time since the
   previous lap (or the start), so every instant belongs to exactly one
-  segment.
+  span.
 - **`measure(label)` — stopwatch.** Times only the wrapped block; time
-  spent outside any `measure` block is attributed to no segment.
+  spent outside any `measure` block is attributed to no span.
 
 ```python
-from kaparoo.utils.timer import SegmentTimer
+from kaparoo.utils.timer import SpanTimer
 
-with SegmentTimer("ms", ndigits=1) as st:
+with SpanTimer("ms", ndigits=1) as st:
     step_a()
     st.lap("A")               # split: time since start
     idle()                    # NOT counted by the next measure
     with st.measure("B"):     # stopwatch: only this block
         step_b()
 
-# Per-segment details:
+# Per-span details:
 for record in st.records:
     print(record["label"], record["duration"])
 
@@ -80,7 +80,7 @@ print(st.elapsed)   # total wall time of the `with` block
 
 ### `lap` vs `measure`
 
-`lap` splits the timeline into contiguous segments — the gap before a
+`lap` splits the timeline into contiguous spans — the gap before a
 lap is folded into that lap. `measure` brackets a region and ignores
 everything outside it, so untimed work between blocks is excluded from
 `summary`. Pick `lap` for back-to-back phases, `measure` for discrete
@@ -88,16 +88,16 @@ operations interleaved with untimed work. Pauses inside either are
 excluded; a `measure` block that raises records nothing.
 
 `measure` doubles as a decorator (every decorated call records one
-segment, as long as the timer is running when it is called):
+span, as long as the timer is running when it is called):
 
 ```python
-st = SegmentTimer("ms")
+st = SpanTimer("ms")
 
 @st.measure("load")
 def load() -> None: ...
 
 with st:
-    load()        # records a "load" segment each call
+    load()        # records a "load" span each call
 ```
 
 ### Same-label policies
@@ -111,7 +111,7 @@ with st:
 The policy applies to both `lap` and `measure`:
 
 ```python
-with SegmentTimer(on_same_label="separate") as st:
+with SpanTimer(on_same_label="separate") as st:
     st.lap("A")
     st.lap("A")   # recorded as "A (2)"
     st.lap("A")   # recorded as "A (3)"

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/kaparoo/utils/__init__.py

@@ -6,8 +6,8 @@ __all__ = (
     "Mean",
     "Min",
     "Reduction",
-    "SegmentRecord",
-    "SegmentTimer",
+    "SpanRecord",
+    "SpanTimer",
     "Std",
     "Sum",
     "Timer",
@@ -42,4 +42,4 @@ from kaparoo.utils.optional import (
     unwrap_or_factories,
     unwrap_or_factory,
 )
-from kaparoo.utils.timer import SegmentRecord, SegmentTimer, Timer
+from kaparoo.utils.timer import SpanRecord, SpanTimer, Timer

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/kaparoo/utils/timer.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-__all__ = ("SegmentRecord", "SegmentTimer", "Timer")
+__all__ = ("SpanRecord", "SpanTimer", "Timer")
 
 import time
 from abc import ABC, abstractmethod
@@ -22,20 +22,20 @@ _SCALES: dict[str, float] = {"s": 1e-9, "ms": 1e-6, "us": 1e-3, "ns": 1.0}
 _LABEL_POLICIES: frozenset[str] = frozenset({"merge", "separate", "reject"})
 
 
-class SegmentRecord(TypedDict):
-    """A single timing record produced by `SegmentTimer`.
+class SpanRecord(TypedDict):
+    """A single timing record produced by `SpanTimer`.
 
-    A segment is produced either by `lap` (the span since the previous
+    A span is produced either by `lap` (the span since the previous
     lap) or by `measure` (the span of a wrapped block).
 
     Attributes:
-        label: The segment's name. May carry a " (N)" suffix when produced
+        label: The span's name. May carry a " (N)" suffix when produced
             under `on_same_label="separate"`.
-        duration: Length of this segment, in the timer's `unit` and rounded
+        duration: Length of this span, in the timer's `unit` and rounded
             by `ndigits` if given. For `lap`, the time since the previous
             lap (or the timer start); for `measure`, the wrapped block's
             duration.
-        total_time: Time elapsed from the timer start to this segment's end,
+        total_time: Time elapsed from the timer start to this span's end,
             in the timer's `unit` and rounded by `ndigits` if given.
     """
 
@@ -45,14 +45,14 @@ class SegmentRecord(TypedDict):
 
 
 class BaseTimer(ContextDecorator, ABC):
-    """Abstract base for `Timer` and `SegmentTimer`.
+    """Abstract base for `Timer` and `SpanTimer`.
 
     Provides the shared timing machinery: unit/precision formatting,
     `pause`/`resume`/`suspend`, and a context-manager protocol that
     auto-resumes a paused timer on exit. Subclasses implement `_finalize`
     to record their final result, and may override the `_reset` hook to
     clear per-`with`-block state. Not part of the public API -- prefer
-    `Timer` or `SegmentTimer`.
+    `Timer` or `SpanTimer`.
 
     An instance is reusable but **not reentrant**: a single instance must
     not be nested within itself -- including as a decorator on a recursive
@@ -249,30 +249,30 @@ class Timer(BaseTimer):
         self.elapsed = self._format_time(elapsed_ns)
 
 
-class SegmentTimer(BaseTimer):
-    """A timer recording named time segments within one `with` block.
+class SpanTimer(BaseTimer):
+    """A timer recording named time spans within one `with` block.
 
-    Usable as a context manager or as a decorator. Segments are recorded
+    Usable as a context manager or as a decorator. Spans are recorded
     in two complementary ways:
 
         - `lap(label)` splits the timeline: each lap's `duration` is the
           time since the previous lap (or the start), so every instant is
-          attributed to exactly one segment.
+          attributed to exactly one span.
         - `measure(label)` brackets a region (as a `with` block or a
           decorator): only the wrapped span is recorded, and time spent
-          outside any `measure` block is attributed to no segment.
+          outside any `measure` block is attributed to no span.
 
     Both feed the same `records` / `summary`, honour `on_same_label`, and
     exclude paused intervals.
 
     Attributes:
         on_same_label: The same-label handling policy (see `__init__`).
-        records: The recorded segments, in call order.
+        records: The recorded spans, in call order.
         elapsed: The total measured duration, from start to exit.
             Defaults to 0.0 until the first exit.
 
     Example:
-        with SegmentTimer("ms", ndigits=1) as st:
+        with SpanTimer("ms", ndigits=1) as st:
             step_a()
             st.lap("A")              # split: time since start
             with st.measure("B"):    # block: only this region
@@ -288,7 +288,7 @@ class SegmentTimer(BaseTimer):
         ndigits: int | None = None,
         on_same_label: LabelPolicy = "merge",
     ) -> None:
-        """Initialize the lap timer.
+        """Initialize the span timer.
 
         Args:
             unit: The time unit for reported values. One of "s", "ms", "us",
@@ -313,7 +313,7 @@ class SegmentTimer(BaseTimer):
             raise ValueError(msg)
 
         self.on_same_label = on_same_label
-        self.records: list[SegmentRecord] = []
+        self.records: list[SpanRecord] = []
         self.elapsed: float = 0.0
 
         self._last_time: int = 0
@@ -323,8 +323,8 @@ class SegmentTimer(BaseTimer):
     def summary(self) -> dict[str, float]:
         """Per-label sum of `duration` across `records`.
 
-        Only recorded segments count: time outside every `lap` / `measure`
-        segment (e.g. after the last `lap`, or between `measure` blocks) is
+        Only recorded spans count: time outside every `lap` / `measure`
+        span (e.g. after the last `lap`, or between `measure` blocks) is
         not included. Each record's `duration` is already rounded by
         `ndigits` (when set); this property sums those rounded values and
         rounds the sum once more.
@@ -377,11 +377,11 @@ class SegmentTimer(BaseTimer):
             else label
         )
 
-    def _make_record(self, label: str) -> SegmentRecord:
+    def _make_record(self, label: str) -> SpanRecord:
         """Build a record stamped with the current time and advance `_last_time`."""
         current_time = time.perf_counter_ns()
 
-        record: SegmentRecord = {
+        record: SpanRecord = {
             "label": label,
             "duration": self._format_time(current_time - self._last_time),
             "total_time": self._format_time(current_time - self._start_time),
@@ -415,12 +415,12 @@ class SegmentTimer(BaseTimer):
 
     @contextmanager
     def measure(self, label: str = "Block") -> Iterator[None]:
-        """Record a segment covering only the wrapped block (stopwatch style).
+        """Record a span covering only the wrapped block (stopwatch style).
 
-        Unlike `lap`, which splits the timeline into contiguous segments,
+        Unlike `lap`, which splits the timeline into contiguous spans,
         `measure` times only the wrapped region; time spent outside any
-        `measure` block is attributed to no segment. Pauses inside the
-        block are excluded. A segment is recorded only on clean exit -- if
+        `measure` block is attributed to no span. Pauses inside the
+        block are excluded. A span is recorded only on clean exit -- if
         the block raises, nothing is recorded and the exception propagates.
         Repeated labels follow `on_same_label`, exactly as `lap`. Do not
         nest `measure` blocks: each resets the shared baseline, so an outer
@@ -428,23 +428,23 @@ class SegmentTimer(BaseTimer):
 
         Because `contextmanager` results are also `ContextDecorator`s, the
         returned object doubles as a decorator (every decorated call
-        records one segment, provided the timer is running when called):
+        records one span, provided the timer is running when called):
 
-            st = SegmentTimer("ms")
+            st = SpanTimer("ms")
 
             @st.measure("load")
             def load() -> None: ...
 
             with st:
-                load()                    # records a "load" segment
+                load()                    # records a "load" span
                 with st.measure("parse"):
-                    parse()               # records a "parse" segment
+                    parse()               # records a "parse" span
 
         Args:
-            label: The segment's name. Defaults to "Block".
+            label: The span's name. Defaults to "Block".
 
         Yields:
-            None. The wrapped block runs while the segment is timed.
+            None. The wrapped block runs while the span is timed.
 
         Raises:
             RuntimeError: If the timer has not been started, or is paused on

{kaparoo_python-0.6.0 → kaparoo_python-0.7.0}/pyproject.toml

@@ -12,7 +12,7 @@ build-backend = "uv_build"
 
 [project]
 name = "kaparoo-python"
-version = "0.6.0"
+version = "0.7.0"
 description = "Personally common and useful Python features"
 readme = "README.md"
 requires-python = ">=3.14"