time-split 1.0.2__tar.gz → 1.0.4__tar.gz

{time_split-1.0.2 → time_split-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: time-split
-Version: 1.0.2
+Version: 1.0.4
 Summary: Time-based k-fold validation splits for heterogeneous data.
 License: MIT
 License-File: LICENSE.md
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Provides-Extra: app
 Provides-Extra: plotting
 Requires-Dist: click ; extra == "app"

{time_split-1.0.2 → time_split-1.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "time-split"
-version = "1.0.2"
+version = "1.0.4"
 description = "Time-based k-fold validation splits for heterogeneous data."
 authors = [
     { name = "Richard Sundqvist", email = "richard.sundqvist@live.se" },
@@ -23,6 +23,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
 ]
 requires-python = ">=3.11"
 

{time_split-1.0.2 → time_split-1.0.4}/src/time_split/__init__.py

@@ -1,7 +1,5 @@
 """Time-based k-fold validation splits for heterogeneous data."""
 
-import logging as _logging
-
 from ._frontend import log_split_progress, plot, split
 
 __all__ = [
@@ -11,6 +9,4 @@ __all__ = [
     "split",
 ]
 
-__version__ = "1.0.2"
-
-_logging.getLogger(__name__).addHandler(_logging.NullHandler())
+__version__ = "1.0.4"

{time_split-1.0.2 → time_split-1.0.4}/src/time_split/_backend/__init__.py

@@ -1,5 +1,5 @@
 from ._datetime_index_like import DatetimeIndexLike
-from ._limits import expand_limits
+from ._limits import expand_limits, is_limits_tuple
 from ._process_available import ProcessAvailableResult, process_available
 from ._splitter import DatetimeIndexSplitter
 
@@ -8,5 +8,6 @@ __all__ = [
     "DatetimeIndexSplitter",
     "ProcessAvailableResult",
     "expand_limits",
+    "is_limits_tuple",
     "process_available",
 ]

{time_split-1.0.2 → time_split-1.0.4}/src/time_split/_backend/_limits.py

@@ -1,6 +1,6 @@
 from collections.abc import Iterable
 from itertools import starmap
-from typing import NamedTuple
+from typing import Any, NamedTuple, TypeGuard
 
 from pandas import Timedelta, Timestamp
 
@@ -17,6 +17,25 @@ class _TimedeltaTuple(NamedTuple):
     tolerance: Timedelta
 
 
+def is_limits_tuple(arg: Any) -> TypeGuard[LimitsTuple]:
+    """Check if `arg` is a :class:`.LimitsTuple`.
+
+    Args:
+        arg: An argument.
+
+    Returns:
+        Returns ``True`` if `arg` is a :class:`.LimitsTuple`.
+    """
+    if not (isinstance(arg, tuple) and len(arg) == 2):  # noqa: PLR2004
+        return False
+
+    start, end = arg
+    if not (isinstance(start, Timestamp) and isinstance(end, Timestamp)):
+        return False
+
+    return bool(start <= end)
+
+
 def expand_limits(
     limits: LimitsTuple,
     spec: ExpandLimits | LevelTuple | Iterable[LevelTuple] = "auto",

{time_split-1.0.2 → time_split-1.0.4}/src/time_split/_frontend/_to_string.py

@@ -4,9 +4,10 @@ from typing import Any, Literal, overload
 from pandas import Timestamp
 from rics.strings import format_seconds as fmt_sec
 
+from .._backend import is_limits_tuple, process_available
 from .._backend._limits import LimitsTuple
 from ..settings import log_split_progress
-from ..types import DatetimeSplitBounds, DatetimeTypes, ExpandLimits
+from ..types import DatetimeIterable, DatetimeSplitBounds, DatetimeTypes, ExpandLimits
 
 
 @overload
@@ -163,10 +164,11 @@ class _PrettyTimestamp:
 
 
 def format_expanded_limits(
-    original: LimitsTuple,
+    original: LimitsTuple | DatetimeIterable,
     *,
     expanded: LimitsTuple | None = None,
-    expand_limits: ExpandLimits,
+    expand_limits: ExpandLimits = "auto",
+    raise_if_same: bool = False,
 ) -> str:
     """Format expanded limits.
 
@@ -174,14 +176,56 @@ def format_expanded_limits(
         original: The original data limits.
         expanded: Expanded data limits. Derived based on `original` and `expanded_limits` if ``None``.
         expand_limits: Limits expansion spec.
+        raise_if_same: If ``True``, raise a :exc:`ValueError` if the `original` and `expanded_limits` are not the same.
+            Otherwise, a different message will be returned instead.
 
     Returns:
         A string.
+
+    Raises:
+        ValueError: If ``raise_on_same`` is ``True`` and ``original == expanded``.
+
+    Examples:
+        Basic usage.
+
+        >>> limits = "2019-05-11", "2019-05-11 22:05:30"
+        >>> string = format_expanded_limits(limits, expand_limits="d<3h")
+        >>> print(string)
+        Available data limits have been expanded (since expand_limits='d<3h'):
+          start: 2019-05-11 00:00:00 -> <no change>
+            end: 2019-05-11 22:05:30 -> 2019-05-12 (+1h 54m 30s)
+
+        A different message is shown when the limits aren't expanded.
+
+        >>> string = format_expanded_limits(limits, expand_limits="d<1h")
+        >>> print(string)
+        Original limits ('2019-05-11', '2019-05-11 22:05:30') were not expanded (since expand_limits='d<1h').
+
+        Set ``raise_if_same=True`` to disable the second message.
+
+    See Also:
+        The :func:`.process_available` and :func:`.expand_limits` functions.
     """
     if expanded is None:
-        from .._backend._limits import expand_limits as expand
-
-        expanded = expand(original, spec=expand_limits)
+        if is_limits_tuple(original):
+            from .._backend._limits import expand_limits as expand
+
+            expanded = expand(original, spec=expand_limits)
+        else:
+            result = process_available(original, expand_limits=expand_limits)
+            original = result.limits
+            expanded = result.expanded_limits
+
+    if not is_limits_tuple(original):
+        msg = f"Bad {original=}; not a valid limits tuple."
+        raise TypeError(msg)
+
+    if original == expanded:
+        left, right = stringify(original[0]), stringify(original[1])
+        msg = f"Original limits {(left, right)} were not expanded (since {expand_limits=})."
+        if raise_if_same:
+            raise ValueError(msg)
+        return msg
 
     return (
         f"Available data limits have been expanded (since {expand_limits=}):\n"