dycw-utilities 0.135.0__py3-none-any.whl → 0.178.1__py3-none-any.whl

utilities/pytest.py

@@ -1,63 +1,76 @@
 from __future__ import annotations
 
+from collections.abc import Callable
 from dataclasses import dataclass
-from functools import partial, wraps
-from inspect import iscoroutinefunction
+from functools import partial
 from os import environ
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, assert_never, cast, override
+from re import sub
+from types import FunctionType
+from typing import TYPE_CHECKING, Any, NoReturn, override
 
-from pytest import fixture
-from whenever import ZonedDateTime
-
-from utilities.atomicwrites import writer
 from utilities.functools import cache
-from utilities.git import get_repo_root
 from utilities.hashlib import md5_hash
-from utilities.pathlib import ensure_suffix
-from utilities.platform import (
-    IS_LINUX,
-    IS_MAC,
-    IS_NOT_LINUX,
-    IS_NOT_MAC,
-    IS_NOT_WINDOWS,
-    IS_WINDOWS,
+from utilities.pathlib import (
+    _GetTailEmptyError,
+    ensure_suffix,
+    get_root,
+    get_tail,
+    module_path,
 )
-from utilities.random import get_state
+from utilities.platform import IS_LINUX, IS_MAC, IS_NOT_LINUX, IS_NOT_MAC
+from utilities.throttle import throttle
 from utilities.types import MaybeCoro
-from utilities.whenever import SECOND, get_now_local
+from utilities.whenever import SECOND
 
 if TYPE_CHECKING:
-    from collections.abc import Callable, Iterable, Sequence
-    from random import Random
-
-    from whenever import TimeDelta
+    from collections.abc import Iterable
 
-    from utilities.types import Coro, PathLike
-
-try:  # WARNING: this package cannot use unguarded `pytest` imports
     from _pytest.config import Config
     from _pytest.config.argparsing import Parser
     from _pytest.python import Function
-    from pytest import mark, skip
+
+    from utilities.types import Delta, PathLike
+
+
+IS_CI = "CI" in environ
+IS_CI_AND_NOT_LINUX = IS_CI and IS_NOT_LINUX
+
+
+try:  # WARNING: this package cannot use unguarded `pytest` imports
+    from pytest import mark
 except ModuleNotFoundError:  # pragma: no cover
-    from typing import Any as Config
-    from typing import Any as Function
-    from typing import Any as Parser
 
-    mark = skip = skipif_windows = skipif_mac = skipif_linux = skipif_not_windows = (
-        skipif_not_mac
-    ) = skipif_not_linux = None
+    def skipif_ci[F: Callable](func: F) -> F:
+        return func
+
+    def skipif_mac[F: Callable](func: F) -> F:
+        return func
+
+    def skipif_linux[F: Callable](func: F) -> F:
+        return func
+
+    def skipif_not_mac[F: Callable](func: F) -> F:
+        return func
+
+    def skipif_not_linux[F: Callable](func: F) -> F:
+        return func
+
+    def skipif_ci_and_not_linux[F: Callable](func: F) -> F:
+        return func
+
 else:
-    skipif_windows = mark.skipif(IS_WINDOWS, reason="Skipped for Windows")
+    skipif_ci = mark.skipif(IS_CI, reason="Skipped for CI")
     skipif_mac = mark.skipif(IS_MAC, reason="Skipped for Mac")
     skipif_linux = mark.skipif(IS_LINUX, reason="Skipped for Linux")
-    skipif_not_windows = mark.skipif(IS_NOT_WINDOWS, reason="Skipped for non-Windows")
     skipif_not_mac = mark.skipif(IS_NOT_MAC, reason="Skipped for non-Mac")
     skipif_not_linux = mark.skipif(IS_NOT_LINUX, reason="Skipped for non-Linux")
+    skipif_ci_and_not_linux = mark.skipif(
+        IS_CI_AND_NOT_LINUX, reason="Skipped for CI/non-Linux"
+    )
 
 
-def add_pytest_addoption(parser: Parser, options: Sequence[str], /) -> None:
+def add_pytest_addoption(parser: Parser, options: list[str], /) -> None:
     """Add the `--slow`, etc options to pytest.
 
     Usage:
@@ -78,7 +91,7 @@ def add_pytest_addoption(parser: Parser, options: Sequence[str], /) -> None:
 
 
 def add_pytest_collection_modifyitems(
-    config: Config, items: Iterable[Function], options: Sequence[str], /
+    config: Config, items: Iterable[Function], options: list[str], /
 ) -> None:
     """Add the @mark.skips as necessary.
 
@@ -87,6 +100,8 @@ def add_pytest_collection_modifyitems(
         def pytest_collection_modifyitems(config, items):
             add_pytest_collection_modifyitems(config, items, ["slow"])
     """
+    from pytest import mark
+
     options = list(options)
     missing = {opt for opt in options if not config.getoption(f"--{opt}")}
     for item in items:
@@ -116,26 +131,32 @@ def add_pytest_configure(config: Config, options: Iterable[tuple[str, str]], /)
 ##
 
 
-def is_pytest() -> bool:
-    """Check if `pytest` is running."""
-    return "PYTEST_VERSION" in environ
+def make_ids(obj: Any, /) -> str:
+    if isinstance(obj, FunctionType):  # pragma: no cover
+        return sub(r"\s+at +0x[0-9a-fA-F]+", "", repr(obj))
+    return repr(obj)  # pragma: no cover
 
 
 ##
 
 
-def node_id_to_path(
-    node_id: str, /, *, head: PathLike | None = None, suffix: str | None = None
+def node_id_path(
+    node_id: str, /, *, root: PathLike | None = None, suffix: str | None = None
 ) -> Path:
-    """Map a node ID to a path."""
+    """Get the path of a node ID."""
     path_file, *parts = node_id.split("::")
     path_file = Path(path_file)
     if path_file.suffix != ".py":
-        raise NodeIdToPathError(node_id=node_id)
+        raise _NodeIdToPathNotPythonFileError(node_id=node_id)
     path = path_file.with_suffix("")
-    if head is not None:
-        path = path.relative_to(head)
-    path = Path(".".join(path.parts), "__".join(parts))
+    if root is not None:
+        try:
+            path = get_tail(path, root)
+        except _GetTailEmptyError as error:
+            raise _NodeIdToPathNotGetTailError(
+                node_id=node_id, path=error.path, root=error.root
+            ) from None
+    path = Path(module_path(path), "__".join(parts))
     if suffix is not None:
         path = ensure_suffix(path, suffix)
     return path
@@ -145,138 +166,78 @@ def node_id_to_path(
 class NodeIdToPathError(Exception):
     node_id: str
 
+
+@dataclass(kw_only=True, slots=True)
+class _NodeIdToPathNotPythonFileError(NodeIdToPathError):
     @override
     def __str__(self) -> str:
         return f"Node ID must be a Python file; got {self.node_id!r}"
 
 
-##
-
+@dataclass(kw_only=True, slots=True)
+class _NodeIdToPathNotGetTailError(NodeIdToPathError):
+    path: PathLike
+    root: PathLike
 
-@fixture
-def random_state(*, seed: int) -> Random:
-    """Fixture for a random state."""
-    return get_state(seed=seed)
+    @override
+    def __str__(self) -> str:
+        return (
+            f"Unable to get the tail of {str(self.path)!r} with root {str(self.root)!r}"
+        )
 
 
 ##
 
 
-def throttle[F: Callable[..., MaybeCoro[None]]](
-    *, root: PathLike | None = None, delta: TimeDelta = SECOND, on_try: bool = False
+def throttle_test[F: Callable[..., MaybeCoro[None]]](
+    *, on_try: bool = False, root: PathLike | None = None, delta: Delta = SECOND
 ) -> Callable[[F], F]:
     """Throttle a test. On success by default, on try otherwise."""
-    return cast("Any", partial(_throttle_inner, root=root, delta=delta, on_try=on_try))
-
+    return throttle(
+        on_try=on_try,
+        delta=delta,
+        path=partial(_get_test_path, root=root),
+        raiser=_run_skip,
+    )
 
-def _throttle_inner[F: Callable[..., MaybeCoro[None]]](
-    func: F,
-    /,
-    *,
-    root: PathLike | None = None,
-    delta: TimeDelta = SECOND,
-    on_try: bool = False,
-) -> F:
-    """Throttle a test function/method."""
-    match bool(iscoroutinefunction(func)), on_try:
-        case False, False:
 
-            @wraps(func)
-            def throttle_sync_on_pass(*args: Any, **kwargs: Any) -> None:
-                _skipif_recent(root=root, delta=delta)
-                cast("Callable[..., None]", func)(*args, **kwargs)
-                _write(root=root)
+def _run_skip() -> NoReturn:
+    from pytest import skip
 
-            return cast("Any", throttle_sync_on_pass)
+    skip(reason=f"{_get_name()} throttled")
 
-        case False, True:
 
-            @wraps(func)
-            def throttle_sync_on_try(*args: Any, **kwargs: Any) -> None:
-                _skipif_recent(root=root, delta=delta)
-                _write(root=root)
-                cast("Callable[..., None]", func)(*args, **kwargs)
-
-            return cast("Any", throttle_sync_on_try)
-
-        case True, False:
-
-            @wraps(func)
-            async def throttle_async_on_pass(*args: Any, **kwargs: Any) -> None:
-                _skipif_recent(root=root, delta=delta)
-                await cast("Callable[..., Coro[None]]", func)(*args, **kwargs)
-                _write(root=root)
-
-            return cast("Any", throttle_async_on_pass)
-
-        case True, True:
-
-            @wraps(func)
-            async def throttle_async_on_try(*args: Any, **kwargs: Any) -> None:
-                _skipif_recent(root=root, delta=delta)
-                _write(root=root)
-                await cast("Callable[..., Coro[None]]", func)(*args, **kwargs)
-
-            return cast("Any", throttle_async_on_try)
-
-        case _ as never:
-            assert_never(never)
+def _get_name() -> str:
+    return environ["PYTEST_CURRENT_TEST"]
 
 
-def _skipif_recent(*, root: PathLike | None = None, delta: TimeDelta = SECOND) -> None:
-    if skip is None:
-        return  # pragma: no cover
-    path = _get_path(root=root)
-    try:
-        contents = path.read_text()
-    except FileNotFoundError:
-        return
-    try:
-        last = ZonedDateTime.parse_common_iso(contents)
-    except ValueError:
-        return
-    if (age := (get_now_local() - last)) < delta:
-        _ = skip(reason=f"{_get_name()} throttled (age {age})")
+@cache
+def _md5_hash_cached(text: str, /) -> str:
+    return md5_hash(text)
 
 
-def _get_path(*, root: PathLike | None = None) -> Path:
+def _get_test_path(*, root: PathLike | None = None) -> Path:
     if root is None:
-        root_use = get_repo_root().joinpath(  # pragma: no cover
-            ".pytest_cache", "throttle"
-        )
+        root_use = get_root().joinpath(".pytest_cache", "throttle")  # pragma: no cover
     else:
         root_use = root
     return Path(root_use, _md5_hash_cached(_get_name()))
 
 
-@cache
-def _md5_hash_cached(text: str, /) -> str:
-    return md5_hash(text)
-
-
-def _get_name() -> str:
-    return environ["PYTEST_CURRENT_TEST"]
-
-
-def _write(*, root: PathLike | None = None) -> None:
-    path = _get_path(root=root)
-    with writer(path, overwrite=True) as temp:
-        _ = temp.write_text(get_now_local().format_common_iso())
-
-
 __all__ = [
+    "IS_CI",
+    "IS_CI_AND_NOT_LINUX",
     "NodeIdToPathError",
     "add_pytest_addoption",
     "add_pytest_collection_modifyitems",
     "add_pytest_configure",
-    "is_pytest",
-    "node_id_to_path",
-    "random_state",
+    "make_ids",
+    "node_id_path",
+    "skipif_ci",
+    "skipif_ci_and_not_linux",
     "skipif_linux",
     "skipif_mac",
     "skipif_not_linux",
     "skipif_not_mac",
-    "skipif_not_windows",
-    "skipif_windows",
-    "throttle",
+    "throttle_test",
 ]

utilities/pytest_plugins/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

utilities/pytest_plugins/pytest_randomly.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from random import Random
+
+
+try:
+    from pytest import fixture
+except ModuleNotFoundError:
+    pass
+else:
+
+    @fixture
+    def random_state(*, seed: int) -> Random:
+        """Fixture for a random state."""
+        from utilities.random import get_state
+
+        return get_state(seed)
+
+
+__all__ = ["random_state"]

utilities/pytest_plugins/pytest_regressions.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, cast
+
+if TYPE_CHECKING:
+    from pytest import FixtureRequest
+
+    from utilities.pytest_regressions import (
+        OrjsonRegressionFixture,
+        PolarsRegressionFixture,
+    )
+
+
+try:
+    from pytest import fixture
+except ModuleNotFoundError:
+    pass
+else:
+
+    @fixture
+    def orjson_regression(
+        *, request: FixtureRequest, tmp_path: Path
+    ) -> OrjsonRegressionFixture:
+        """Instance of the `OrjsonRegressionFixture`."""
+        from utilities.pytest_regressions import OrjsonRegressionFixture
+
+        path = _get_path(request)
+        return OrjsonRegressionFixture(path, request, tmp_path)
+
+    @fixture
+    def polars_regression(
+        *, request: FixtureRequest, tmp_path: Path
+    ) -> PolarsRegressionFixture:
+        """Instance of the `PolarsRegressionFixture`."""
+        from utilities.pytest_regressions import PolarsRegressionFixture
+
+        path = _get_path(request)
+        return PolarsRegressionFixture(path, request, tmp_path)
+
+
+def _get_path(request: FixtureRequest, /) -> Path:
+    from utilities.pathlib import get_root
+    from utilities.pytest import _NodeIdToPathNotGetTailError, node_id_path
+
+    path = Path(cast("Any", request).fspath)
+    root = Path("src", "tests")
+    try:
+        tail = node_id_path(request.node.nodeid, root=root)
+    except _NodeIdToPathNotGetTailError:
+        root = Path("tests")
+        tail = node_id_path(request.node.nodeid, root=root)
+    return get_root(path).joinpath(root, "regressions", tail)
+
+
+__all__ = ["orjson_regression", "polars_regression"]

utilities/pytest_regressions.py

@@ -1,18 +1,17 @@
 from __future__ import annotations
 
 from contextlib import suppress
+from dataclasses import dataclass
 from json import loads
 from pathlib import Path
 from shutil import copytree
-from typing import TYPE_CHECKING, Any, assert_never
+from typing import TYPE_CHECKING, Any, assert_never, override
 
-from pytest import fixture
 from pytest_regressions.file_regression import FileRegressionFixture
 
 from utilities.functions import ensure_str
 from utilities.operator import is_equal
-from utilities.pathlib import get_root
-from utilities.pytest import node_id_to_path
+from utilities.reprlib import get_repr
 
 if TYPE_CHECKING:
     from polars import DataFrame, Series
@@ -21,9 +20,6 @@ if TYPE_CHECKING:
     from utilities.types import PathLike, StrMapping
 
 
-_PATH_TESTS = Path("src", "tests")
-
-
 ##
 
 
@@ -76,21 +72,28 @@ class OrjsonRegressionFixture:
             check_fn=self._check_fn,
         )
 
-    def _check_fn(self, path1: Path, path2: Path, /) -> None:
-        with path1.open(mode="r") as fh:
-            left = loads(fh.read())
-        with path2.open(mode="r") as fh:
-            right = loads(fh.read())
-        assert is_equal(left, right), f"{left=}, {right=}"
+    def _check_fn(self, path_obtained: Path, path_existing: Path, /) -> None:
+        obtained = loads(path_obtained.read_text())
+        existing = loads(path_existing.read_text())
+        if not is_equal(obtained, existing):
+            raise OrjsonRegressionError(
+                path_obtained=path_obtained,
+                path_existing=path_existing,
+                obtained=obtained,
+                existing=existing,
+            )
+
 
+@dataclass(kw_only=True, slots=True)
+class OrjsonRegressionError(Exception):
+    path_obtained: Path
+    path_existing: Path
+    obtained: Any
+    existing: Any
 
-@fixture
-def orjson_regression(
-    *, request: FixtureRequest, tmp_path: Path
-) -> OrjsonRegressionFixture:
-    """Instance of the `OrjsonRegressionFixture`."""
-    path = _get_path(request)
-    return OrjsonRegressionFixture(path, request, tmp_path)
+    @override
+    def __str__(self) -> str:
+        return f"Obtained object (at {str(self.path_obtained)!r}) and existing object (at {str(self.path_existing)!r}) differ; got {get_repr(self.obtained)} and {get_repr(self.existing)}"
 
 
 ##
@@ -114,7 +117,6 @@ class PolarsRegressionFixture:
             "describe": obj.describe(percentiles=[i / 10 for i in range(1, 10)]).rows(
                 named=True
             ),
-            "estimated_size": obj.estimated_size(),
             "is_empty": obj.is_empty(),
             "n_unique": obj.n_unique(),
         }
@@ -132,33 +134,11 @@ class PolarsRegressionFixture:
                             col(column).approx_n_unique()
                         ).item()
                 data["approx_n_unique"] = approx_n_unique
-                data["glimpse"] = df.glimpse(return_as_string=True)
+                data["glimpse"] = df.glimpse(return_type="string")
                 data["null_count"] = df.null_count().row(0, named=True)
-            case _ as never:
+            case never:
                 assert_never(never)
         self._fixture.check(data, suffix=suffix)
 
 
-@fixture
-def polars_regression(
-    *, request: FixtureRequest, tmp_path: Path
-) -> PolarsRegressionFixture:
-    """Instance of the `PolarsRegressionFixture`."""
-    path = _get_path(request)
-    return PolarsRegressionFixture(path, request, tmp_path)
-
-
-##
-
-
-def _get_path(request: FixtureRequest, /) -> Path:
-    tail = node_id_to_path(request.node.nodeid, head=_PATH_TESTS)
-    return get_root().joinpath(_PATH_TESTS, "regressions", tail)
-
-
-__all__ = [
-    "OrjsonRegressionFixture",
-    "PolarsRegressionFixture",
-    "orjson_regression",
-    "polars_regression",
-]
+__all__ = ["OrjsonRegressionFixture", "PolarsRegressionFixture"]

utilities/random.py

@@ -3,6 +3,8 @@ from __future__ import annotations
 from random import Random, SystemRandom
 from typing import TYPE_CHECKING
 
+from utilities.functools import cache
+
 if TYPE_CHECKING:
     from collections.abc import Iterable
 
@@ -17,16 +19,16 @@ SYSTEM_RANDOM = SystemRandom()
 
 def bernoulli(*, true: float = 0.5, seed: Seed | None = None) -> bool:
     """Return a Bernoulli random variate."""
-    seed = get_state(seed=seed)
-    return bool(seed.binomialvariate(p=true))
+    state = get_state(seed)
+    return bool(state.binomialvariate(p=true))
 
 
 ##
 
 
-def get_docker_name(*, seed: Seed | None = None) -> str:
+def get_docker_name(seed: Seed | None = None, /) -> str:
     """Get a docker name."""
-    state = get_state(seed=seed)
+    state = get_state(seed)
     prefix = state.choice(_DOCKER_PREFIXES)
     suffix = state.choice(_DOCKER_SUFFIXES)
     digit = state.randint(0, 9)
@@ -47,16 +49,19 @@ _DOCKER_SUFFIXES = [
 ##
 
 
-def get_state(*, seed: Seed | None = None) -> Random:
+@cache
+def get_state(seed: Seed | None = None, /) -> Random:
     """Get a random state."""
     return seed if isinstance(seed, Random) else Random(x=seed)
 
 
 ##
+
+
 def shuffle[T](iterable: Iterable[T], /, *, seed: Seed | None = None) -> list[T]:
     """Shuffle an iterable."""
     copy = list(iterable).copy()
-    state = get_state(seed=seed)
+    state = get_state(seed)
     state.shuffle(copy)
     return copy
 

utilities/re.py

@@ -16,7 +16,7 @@ def ensure_pattern(pattern: PatternLike, /, *, flags: int = 0) -> Pattern[str]:
             return pattern
         case str():
             return re.compile(pattern, flags=flags)
-        case _ as never:
+        case never:
             assert_never(never)