time-split 0.6.0__tar.gz → 0.7.0__tar.gz

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

@@ -1,31 +1,38 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: time-split
-Version: 0.6.0
+Version: 0.7.0
 Summary: Time-based k-fold validation splits for heterogeneous data.
-Home-page: https://github.com/rsundqvist/time-split
+License: MIT
+Keywords: hyper,parameter,optimization,cross,validation,time,temporal,heterogenous,data
 Author: Richard Sundqvist
 Author-email: richard.sundqvist@live.se
 Requires-Python: >=3.11
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX :: Linux
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: Microsoft :: Windows
-Classifier: Operating System :: POSIX :: Linux
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Typing :: Typed
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.13
+Provides-Extra: app
 Provides-Extra: plotting
+Requires-Dist: click ; extra == "app"
 Requires-Dist: matplotlib ; extra == "plotting"
 Requires-Dist: pandas (>=2.0.3)
-Requires-Dist: rics (>=4.1.1)
+Requires-Dist: rics (>=6.0.1)
 Requires-Dist: seaborn ; extra == "plotting"
+Requires-Dist: time-split-app ; extra == "app"
 Project-URL: Bug Tracker, https://github.com/rsundqvist/time-split/issues
 Project-URL: Changelog, https://github.com/rsundqvist/time-split/blob/master/CHANGELOG.md
-Project-URL: Documentation, https://time-split.readthedocs.io
+Project-URL: Documentation, https://time-split
+Project-URL: Homepage, https://github.com/rsundqvist/time-split
 Project-URL: Repository, https://github.com/rsundqvist/time-split
 Description-Content-Type: text/markdown
 
