rics 6.2.0__tar.gz → 6.2.2__tar.gz

{rics-6.2.0 → rics-6.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rics
-Version: 6.2.0
+Version: 6.2.2
 Summary: My personal Python toolbox.
 Keywords: rics
 Author: Richard Sundqvist

rics-6.2.2/pyproject.toml

@@ -0,0 +1,197 @@
+[project]
+name = "rics"
+version = "6.2.2"
+description = "My personal Python toolbox."
+readme = "README.md"
+keywords = ["rics"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS",
+    "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",
+    "Programming Language :: Python :: 3.14",
+]
+requires-python = ">=3.11"
+dependencies = []
+
+[[project.authors]]
+name = "Richard Sundqvist"
+email = "richard.sundqvist@live.se"
+
+[project.license]
+text = "MIT"
+
+[project.optional-dependencies]
+cli = [
+    "click      >= 8.1.0",
+    "pandas     >= 2.0.3",
+    "requests   >= 2.30.0",
+    "ipykernel  >= 6.29.3",
+]
+plotting = [
+    "matplotlib",
+    "seaborn",
+]
+
+[project.urls]
+homepage = "https://github.com/rsundqvist/rics"
+repository = "https://github.com/rsundqvist/rics"
+documentation = "https://rics.readthedocs.io"
+"Bug Tracker" = "https://github.com/rsundqvist/rics/issues"
+Changelog = "https://github.com/rsundqvist/rics/blob/master/CHANGELOG.md"
+
+[project.scripts]
+mtimeit = "rics.performance.cli:main"
+rics = "rics.cli:main"
+
+[project.entry-points."rics.cli"]
+repos = "rics._cli_repos:main"
+timeit = "rics.performance.cli:main"
+kernel = "rics.jupyter.cli:main"
+
+[dependency-groups]
+manual-extras = []
+docs = [
+    "sphinx~=9.1.0 ; python_version >= '3.12'",
+    "pydata-sphinx-theme~=0.23.0 ; python_version >= '3.12'",
+    "myst-parser~=5.1.0 ; python_version >= '3.12'",
+    "nbsphinx~=0.9.8 ; python_version >= '3.12'",
+    "nbformat~=5.11.1 ; python_version >= '3.12'",
+    "ipython~=9.17.1 ; python_version >= '3.12'",
+    "sphinx-llm~=1.0.0 ; python_version >= '3.12'",
+]
+notebooks = [
+    "jupyterlab~=4.6.4",
+    "ipywidgets",
+    "jupyterlab-execute-time",
+    "tqdm",
+]
+test = [
+    "pytest~=9.1.1",
+    "xdoctest~=1.3.2",
+    "coverage~=7.16.2",
+    "pytest-cov~=7.1.0",
+    "responses~=0.26.3",
+    "poetry~=2.5.1",
+]
+devops = [
+    "nox~=2026.8.17",
+    "invoke~=3.0.3",
+    "mypy~=2.4.0",
+    "ruff~=0.17.1",
+    "codespell~=2.4.3",
+    "bump2version==1.0.1",
+]
+types = [
+    "types-colorama",
+    "types-decorator",
+    "types-docutils",
+    "types-jsonschema",
+    "types-pexpect",
+    "types-pycurl",
+    "types-pygments",
+    "types-pytz",
+    "types-pyyaml",
+    "types-requests",
+]
+
+[tool.uv]
+default-groups = "all"
+
+[tool.ruff]
+line-length = 120
+fix = true
+unsafe-fixes = false
+output-format = "grouped"
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = 80
+line-ending = "lf"
+
+[tool.ruff.lint]
+exclude = ["notebooks/*"]
+select = [
+    "ANN",
+    "S",
+    "I",
+    "B",
+    "D",
+    "F",
+    "W",
+    "E",
+    "SLOT",
+    "SIM",
+    "TID",
+    "TD",
+    "TCH",
+    "ARG",
+    "PTH",
+    "NPY",
+    "PD",
+    "N",
+    "PERF",
+    "PLC",
+    "PLE",
+    "PLR",
+    "PLW",
+    "UP",
+    "FURB",
+    "RUF",
+    "TRY",
+]
+ignore = [
+    "D105",
+    "D107",
+    "ANN401",
+    "TID252",
+    "TRY003",
+    "PLC0415",
+    "PLR0913",
+    "PLR0917",
+    "SIM108",
+    "TD003",
+    "TC006",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    "D",
+    "S101",
+    "ANN",
+    "PLR2004",
+    "S",
+]
+"examples/*" = [
+    "D205",
+    "B007",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 150
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "error",
+    "ignore:FigureCanvasAgg is non-interactive:UserWarning",
+]
+log_file_level = 10
+log_file = "pytest.log"
+norecursedirs = ["**/cli_modules/*"]
+
+[build-system]
+requires = ["uv_build>=0.13.0,<0.14.0"]
+build-backend = "uv_build"

rics-6.2.0/pyproject.toml → rics-6.2.2/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "rics"
-version = "6.2.0"
+version = "6.2.2"
 description = "My personal Python toolbox."
 authors = [
     { name = "Richard Sundqvist", email = "richard.sundqvist@live.se" },
@@ -65,32 +65,33 @@ manual-extras = [
 ]
 docs = [
     "sphinx~=9.1.0 ; python_version >= '3.12'",
-    "pydata-sphinx-theme~=0.18.0 ; python_version >= '3.12'",
+    "pydata-sphinx-theme~=0.23.0 ; python_version >= '3.12'",
     "myst-parser~=5.1.0 ; python_version >= '3.12'", # https://github.com/executablebooks/MyST-Parser/issues/749
     "nbsphinx~=0.9.8 ; python_version >= '3.12'",
-    "ipython~=9.14.1 ; python_version >= '3.12'",
-    "sphinx-llm~=0.4.1 ; python_version >= '3.12'",
+    "nbformat~=5.11.1 ; python_version >= '3.12'",
+    "ipython~=9.17.1 ; python_version >= '3.12'",
+    "sphinx-llm~=1.0.0 ; python_version >= '3.12'", # 1.1.0 warns "unknown node type" on nbsphinx nodes, failing -W
 ]
 notebooks = [
-    "jupyterlab~=4.5.8",
+    "jupyterlab~=4.6.4",
     "ipywidgets",
     "jupyterlab-execute-time",
     "tqdm",
 ]
 test = [
-    "pytest~=9.1.0",
+    "pytest~=9.1.1",
     "xdoctest~=1.3.2",
-    "coverage~=7.14.1",
+    "coverage~=7.16.2",
     "pytest-cov~=7.1.0",
-    "responses~=0.26.1",
-    "poetry~=2.4.1",
+    "responses~=0.26.3",
+    "poetry~=2.5.1",
 ]
 devops = [
-    "nox~=2026.4.10",
+    "nox~=2026.8.17",
     "invoke~=3.0.3",
-    "mypy~=2.1.0",
-    "ruff~=0.15.17",
-    "codespell~=2.4.2",
+    "mypy~=2.4.0",
+    "ruff~=0.17.1",
+    "codespell~=2.4.3",
     "bump2version==1.0.1",
 ]
 types = [
@@ -159,6 +160,7 @@ ignore = [
     "TRY003",
     "PLC0415", # `import` should be at the top-level of a file
     "PLR0913", #
+    "PLR0917", # Too many positional arguments
     "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()`
@@ -193,5 +195,5 @@ norecursedirs = [
 ]
 
 [build-system]
-requires = ["uv_build>=0.11.0,<0.12.0"]
+requires = ["uv_build>=0.13.0,<0.14.0"]
 build-backend = "uv_build"

{rics-6.2.0 → rics-6.2.2}/src/rics/__init__.py

@@ -19,6 +19,6 @@ __all__ = [
     "configure_stuff",
 ]
 
-__version__ = "6.2.0"
+__version__ = "6.2.2"
 
 _logging.getLogger(__name__).addHandler(_logging.NullHandler())

rics-6.2.2/src/rics/__main__.py

@@ -0,0 +1,8 @@
+"""Alias of :mod:`rics.cli`."""
+
+from .cli import main
+
+# The docs prefer no guard, but only so a zipapp root behaves the same. Without one, tools that import every submodule
+# (e.g. Sphinx autosummary) run the CLI with their own argv.
+if __name__ == "__main__":
+    main()

{rics-6.2.0 → rics-6.2.2}/src/rics/_internal_support/_local_or_remote.py

@@ -107,7 +107,10 @@ def _fetch(local_file_path: Path, remote_file_path: str, show_progress: bool) ->
 
     _GLOR_LOGGER.info(f"Fetching data from '{remote_file_path}'..")
     response = requests.get(remote_file_path, stream=True, timeout=300)
+    response.raise_for_status()
     chunks = response.iter_content(_CHUNK_SIZE)
+    # TODO(6.3.0): A download that fails midway leaves a partial file, which later calls serve as cached. Write to a
+    #  temporary file and rename it on success.
     with local_file_path.open("wb") as output_file:
         if show_progress:
             total = response.headers.get("Content-Length")

rics-6.2.2/src/rics/_internal_support/notebooks.py

@@ -0,0 +1,34 @@
+import shutil
+from pathlib import Path
+
+
+def copy_notebooks(source: str | Path, destination: str | Path, *, clean: bool = True) -> None:
+    """Copy the `source` directory to `destination`, optionally stripping notebook metadata in the copy.
+
+    Args:
+        source: Directory to copy.
+        destination: Target directory; existing files are overwritten.
+        clean: If ``True``, call :func:`strip_metadata` on every ``.ipynb`` file in `destination` after copying.
+    """
+    shutil.copytree(source, destination, dirs_exist_ok=True)
+    if clean:
+        for path in Path(destination).rglob("*.ipynb"):
+            strip_metadata(path)
+
+
+def strip_metadata(path: str | Path) -> None:
+    """Strip volatile cell metadata from the notebook at `path`, in place.
+
+    Removes the ``execution`` timing metadata.
+
+    Args:
+        path: Path to an ``.ipynb`` file.
+    """
+    import nbformat
+
+    notebook = nbformat.read(path, as_version=nbformat.NO_CONVERT)
+
+    for cell in notebook.cells:
+        cell.metadata.pop("execution", None)
+
+    nbformat.write(notebook, path)

rics-6.2.2/src/rics/_pytest_fixtures.py

@@ -0,0 +1,70 @@
+"""Pytest fixtures, loaded through ``pytest_plugins``.
+
+Imports ``pytest`` at module scope since fixtures need the decorator; never import this module from ``rics`` itself.
+"""
+
+import logging
+import sys
+from collections.abc import Callable, Iterator
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import pytest
+
+if TYPE_CHECKING:
+    from types import ModuleType
+
+
+@pytest.fixture
+def tmp_path_cwd(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
+    """Run the test with `tmp_path` as the working directory."""
+    monkeypatch.chdir(tmp_path)
+    return tmp_path
+
+
+@pytest.fixture
+def restore_logging() -> Iterator[None]:
+    """Restore the level, handlers, ``propagate`` and ``disabled`` of every logger after the test.
+
+    Loggers created during the test are reset to the state of a new logger. Handlers are re-attached as-is; one that
+    the test closed (e.g. through ``logging.basicConfig(force=True)``) stays closed.
+    """
+
+    def loggers() -> Iterator[logging.Logger]:
+        yield logging.root
+        yield from (lg for lg in logging.Logger.manager.loggerDict.values() if isinstance(lg, logging.Logger))
+
+    snapshot = {lg: (lg.level, lg.propagate, lg.disabled, list(lg.handlers)) for lg in loggers()}
+    disable = logging.root.manager.disable
+
+    yield
+
+    logging.disable(disable)
+    for lg in loggers():
+        level, lg.propagate, lg.disabled, lg.handlers[:] = snapshot.get(lg, (logging.NOTSET, True, False, []))
+        lg.setLevel(level)  # Clears the isEnabledFor-cache, unlike assigning `level` directly.
+
+
+@pytest.fixture
+def unload_modules() -> Iterator[Callable[..., None]]:
+    """Unload modules so that the test imports them anew; restore the original ``sys.modules`` entries afterwards.
+
+    Call the returned function with module names; each name covers its submodules as well. Modules first imported
+    during the test are unloaded again at teardown.
+    """
+    names: list[str] = []
+    snapshot: dict[str, ModuleType] = {}
+
+    def matching() -> list[str]:
+        return [m for m in sys.modules if any(m == name or m.startswith(f"{name}.") for name in names)]
+
+    def unload(*modules: str) -> None:
+        names.extend(modules)
+        for m in matching():
+            snapshot.setdefault(m, sys.modules.pop(m))
+
+    yield unload
+
+    for m in matching():
+        del sys.modules[m]
+    sys.modules.update(snapshot)

{rics-6.2.0 → rics-6.2.2}/src/rics/click/_util.py

@@ -9,7 +9,7 @@ def get_user_command(cxt: click.Context | None = None, *, meta: bool = True) ->
     """Recreate the user CLI command.
 
     Args:
-        cxt: Click context. Derive is ``None``.
+        cxt: Click context. Derive if ``None``.
         meta: If ``True``, use :attr:`click.Context.meta` caching.
 
     Returns:

{rics-6.2.0 → rics-6.2.2}/src/rics/collections/dicts.py

@@ -289,7 +289,7 @@ class InheritedKeysDict(_t.Mapping[OKT, dict[KT, VT]]):  # noqa: PLW1641
                 }
             }
 
-        No other top-level keys are accepted, but neither `default` nor `context-specific` are required.
+        No other top-level keys are accepted, but neither `default` nor `specific` are required.
 
         Args:
             arg: Input to make an instance from.
@@ -298,12 +298,13 @@ class InheritedKeysDict(_t.Mapping[OKT, dict[KT, VT]]):  # noqa: PLW1641
             A new instance.
 
         Raises:
-            ValueError: If there are any keys other than 'default' and 'context-specific' present in `mapping`.
+            ValueError: If there are any keys other than 'default' and 'specific' present in `arg`.
 
         """
         if isinstance(arg, InheritedKeysDict):  # pragma: no cover
             return arg
 
+        arg = arg.copy()
         default: dict[KT, VT] | None = arg.pop("default", None)
         specific: dict[OKT, dict[KT, VT]] | None = arg.pop("specific", None)
 
@@ -373,7 +374,7 @@ def format_changed_keys(
         'added(1): {-1: None}, removed(1): {2}'
 
     Notes:
-        This is a convenience function that warps :func:`DictComparer.to_string`.
+        This is a convenience function that wraps :func:`DictComparer.to_string`.
     """
     return DictComparer(mapping, baseline=baseline).to_string(added=added, updated=updated, removed=removed)
 

{rics-6.2.0 → rics-6.2.2}/src/rics/env/interpolation/__init__.py

@@ -12,13 +12,12 @@ Default values:
     Default values are specified by stating the default value after a colon; ``${<var>:default-value}``. The default
     value may be blank, in which case an empty string is used as the default.
 
-There are three main ways of using this module:
+There are two main ways of using this module:
 
     * The :meth:`.Variable.parse_string`-function, combined with :meth:`.Variable.get_value`. This gives you the most
       amount of control.
-    * The :func:`replace_in_string`-function, for basic interpolation without recursion in an entire string.
-    * The :func:`rics.misc.interpolate_environment_variables`-function, which adds some additional logic on top of what
-      the :class:`Variable`-methods provide.
+    * The :func:`replace_in_string`-function, for interpolation in an entire string. Unlike
+      :meth:`.Variable.get_value`, it resolves nested defaults by default; ``allow_nested=False`` raises on them.
 
 Examples:
     We'll set ``ENV_VAR0=VALUE0`` and ``ENV_VAR1=VALUE1``. Vars 2 and 4 are not set.

{rics-6.2.0 → rics-6.2.2}/src/rics/jupyter/_kernel_helper.py

@@ -84,7 +84,7 @@ class KernelHelper:
         try:
             from ipykernel.kernelspec import install
         except ModuleNotFoundError as e:
-            msg = "Package `ipykernel` not installed. Run of one:\n  pip install ipykernel\n  pip install rics[cli]\nto use this feature."
+            msg = "Package `ipykernel` not installed. Run one of:\n  pip install ipykernel\n  pip install rics[cli]\nto use this feature."
             raise RuntimeError(msg) from e
 
         logger = self.logger

{rics-6.2.0 → rics-6.2.2}/src/rics/jupyter/_venv_helper.py

@@ -109,13 +109,15 @@ class Resolve:
         if not _check_files(cwd, "uv", logger):
             return None
 
-        paths = _print_paths(logger, "uv", "run")
+        # --project pins resolution to `cwd`; without it, `uv run <script>` resolves the project from the
+        # script's own location once the script lives outside `cwd` (as `_print_paths.py` always does).
+        paths = _print_paths(logger, "uv", "run", "--project", str(cwd))
 
         if paths is None:
             return None
 
         logger.debug("Ensure pip in uv venv.")  # Not installed unless --seed/UV_VENV_SEED=pip is used.
-        _get_output(logger, "uv", "pip", "install", "--no-upgrade", "--quiet", "pip")
+        _get_output(logger, "uv", "pip", "install", "--project", str(cwd), "--no-upgrade", "--quiet", "pip")
 
         return paths
 

{rics-6.2.0 → rics-6.2.2}/src/rics/logs.py

@@ -201,7 +201,7 @@ class LoggingSetupHelper:
 
         >>> [{"id_translation": "DEBUG"}, {"id_translation": "INFO"}]
 
-        are **not** permitted, since going from ``verbosity=1`` to ``verbosity=2`` would reduce the amount of legts
+        are **not** permitted, since going from ``verbosity=1`` to ``verbosity=2`` would reduce the amount of logs
         emitted. Calling :meth:`LoggingSetupHelper.configure_logging` with ``verbosity=0`` disables logging entirely.
 
     Args:
@@ -239,13 +239,13 @@ class LoggingSetupHelper:
         """Get log levels per logger at the given `verbosity` level.
 
         Args:
-            verbosity: Verbosity level. Pass -1 for max level.
+            verbosity: Verbosity level. Pass -1 for max level; levels above the max are treated as the max.
 
         Returns:
             A dict ``{logger: log_level}``
 
         Raises:
-            ValueError: If `verbose` is zero, less than -1, or too high.
+            ValueError: If `verbosity` is zero or less than -1.
         """
         max_level = -1
         if verbosity in {max_level, self.max}:
@@ -253,13 +253,10 @@ class LoggingSetupHelper:
         elif verbosity == 0:
             raise ValueError(f"{verbosity=} = 0")
         elif verbosity < max_level:
-            raise ValueError(f"{verbosity=} < -2")
+            raise ValueError(f"{verbosity=} < -1")
         else:
-            try:
-                levels = self._levels[:verbosity]
-            except IndexError:
-                msg = f"Got {verbosity=}, but only {self.max} levels are defined."
-                raise ValueError(msg) from None
+            # TODO(6.3.0): Emit a DeprecationWarning for verbosity > self.max; raise in 7.0.0.
+            levels = self._levels[:verbosity]
 
         rv: dict[str, int] = {}
         for level_dict in reversed(levels):
@@ -444,17 +441,21 @@ def get_logger(logger: AnyLoggerAdapter) -> AnyLoggerAdapter: ...
 def get_logger(logger: LoggerArg | AnyLoggerAdapter) -> _l.Logger | AnyLoggerAdapter:
     """Get a logger.
 
-    Returns a :attr:`~logging.Logger.disabled` logger if `logger` is ``None``. Loggers and adapters are returned as-is.
+    Returns a :attr:`~logging.Logger.disabled` logger if `logger` is ``None`` or ``False``; its child loggers are
+    silenced too. Loggers and adapters are returned as-is.
 
     Args:
-        logger: An adapter, logger, logger name, or ``None``.
+        logger: An adapter, logger, logger name, ``None``, or ``False``.
 
     Returns:
         A logger instance.
     """
-    if logger is None:
+    if logger is None or logger is False:
         logger = _l.getLogger("null")
         logger.disabled = True
+        logger.propagate = False
+        if not logger.handlers:
+            logger.addHandler(_l.NullHandler())
         return logger
 
     if isinstance(logger, str):