@@ -61,26 +68,29 @@ strong non-stationary characteristics.
   schedule itself.
 - Automatically extract and [normalize](https://time-split.readthedocs.io/en/stable/guide/expand_limits.html) data limits for 
   supported data types.
-- [Plotting function](https://time-split.readthedocs.io/en/stable/generated/time_split.html#time_split.plot) for
+- [Plotting function](https://time-split.readthedocs.io/en/stable/api/time_split.html#time_split.plot) for
   visualization of folds. Display fold sizes (hour/row count), or 
   [use custom text](https://time-split.readthedocs.io/en/stable/auto_examples/plotting_with_metrics.html).
-- [Integrations](https://time-split.readthedocs.io/en/stable/generated/time_split.integration.html) for popular 
+- [Integrations](https://time-split.readthedocs.io/en/stable/api/time_split.integration.html) for popular 
   libraries such as `pandas`, `polars` and `scikit-learn`.
 - Convenient [web application](#experimenting-with-parameters) for exploring folds with different parameters.
 
 ## Experimenting with parameters
-The **Time Fold Explorer** application
+The **Time Split** application
 (available [here](https://time-split.streamlit.app/?data=1554942900-1557610200&schedule=0+0+%2A+%2A+MON%2CFRI&n_splits=2&step=2&show_removed=True))
 is designed to help evaluate the effects of different
 [parameters](https://time-split.readthedocs.io/en/stable/#parameter-overview).
-To start it locally using
-[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/rsundqvist/time-split/latest?logo=docker&label=time-split)](https://hub.docker.com/r/rsundqvist/time-split/)
-Docker, run
+To start it locally, run
 ```sh
 docker run -p 8501:8501 rsundqvist/time-split
 ```
+or 
+```bash
+pip install time-split[app]
+python -m time_split app start
+```
 in the terminal. You may use
-[`create_explorer_link()`](https://time-split.readthedocs.io/en/stable/generated/time_split.support.html#time_split.support.create_explorer_link)
+[`create_explorer_link()`](https://time-split.readthedocs.io/en/stable/api/time_split.app.html#time_split.app.create_explorer_link)
 to build application URLs with preselected splitting parameters.
 
 ## Installation

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

@@ -30,26 +30,29 @@ strong non-stationary characteristics.
   schedule itself.
 - Automatically extract and [normalize](https://time-split.readthedocs.io/en/stable/guide/expand_limits.html) data limits for 
   supported data types.
-- [Plotting function](https://time-split.readthedocs.io/en/stable/generated/time_split.html#time_split.plot) for
+- [Plotting function](https://time-split.readthedocs.io/en/stable/api/time_split.html#time_split.plot) for
   visualization of folds. Display fold sizes (hour/row count), or 
   [use custom text](https://time-split.readthedocs.io/en/stable/auto_examples/plotting_with_metrics.html).
-- [Integrations](https://time-split.readthedocs.io/en/stable/generated/time_split.integration.html) for popular 
+- [Integrations](https://time-split.readthedocs.io/en/stable/api/time_split.integration.html) for popular 
   libraries such as `pandas`, `polars` and `scikit-learn`.
 - Convenient [web application](#experimenting-with-parameters) for exploring folds with different parameters.
 
 ## Experimenting with parameters
-The **Time Fold Explorer** application
+The **Time Split** application
 (available [here](https://time-split.streamlit.app/?data=1554942900-1557610200&schedule=0+0+%2A+%2A+MON%2CFRI&n_splits=2&step=2&show_removed=True))
 is designed to help evaluate the effects of different
 [parameters](https://time-split.readthedocs.io/en/stable/#parameter-overview).
-To start it locally using
-[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/rsundqvist/time-split/latest?logo=docker&label=time-split)](https://hub.docker.com/r/rsundqvist/time-split/)
-Docker, run
+To start it locally, run
 ```sh
 docker run -p 8501:8501 rsundqvist/time-split
 ```
+or 
+```bash
+pip install time-split[app]
+python -m time_split app start
+```
 in the terminal. You may use
-[`create_explorer_link()`](https://time-split.readthedocs.io/en/stable/generated/time_split.support.html#time_split.support.create_explorer_link)
+[`create_explorer_link()`](https://time-split.readthedocs.io/en/stable/api/time_split.app.html#time_split.app.create_explorer_link)
 to build application URLs with preselected splitting parameters.
 
 ## Installation

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

@@ -1,15 +1,15 @@
-[tool.poetry]
+[project]
 name = "time-split"
-version = "0.6.0"
+version = "0.7.0"
 description = "Time-based k-fold validation splits for heterogeneous data."
-authors = ["Richard Sundqvist <richard.sundqvist@live.se>"]
-
+authors = [
+    { name = "Richard Sundqvist", email = "richard.sundqvist@live.se" },
+]
+license = { text = "MIT" }
 readme = "README.md"
-homepage = "https://github.com/rsundqvist/time-split"
-repository = "https://github.com/rsundqvist/time-split"
-documentation = "https://time-split.readthedocs.io"
+keywords = ["hyper", "parameter", "optimization", "cross", "validation", "time", "temporal", "heterogenous", "data"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
     "Operating System :: POSIX :: Linux",
@@ -17,50 +17,54 @@ classifiers = [
     "Operating System :: Microsoft :: Windows",
     "License :: OSI Approved :: MIT License",
     "Natural Language :: English",
+    "Typing :: Typed",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
+requires-python = ">=3.11"
 
+dependencies = [
+    "pandas >= 2.0.3",
+    "rics   >= 6.0.1",
+]
 
-[tool.poetry.urls]
+[project.optional-dependencies]
+app = ["click", "time-split-app"]  # Constraints managed by app.
+plotting = ["matplotlib", "seaborn"]
+
+[project.urls]
+homepage = "https://github.com/rsundqvist/time-split"
+repository = "https://github.com/rsundqvist/time-split"
+documentation = "https://time-split"
 "Bug Tracker" = "https://github.com/rsundqvist/time-split/issues"
 "Changelog" = "https://github.com/rsundqvist/time-split/blob/master/CHANGELOG.md"
 
-[tool.poetry.scripts]
+[project.entry-points."rics.cli"]
+time-split = "time_split.cli:main"
 
-[tool.poetry.dependencies]
-python = ">=3.11"
-
-pandas = ">=2.0.3"
-rics = ">=4.1.1"
-
-# plotting
-matplotlib = { version = "*", optional = true }
-seaborn = { version = "*", optional = true }
-
-[tool.poetry.extras]
-plotting = ["matplotlib", "seaborn"]
+[tool.poetry.requires-plugins]
+poetry-plugin-export = ">=1.8"
 
 [tool.poetry.group.manual-extras.dependencies]
 # Extras that must be available for docs + tests go here. Doc/test-only deps go in their respective groups.
-croniter = "^2.0.3"
-pyarrow = ">=15.0.2,<17.0.0"
-polars = { version = "^0.20.19", extras = ["pandas"] }
-streamlit = "*"
+croniter = "^6.0.0"
+pyarrow = "^19.0.0"
+polars = { version = "^1.21.0", extras = ["pandas"] }
 
 [tool.poetry.group.docs]
 [tool.poetry.group.docs.dependencies]
 # duplicate object warnings for sphinx>=4
 # description: https://github.com/astropy/astropy/issues/11723
 # https://github.com/astropy/astropy/pull/12270
-sphinx = "^7.2.6"
-sphinx-gallery = "^0.16.0"
-pydata-sphinx-theme = "^0.15.2"
-myst-parser = ">=2,<4"
-nbsphinx = "^0.9.3"
-ipython = "^8.23.0"
+sphinx = "~8.1.3"
+sphinx-gallery = "^0.18.0"
+pydata-sphinx-theme = "^0.16.1"
+myst-parser = "^4.0.0"
+nbsphinx = "^0.9.6"
+ipython = "^8.31.0"
 
 [tool.poetry.group.notebooks]
 optional = true
@@ -71,26 +75,22 @@ jupyterlab-execute-time = "*"
 tqdm = "*"
 
 [tool.poetry.group.test.dependencies]
-pytest = "^8.1.1"
-xdoctest = "^1.1.3"
-coverage = "^7.4.4"
-pytest-cov = "^5.0.0"
-
-scikit-learn = "^1.4.2"
-# TODO Unpin.
-# dask.datasets.timeseries() warns:
-#     UserWarning: dask_expr does not support the DataFrameIOFunction protocol for column projection
-# on dask == 2024.3.1
-dask = { version = "==2024.5.0", extras = ["dataframe"] }
+pytest = "^8.3.4"
+xdoctest = "^1.2.0"
+coverage = "^7.6.10"
+pytest-cov = "^6.0.0"
+
+scikit-learn = "^1.6.1"
+dask = { version = "^2025.1.0", extras = ["dataframe"] }
 
 [tool.poetry.group.devops.dependencies]
-invoke = "^2.2.0"
-mypy = "^1.10.1"
-ruff = "^0.5.0"
+invoke = "~2.2.0"
+mypy = "~1.17.0"
+ruff = "~0.12.3"
 
-safety = "^3.2.3"
-codespell = "^2.3.0"
-bump2version = "^1.0.1"
+safety = "~3.5.1"
+codespell = "~2.4.1"
+bump2version = "~1.0.1"
 
 [tool.ruff]
 line-length = 120
@@ -135,8 +135,6 @@ select = [
     "TRY",
 ]
 ignore = [
-    "ANN101", # Missing type annotation for `self` in method
-    "ANN102", # Missing type annotation for `cls` in method
     "D105", # Missing docstring in magic method
     "D107", # Missing docstring in `__init__`
     "ANN401",
@@ -147,8 +145,9 @@ ignore = [
     "PLR0913", #
     "SIM108", # Use ternary operator - coverage issue, see https://github.com/nedbat/coveragepy/issues/509
     "TD003", # Missing issue link
+    "TC006", # Add quotes to type expression in `typing.cast()`
+    "UP038", #  https://github.com/astral-sh/ruff/issues/7871
 ]
-allowed-confusables = ["ℹ"]
 
 [tool.ruff.lint.per-file-ignores]
 "tests/*" = [
@@ -169,6 +168,10 @@ allowed-confusables = ["ℹ"]
     "ARG002", # Unused method argument: `groups`
 ]
 
+"**/time_split/app/*" = [
+    "S101" # Allow 'assert' keyword
+]
+
 [tool.ruff.lint.pydocstyle]
 convention = "google"
 [tool.ruff.lint.pycodestyle]
@@ -179,13 +182,10 @@ max-line-length = 150
 filterwarnings = [
     "error",
     "ignore:Matplotlib is currently using agg:UserWarning",
-    "ignore:.*utcfromtimestamp.*:DeprecationWarning", # Detta är farligt - ta bort
+    "ignore:.*'mode' parameter.*Pillow 13.*:DeprecationWarning",
 ]
 log_file_level = 10
 log_file = "pytest.log"
-norecursedirs = [
-    "**/cli_modules/*",
-]
 
 [build-system]
 requires = ["poetry-core>=1.0.8"]

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/__init__.py

@@ -5,12 +5,12 @@ import logging as _logging
 from ._frontend import log_split_progress, plot, split
 
 __all__ = [
+    "__version__",  # Make MyPy happy
     "log_split_progress",
     "plot",
     "split",
-    "__version__",  # Make MyPy happy
 ]
 
-__version__ = "0.6.0"
+__version__ = "0.7.0"
 
 _logging.getLogger(__name__).addHandler(_logging.NullHandler())

time_split-0.7.0/src/time_split/__main__.py

@@ -0,0 +1,9 @@
+"""Alias of :mod:`time_split.cli`.
+
+As per, https://docs.python.org/3.13/library/__main__.html#id1,
+this file doesn't use a ``if __name__ == "__main__"``-block.
+"""
+
+from .cli import main
+
+main()

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_backend/_limits.py

@@ -4,7 +4,7 @@ from typing import NamedTuple
 
 from pandas import Timedelta, Timestamp
 
-from ..settings import auto_expand_limits
+from ..settings import auto_expand_limits, misc
 from ..types import ExpandLimits, TimedeltaTypes
 
 LimitsTuple = tuple[Timestamp, Timestamp]
@@ -23,6 +23,8 @@ def expand_limits(
 ) -> LimitsTuple:
     """Derive the `"real"` bounds of `limits`.
 
+    Use :attr:`time_split.settings.misc.round_limits` to allow inward "expansion".
+
     Args:
         limits: A tuple ``(min, max)`` of timestamps.
         spec: Expansion spec as described in the :ref:`User guide`. Also supports level-tuples
@@ -61,6 +63,7 @@ def expand_limits(
         >>> expand_limits(limits, "d<14h")
         (Timestamp('2019-05-11 00:00:00'), Timestamp('2019-05-11 11:05:30'))
 
+        To disable this restriction, set :attr:`round_limits=True <.misc.round_limits>` in the settings.
     """
     if limits[0] >= limits[1]:
         msg = f"Bad limits. Expected limits[1] > limits[0], but got {limits=}."
@@ -102,19 +105,24 @@ def _from_levels(limits: LimitsTuple, *, levels: Iterable[_TimedeltaTuple] | Non
 def _apply(limits: LimitsTuple, *, level: _TimedeltaTuple) -> LimitsTuple:
     lo, hi = limits
 
-    lo_floor = lo.floor(level.round_to)
+    round = misc.round_limits
+    lo_floor = lo.round(level.round_to) if round else lo.floor(level.round_to)
     if abs(lo_floor - lo) > level.tolerance:
         return limits
 
-    hi_ceil = hi.ceil(level.round_to)
+    hi_ceil = hi.round(level.round_to) if round else hi.ceil(level.round_to)
     if abs(hi_ceil - hi) > level.tolerance:
         return limits
 
     if auto_expand_limits.SANITY_CHECK:
-        if lo.round(level.round_to) != lo_floor:
-            return limits
-        if hi.round(level.round_to) != hi_ceil:
-            return limits
+        if round:
+            if lo_floor == hi_ceil:
+                return limits
+        else:
+            if lo.round(level.round_to) != lo_floor:
+                return limits
+            if hi.round(level.round_to) != hi_ceil:
+                return limits
 
     return lo_floor, hi_ceil
 

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_backend/_schedule.py

@@ -1,4 +1,4 @@
-from typing import NamedTuple, cast, get_args
+from typing import NamedTuple, get_args
 
 from pandas import DatetimeIndex, NaT, Timedelta, Timestamp, date_range
 
@@ -6,7 +6,7 @@ from ..types import DatetimeIterable, ExpandLimits, Schedule, TimedeltaTypes
 from ._limits import LimitsTuple
 from ._process_available import ProcessAvailableResult, process_available
 
-NO_LIMITS = cast(LimitsTuple, (NaT, NaT))
+NO_LIMITS: LimitsTuple = NaT, NaT
 
 
 class MaterializedSchedule(NamedTuple):

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_backend/_splitter.py

@@ -1,6 +1,4 @@
-import logging
 from dataclasses import asdict, dataclass
-from functools import lru_cache
 from typing import cast, get_args
 
 from pandas import Timedelta
@@ -17,12 +15,9 @@ from ..types import (
     Span,
     TimedeltaTypes,
 )
-from ._limits import LimitsTuple
 from ._schedule import MaterializedSchedule, materialize_schedule
 from ._span import OffsetCalculator, to_strict_span
 
-LOGGER = logging.getLogger("time_split")
-
 
 @dataclass(frozen=True)
 class DatetimeIndexSplitter:
@@ -39,7 +34,6 @@ class DatetimeIndexSplitter:
     def get_splits(self, available: DatetimeIterable | None = None) -> DatetimeSplits:
         """Compute a split of given user data."""
         ms = self._materialize_schedule(available)
-        self._log_expansion(ms.available_metadata.limits, expanded=ms.available_metadata.expanded_limits)
         return self._make_bounds_list(ms)
 
     def get_plot_data(self, available: DatetimeIterable | None = None) -> tuple[DatetimeSplits, MaterializedSchedule]:
@@ -70,7 +64,7 @@ class DatetimeIndexSplitter:
             return ms
 
         from_end = ms.available_metadata.expanded_limits[1] - (ms.schedule[-1] + Timedelta(self.after))
-        from_end = from_end.floor(schedule_frequency.base)
+        from_end = from_end.floor(schedule_frequency.base)  # TODO(settings): should this depend on misc.round_limits?
 
         return ms._replace(schedule=ms.schedule + from_end)
 
@@ -109,7 +103,6 @@ class DatetimeIndexSplitter:
 
         Returns:
             Filtered splits.
-
         """
         if self.step != 1:
             step = abs(self.step)
@@ -127,21 +120,6 @@ class DatetimeIndexSplitter:
 
         return [s for s in splits if settings.filter(*s)]
 
-    def _log_expansion(self, original: LimitsTuple, *, expanded: LimitsTuple) -> None:
-        from .._frontend import format_expanded_limits
-
-        if original == expanded or not LOGGER.isEnabledFor(logging.INFO):
-            return
-
-        message = format_expanded_limits(original, expanded=expanded, expand_limits=self.expand_limits)
-        self._emit_once(message)
-
-    @staticmethod
-    @lru_cache(8)
-    def _emit_once(message: str) -> None:
-        """Emit if **not** in the eight most recent emission messages."""
-        LOGGER.info(message)
-
     def __post_init__(self) -> None:
         # Verify n_splits
         if self.n_splits < 0:

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_docstrings.py

@@ -1,6 +1,5 @@
-from typing import Callable, ParamSpec, TypeVar
-
-from time_split._compat import deprecated_params
+from collections.abc import Callable
+from typing import ParamSpec, TypeVar
 
 P = ParamSpec("P")
 T = TypeVar("T")
@@ -15,12 +14,6 @@ def docs(__func: Callable[P, T], /) -> Callable[P, T]:
     """Add info the docstring of a function."""
     assert __func.__doc__ is not None  # noqa: S101
     __func.__doc__ = __func.__doc__.format(**_DOCSTRINGS)
-
-    if isinstance(__func, type):
-        __func.__init__ = deprecated_params(__func.__init__)  # type: ignore[misc]
-    else:
-        __func = deprecated_params(__func)
-
     return __func
 
 

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_frontend/_plot.py

@@ -1,11 +1,11 @@
+from collections.abc import Sized
 from dataclasses import asdict, dataclass, replace
-from typing import TYPE_CHECKING, Any, Literal, Sized
+from typing import TYPE_CHECKING, Any, Literal
 
 import pandas as pd
 from pandas import Timestamp
 from rics.misc import format_kwargs, get_public_module
-
-from time_split._compat import fmt_sec
+from rics.strings import format_seconds as fmt_sec
 
 from .._backend import DatetimeIndexSplitter
 from .._backend._datetime_index_like import DatetimeIndexLike
@@ -65,7 +65,7 @@ def plot(
     after: Span = 1,
     step: int = 1,
     n_splits: int = 0,
-    available: DatetimeIterable | None = None,
+    available: DatetimeIterable | pd.DataFrame | pd.Series | None = None,
     expand_limits: ExpandLimits = "auto",
     ignore_filters: bool = False,
     # Split plot args
@@ -112,6 +112,15 @@ def plot(
     """
     import matplotlib.pyplot as plt
 
+    if (
+        available is not None
+        and hasattr(available, "index")
+        and not callable(available.index)
+        and hasattr(available, "shape")
+        and len(available.shape) != 1
+    ):
+        available = available.index
+
     splitter = DatetimeIndexSplitter(
         schedule,
         before=before,
@@ -121,6 +130,7 @@ def plot(
         expand_limits=expand_limits,
         ignore_filters=ignore_filters,
     )
+
     plot_data = _get_plot_data(available, splitter, row_count_bin=row_count_bin, show_removed=show_removed)
 
     if bar_labels is True:
@@ -249,7 +259,7 @@ def _add_bar_labels(
             unit=unit_or_labels,
         )
 
-    for bar, label in zip(ax.containers, labels):
+    for bar, label in zip(ax.containers, labels, strict=True):
         ax.bar_label(bar, labels=[label], **kwargs)  # type: ignore[arg-type]
 
 

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_frontend/_progress.py

@@ -6,8 +6,7 @@ from typing import Any, Generic
 
 import pandas as pd
 from rics.collections.dicts import flatten_dict
-
-from time_split._compat import fmt_sec
+from rics.strings import format_seconds as fmt_sec
 
 from ..settings import log_split_progress as settings
 from ..types import DatetimeSplitBounds, FormatMetrics, GetMetrics, LoggerArg, MetricsType, SplitProgressExtras
@@ -122,7 +121,7 @@ class _ProgressTracker(Generic[MetricsType]):
         n_splits = len(splits)
 
         for n, split in enumerate(splits, start=1):
-            default_extras = SplitProgressExtras(
+            default_extras = SplitProgressExtras[MetricsType](
                 n=n,
                 n_splits=n_splits,
                 start=split.start.isoformat(),

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_frontend/_to_string.py

@@ -1,18 +1,19 @@
+import datetime
 from typing import Any, Literal, overload
 
 from pandas import Timestamp
+from rics.strings import format_seconds as fmt_sec
 
 from .._backend._limits import LimitsTuple
-from .._compat import fmt_sec
 from ..settings import log_split_progress
 from ..types import DatetimeSplitBounds, DatetimeTypes, ExpandLimits
 
 
 @overload
 def to_string(
-    bounds: DatetimeTypes,
-    __ignored0: DatetimeTypes,
-    __ignored1: DatetimeTypes,
+    bounds: DatetimeSplitBounds | tuple[DatetimeTypes, DatetimeTypes, DatetimeTypes],
+    __ignored0: Literal[None] = None,
+    __ignored1: Literal[None] = None,
     /,
     *,
     format: str | None = None,
@@ -21,9 +22,9 @@ def to_string(
 
 @overload
 def to_string(
-    start: tuple[DatetimeTypes, DatetimeTypes, DatetimeTypes],
-    mid: Literal[None] = None,
-    end: Literal[None] = None,
+    start: DatetimeTypes,
+    mid: DatetimeTypes,
+    end: DatetimeTypes,
     /,
     *,
     format: str | None = None,
@@ -31,7 +32,7 @@ def to_string(
 
 
 def to_string(
-    bounds: DatetimeTypes | DatetimeSplitBounds | tuple[DatetimeTypes, DatetimeTypes, DatetimeTypes],
+    start_or_bounds: DatetimeTypes | DatetimeSplitBounds | tuple[DatetimeTypes, DatetimeTypes, DatetimeTypes],
     mid: DatetimeTypes | None = None,
     end: DatetimeTypes | None = None,
     /,
@@ -40,15 +41,10 @@ def to_string(
 ) -> str:
     """Pretty-print a fold.
 
-    .. code-block:: python
-       :caption: Sample output.
-
-       ('2021-12-30' <= [schedule: '2022-01-04' (Tuesday)] < '2022-01-04 18:00:00')
-
     Args:
-        bounds: A fold tuple ``(start, mid, end)``, or just `start` (followed by `mid` and `end`).
-        mid: Datetime-like. Must be ``None`` when `bounds` is a tuple.
-        end: Datetime-like. Must be ``None`` when `bounds` is a tuple.
+        start_or_bounds: A fold tuple ``(start, mid, end)``, or just `start` (followed by `mid` and `end`).
+        mid: Datetime-like. Must be ``None`` when `start_or_bounds` is a tuple.
+        end: Datetime-like. Must be ``None`` when `start_or_bounds` is a tuple.
         format: A custom format to use. Use :attr:`~.settings.log_split_progress.FOLD_FORMAT` if ``None``, but note that
             only the `start`, `mid` and `end` keys are available to this function.
 
@@ -58,20 +54,41 @@ def to_string(
     Raises:
         TypeError: If an incorrect number of timestamps are given.
 
+    Examples:
+        Sample format output.
+
+        >>> to_string("2021-12-30", "2022-01-04", "2022-01-04 18:00:00")
+        "'2021-12-30' <= [schedule: '2022-01-04' (Tuesday)] < '2022-01-04 18:00:00'"
+
+        The :attr:`default format <.log_split_progress.FOLD_FORMAT>` was used above.
+
+        Using properties. The `delta` is the distance from `mid` formatted by
+        :func:`~rics.strings.format_seconds`. The `date` property returns a :class:`datetime.date` object.
+
+        >>> to_string(
+        ...     ("2021-12-30", "2022-01-04", "2022-01-04 18:00:00"),
+        ...     format="'{start.date}' [-{start.delta}] <= '{mid.iso}' < [+{end.delta}]",
+        ... )
+        "'2021-12-30' [-5d] <= '2022-01-04T00:00:00' < [+18h]"
+
+        The delta is always positive; you must add the sign yourself.
     """
-    if isinstance(bounds, tuple):
+    if isinstance(start_or_bounds, tuple):
         if not (mid is None and end is None):
-            raise TypeError(f"Too many arguments: {(bounds, mid, end)}.")
-        start, mid, end = bounds
+            raise TypeError(f"Too many arguments: {(start_or_bounds, mid, end)}.")
+        start, mid, end = start_or_bounds
     else:
         if mid is None or end is None:
-            raise TypeError(f"Too few arguments: {(bounds, mid, end)}.")
-        start = bounds
+            raise TypeError(f"Too few arguments: {(start_or_bounds, mid, end)}.")
+        start = start_or_bounds
+
+    if format is None:
+        format = log_split_progress.FOLD_FORMAT
 
-    return (log_split_progress.FOLD_FORMAT if format is None else format).format(
-        start=_PrettyTimestamp(start),
-        mid=_PrettyTimestamp(mid),
-        end=_PrettyTimestamp(end),
+    return format.format(
+        start=_PrettyTimestamp(start, mid),
+        mid=_PrettyTimestamp(mid, mid),
+        end=_PrettyTimestamp(end, mid),
     )
 
 
@@ -95,9 +112,11 @@ def stringify(old: Timestamp, *, new: Timestamp | None = None, diff_only: bool =
 
 
 class _PrettyTimestamp:
-    def __init__(self, raw: DatetimeTypes) -> None:
+    def __init__(self, raw: DatetimeTypes, anchor: DatetimeTypes | None = None) -> None:
         self.timestamp = Timestamp(raw)
+        self._anchor = None if anchor is None else Timestamp(anchor)
         self._auto: str | None = None
+        self._delta: str | None = None
 
     def __getattr__(self, name: str) -> Any:
         return getattr(self.timestamp, name)
@@ -123,6 +142,25 @@ class _PrettyTimestamp:
             self._auto = format(timestamp, format_spec)
         return self._auto
 
+    @property
+    def delta(self) -> str:
+        if self._anchor is None:
+            raise ValueError("Delta requires an anchor.")
+
+        if self._delta is None:
+            seconds = (self.timestamp - self._anchor).round("s").total_seconds()
+            self._delta = fmt_sec(abs(seconds))
+
+        return self._delta
+
+    @property
+    def iso(self) -> str:
+        return self.timestamp.isoformat()  # type: ignore[no-any-return]
+
+    @property
+    def date(self) -> datetime.date:
+        return self.timestamp.date()  # type: ignore[no-any-return]
+
 
 def format_expanded_limits(
     original: LimitsTuple,

time_split-0.7.0/src/time_split/app/__init__.py

@@ -0,0 +1,11 @@
+"""Supporting functions for the Streamlit companion app.
+
+The app may be installed by running ``pip install time-split[app]``. The application API is *not* stable, but will be
+available under the ``time_split_app`` namespace. Repo: https://github.com/rsundqvist/time-split-app/.
+"""
+
+from ._create_explorer_link import create_explorer_link
+
+__all__ = [
+    "create_explorer_link",
+]

{time_split-0.6.0/src/time_split/support → time_split-0.7.0/src/time_split/app}/_create_explorer_link.py

@@ -1,3 +1,4 @@
+from base64 import b16encode as encode_binary_data
 from datetime import datetime
 from typing import Any, Unpack
 from urllib.parse import ParseResult, urlencode, urlparse, urlunparse
@@ -10,20 +11,21 @@ from ..types import DatetimeIndexSplitterKwargs, DatetimeIterable
 @docs
 def create_explorer_link(
     host: str,
-    data: DatetimeIterable | str | None = None,
-    available: DatetimeIterable | str | None = None,
+    data: DatetimeIterable | str | bytes | None = None,
+    available: DatetimeIterable | str | bytes | None = None,
     *,
     show_removed: bool = True,
     skip_default: bool = False,
     **kwargs: Unpack[DatetimeIndexSplitterKwargs],
 ) -> str:
-    """Create a `Time Fold Explorer` application URL.
+    """Create an application URL.
 
     Args:
         host: Base address where the application is hosted.
         data: {available} Regular `available` arguments (as passed to e.g. :func:`time_split.split`) are encoded as
-            a date range to generate dummy data for. Pass a ``str`` to use dataset bundled by the server instead. Note
-            that this function cannot verify the `kwargs` if `available` is a ``str`` dataset.
+            a date range to generate dummy data for.
+            Pass a ``str`` to use a bundled dataset, or ``bytes`` to use a custom loader. Note that this will disable
+            verification of the `**kwargs`.
         available: Alias of `data`.
         skip_default: If ``True``, do not include default split params in the link.
         show_removed: {show_removed}
@@ -54,19 +56,20 @@ def create_explorer_link(
                    :target: https://hub.docker.com/r/rsundqvist/time-split/
                    :alt: Docker Image Size (tag)
     """
-    if sum([data is None, available is None]) != 1:
-        raise ValueError("Exactly one of `data` and `available` must be given.")
     if data is None:
+        if available is None:
+            raise ValueError("Exactly one of `data` and `available` must be given.")
         data = available
+    elif data is not None and available is not None:
+        raise ValueError("Exactly one of `data` and `available` must be given.")
 
-    assert data is not None  # noqa: S101
     pr = _create_explorer_link(host, data, show_removed=show_removed, skip_default=skip_default, **kwargs)
     return urlunparse(pr)
 
 
 def _create_explorer_link(
     host: str,
-    data: DatetimeIterable | str,
+    data: DatetimeIterable | str | bytes,
     *,
     show_removed: bool = True,
     skip_default: bool = False,
@@ -81,7 +84,7 @@ def _create_explorer_link(
 
 
 def _create_query(
-    data: DatetimeIterable | str,
+    data: DatetimeIterable | str | bytes,
     *,
     skip_default: bool,
     show_removed: bool,
@@ -89,6 +92,9 @@ def _create_query(
 ) -> dict[str, Any]:
     query: dict[str, Any] = {}
 
+    if isinstance(data, bytes):
+        data = "0x" + encode_binary_data(data).decode()
+
     if isinstance(data, str):
         query = {"data": data, **kwargs}
     else:

time_split-0.7.0/src/time_split/cli.py

@@ -0,0 +1,29 @@
+"""CLI entrypoint.
+
+Use ``python -m time_split --help`` to get started.
+"""
+
+try:
+    import click as _c
+    from rics.click import _alias_command_group
+    from time_split_app.cli import main as _app_main
+except ImportError as e:
+    name = "time-split[app]"
+    exc = ImportError(f"Install `{name}` to use.", name=name)
+    exc.add_note(f"Package `{e.name}` not installed. Run:\n `pip install {name}`\nto use the CLI entrypoint.")
+    raise exc from e
+
+
+@_c.group(
+    name="time-split",
+    epilog="Visit https://time-split.readthedocs.io/ for help.",
+    cls=_alias_command_group.AliasedCommandGroup,
+)
+def main() -> None:
+    """See https://time-split.readthedocs.io/."""
+
+
+main.add_command(_app_main)
+
+if __name__ == "__main__":
+    main()

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/settings.py

@@ -177,3 +177,33 @@ class misc:  # noqa: N801
 
     filter: _t.Callable[[_pd.Timestamp, _pd.Timestamp, _pd.Timestamp], bool] | None = None
     """A callable ``(start, mid, end) -> bool`` applied to all generated folds."""
+
+    round_limits: bool = False
+    """If ``True``, use rounding instead of ``floor`` and ``ceil`` for limits expansion.
+
+    Normally, limits such as
+
+    >>> ('2019-04-10 23:55:00', '2019-05-12 01:00:00')
+
+    will never be rounded to
+
+    >>> ('2019-04-11', '2019-05-12')
+
+    since that wouldn't be an expansion of the limits. Setting ``round_limits=True`` will allow the
+    :func:`~time_split.support.expand_limits` function round these bounds inward to the nearest dates.
+    """
+
+
+def no_init(self: object) -> None:
+    """Prevents initialization of config classes."""
+    raise TypeError(
+        f"Class '{__package__}.{type(self).__name__}' is used as a public"
+        f" namespace. There is no need to instantiate this class."
+    )
+
+
+for cls in auto_expand_limits, plot, log_split_progress, misc:
+    cls.__init__ = no_init  # type: ignore[method-assign]
+
+del cls
+del no_init

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/support/__init__.py

@@ -13,15 +13,13 @@ dependencies if you need to use the ``support`` module.
 
 from .._backend import DatetimeIndexSplitter, expand_limits, process_available
 from .._frontend import default_metrics_formatter, fold_weight, format_expanded_limits, to_string
-from ._create_explorer_link import create_explorer_link
 
 __all__ = [
     "DatetimeIndexSplitter",
-    "expand_limits",
-    "process_available",
     "default_metrics_formatter",
+    "expand_limits",
     "fold_weight",
-    "to_string",
     "format_expanded_limits",
-    "create_explorer_link",
+    "process_available",
+    "to_string",
 ]

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/types.py

@@ -86,7 +86,7 @@ class LogSplitProgressKwargs(_t.TypedDict, _t.Generic[MetricsType], total=False)
     get_metrics: GetMetrics[MetricsType]
 
 
-class SplitProgressExtras(_t.TypedDict):
+class SplitProgressExtras(_t.TypedDict, _t.Generic[MetricsType]):
     """Named `extras` used for messages logged by :func:`.log_split_progress`."""
 
     n: int
@@ -101,3 +101,5 @@ class SplitProgressExtras(_t.TypedDict):
     """An :meth:`ISO-formatted <pandas.Timestamp.isoformat>` timestamp (see :attr:`.DatetimeSplitBounds.end`)."""
     seconds: _t.NotRequired[float]
     """User time for the fold. Available only for the :attr:`fold-end message <.settings.log_split_progress.END_MESSAGE>`."""
+    metrics: _t.NotRequired[MetricsType]
+    """Optional fold metrics. Typically appended to the :attr:`fold-end message <.settings.log_split_progress.END_MESSAGE>`."""

time_split-0.6.0/src/time_split/_compat.py

@@ -1,49 +0,0 @@
-"""Vendored functions."""
-
-from functools import wraps
-from typing import Callable, ParamSpec, TypeVar
-from warnings import warn
-
-from rics.misc import tname
-
-try:
-    from rics import strings
-
-    fmt_perf = strings.format_perf_counter
-    fmt_sec = strings.format_seconds
-except ImportError:
-    from rics import performance
-
-    # TODO(0.5.0): Drop this.
-    fmt_perf = performance.format_perf_counter
-    fmt_sec = performance.format_seconds
-
-P = ParamSpec("P")
-T = TypeVar("T")
-
-PARAMS = (("expand_limits", "flex"),)
-WARNED: set[str] = set()  # Minimize the amount of warnings - once per param is enough.
-
-
-def deprecated_params(__func: Callable[P, T], /) -> Callable[P, T]:
-    @wraps(__func)
-    def wrap(*args: P.args, **kwargs: P.kwargs) -> T:
-        for new, old in PARAMS:
-            if old in kwargs:
-                if new in kwargs:
-                    name = tname(__func, prefix_classname=True)
-                    msg = f"Ambiguous call: {name}() does not accept both `{old}` and `{new}`."
-                    raise TypeError(msg)
-
-                if old not in WARNED:
-                    WARNED.add(old)
-
-                    name = tname(__func, prefix_classname=True)
-                    msg = f"{name}(): The `{old}` parameter is deprecated; use `{new}` instead."
-                    warn(message=msg, category=DeprecationWarning, stacklevel=2)
-
-                kwargs[new] = kwargs.pop(old)
-
-        return __func(*args, **kwargs)
-
-    return wrap

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_backend/__init__.py

@@ -7,6 +7,6 @@ __all__ = [
     "DatetimeIndexLike",
     "DatetimeIndexSplitter",
     "ProcessAvailableResult",
-    "process_available",
     "expand_limits",
+    "process_available",
 ]

{time_split-0.6.0 → time_split-0.7.0}/src/time_split/_frontend/__init__.py

@@ -5,11 +5,11 @@ from ._to_string import format_expanded_limits, to_string
 from ._weight import fold_weight
 
 __all__ = [
+    "default_metrics_formatter",
     "fold_weight",
+    "format_expanded_limits",
     "log_split_progress",
-    "default_metrics_formatter",
     "plot",
     "split",
     "to_string",
-    "format_expanded_limits",
 ]