dycw-utilities 0.175.17__py3-none-any.whl → 0.185.8__py3-none-any.whl

utilities/pytest.py

@@ -8,26 +8,37 @@ from os import environ
 from pathlib import Path
 from re import sub
 from types import FunctionType
-from typing import TYPE_CHECKING, Any, assert_never, cast, override
-
-from whenever import ZonedDateTime
-
-from utilities.atomicwrites import writer
+from typing import TYPE_CHECKING, Any, NoReturn, assert_never, cast, override
+
+from utilities.constants import (
+    IS_CI,
+    IS_CI_AND_NOT_LINUX,
+    IS_LINUX,
+    IS_MAC,
+    IS_NOT_LINUX,
+    IS_NOT_MAC,
+    SECOND,
+)
 from utilities.functools import cache
 from utilities.hashlib import md5_hash
-from utilities.os import get_env_var
 from utilities.pathlib import (
     _GetTailEmptyError,
     ensure_suffix,
-    get_root,
+    get_repo_root,
     get_tail,
     module_path,
 )
-from utilities.platform import IS_LINUX, IS_MAC, IS_NOT_LINUX, IS_NOT_MAC
 from utilities.random import bernoulli
 from utilities.text import to_bool
-from utilities.types import MaybeCallableBoolLike, MaybeCoro, Seed
-from utilities.whenever import SECOND, get_now_local
+from utilities.throttle import throttle
+from utilities.types import (
+    Coro,
+    Duration,
+    MaybeCallableBoolLike,
+    MaybeCoro,
+    PathLike,
+    Seed,
+)
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -36,11 +47,7 @@ if TYPE_CHECKING:
     from _pytest.config.argparsing import Parser
     from _pytest.python import Function
 
-    from utilities.types import Coro, Delta, PathLike
-
-
-IS_CI = "CI" in environ
-IS_CI_AND_NOT_LINUX = IS_CI and IS_NOT_LINUX
+    from utilities.types import PathLike
 
 
 try:  # WARNING: this package cannot use unguarded `pytest` imports
@@ -138,9 +145,9 @@ def add_pytest_configure(config: Config, options: Iterable[tuple[str, str]], /)
 
 
 def make_ids(obj: Any, /) -> str:
-    if isinstance(obj, FunctionType):
+    if isinstance(obj, FunctionType):  # pragma: no cover
         return sub(r"\s+at +0x[0-9a-fA-F]+", "", repr(obj))
-    return repr(obj)
+    return repr(obj)  # pragma: no cover
 
 
 ##
@@ -195,7 +202,7 @@ class _NodeIdToPathNotGetTailError(NodeIdToPathError):
 ##
 
 
-def run_frac[F: Callable[..., MaybeCoro[None]]](
+def run_test_frac[F: Callable[..., MaybeCoro[None]]](
     *,
     predicate: MaybeCallableBoolLike | None = None,
     frac: float = 0.5,
@@ -203,11 +210,11 @@ def run_frac[F: Callable[..., MaybeCoro[None]]](
 ) -> Callable[[F], F]:
     """Run a test only a fraction of the time.."""
     return cast(
-        "Any", partial(_run_frac_inner, predicate=predicate, frac=frac, seed=seed)
+        "Any", partial(_run_test_frac_inner, predicate=predicate, frac=frac, seed=seed)
     )
 
 
-def _run_frac_inner[F: Callable[..., MaybeCoro[None]]](
+def _run_test_frac_inner[F: Callable[..., MaybeCoro[None]]](
     func: F,
     /,
     *,
@@ -255,109 +262,43 @@ def _skipif_frac(
 ##
 
 
-def throttle[F: Callable[..., MaybeCoro[None]]](
-    *, root: PathLike | None = None, delta: Delta = SECOND, on_try: bool = False
+def throttle_test[F: Callable[..., MaybeCoro[None]]](
+    *, on_try: bool = False, root: PathLike | None = None, duration: Duration = 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))
-
-
-def _throttle_inner[F: Callable[..., MaybeCoro[None]]](
-    func: F,
-    /,
-    *,
-    root: PathLike | None = None,
-    delta: Delta = SECOND,
-    on_try: bool = False,
-) -> F:
-    if get_env_var("THROTTLE", nullable=True) is not None:
-        return func
-    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)
-
-            return cast("Any", throttle_sync_on_pass)
-
-        case False, True:
-
-            @wraps(func)
-            def throttle_sync_on_try(*args: Any, **kwargs: Any) -> None:
-                _skipif_recent(root=root, delta=delta)
-                _write(root)
-                cast("Callable[..., None]", func)(*args, **kwargs)
-
-            return cast("Any", throttle_sync_on_try)
-
-        case True, False:
+    return throttle(
+        on_try=on_try,
+        duration=duration,
+        path=partial(_get_test_path, root=root),
+        raiser=_run_skip,
+    )
 
-            @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)
 
-            return cast("Any", throttle_async_on_pass)
+def _run_skip() -> NoReturn:
+    from pytest import skip
 
-        case True, True:
+    skip(reason=f"{_get_name()} throttled")
 
-            @wraps(func)
-            async def throttle_async_on_try(*args: Any, **kwargs: Any) -> None:
-                _skipif_recent(root=root, delta=delta)
-                _write(root)
-                await cast("Callable[..., Coro[None]]", func)(*args, **kwargs)
 
-            return cast("Any", throttle_async_on_try)
+def _get_name() -> str:
+    return environ["PYTEST_CURRENT_TEST"]
 
-        case never:
-            assert_never(never)
 
+@cache
+def _md5_hash_cached(text: str, /) -> str:
+    return md5_hash(text)
 
-def _skipif_recent(*, root: PathLike | None = None, delta: Delta = SECOND) -> None:
-    from pytest import skip
 
-    path = _get_path(root)
-    try:
-        contents = path.read_text()
-    except FileNotFoundError:
-        return
-    try:
-        last = ZonedDateTime.parse_iso(contents)
-    except ValueError:
-        return
-    now = get_now_local()
-    if (now - delta) < last:
-        age = now - last
-        _ = skip(reason=f"{_get_name()} throttled (age {age})")
-
-
-def _get_path(root: PathLike | None = None, /) -> Path:
+def _get_test_path(*, root: PathLike | None = None) -> Path:
     if root is None:
-        root_use = get_root().joinpath(".pytest_cache", "throttle")  # pragma: no cover
+        root_use = get_repo_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)
-    with writer(path, overwrite=True) as temp:
-        _ = temp.write_text(get_now_local().format_iso())
-
-
 __all__ = [
     "IS_CI",
     "IS_CI_AND_NOT_LINUX",
@@ -367,12 +308,12 @@ __all__ = [
     "add_pytest_configure",
     "make_ids",
     "node_id_path",
-    "run_frac",
+    "run_test_frac",
     "skipif_ci",
     "skipif_ci_and_not_linux",
     "skipif_linux",
     "skipif_mac",
     "skipif_not_linux",
     "skipif_not_mac",
-    "throttle",
+    "throttle_test",
 ]

utilities/pytest_plugins/pytest_regressions.py

@@ -40,7 +40,7 @@ else:
 
 
 def _get_path(request: FixtureRequest, /) -> Path:
-    from utilities.pathlib import get_root
+    from utilities.pathlib import get_repo_root
     from utilities.pytest import _NodeIdToPathNotGetTailError, node_id_path
 
     path = Path(cast("Any", request).fspath)
@@ -50,7 +50,7 @@ def _get_path(request: FixtureRequest, /) -> Path:
     except _NodeIdToPathNotGetTailError:
         root = Path("tests")
         tail = node_id_path(request.node.nodeid, root=root)
-    return get_root(path).joinpath(root, "regressions", tail)
+    return get_repo_root(path).joinpath(root, "regressions", tail)
 
 
 __all__ = ["orjson_regression", "polars_regression"]

utilities/pytest_regressions.py

@@ -4,14 +4,14 @@ 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, override
 
+from pytest_datadir.plugin import LazyDataDir
 from pytest_regressions.file_regression import FileRegressionFixture
 
+from utilities.core import _CopyOrMoveSourceNotFoundError, copy, repr_
 from utilities.functions import ensure_str
 from utilities.operator import is_equal
-from utilities.reprlib import get_repr
 
 if TYPE_CHECKING:
     from polars import DataFrame, Series
@@ -33,10 +33,12 @@ class OrjsonRegressionFixture:
         path = Path(path)
         original_datadir = path.parent
         data_dir = tmp_path.joinpath(ensure_str(request.fixturename))
-        with suppress(FileNotFoundError):
-            _ = copytree(original_datadir, data_dir)
+        with suppress(_CopyOrMoveSourceNotFoundError):
+            copy(original_datadir, data_dir, overwrite=True)
         self._fixture = FileRegressionFixture(
-            datadir=data_dir, original_datadir=original_datadir, request=request
+            datadir=LazyDataDir(original_datadir=original_datadir, tmp_path=data_dir),
+            original_datadir=original_datadir,
+            request=request,
         )
         self._basename = path.name
 
@@ -93,7 +95,7 @@ class OrjsonRegressionError(Exception):
 
     @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)}"
+        return f"Obtained object (at {str(self.path_obtained)!r}) and existing object (at {str(self.path_existing)!r}) differ; got {repr_(self.obtained)} and {repr_(self.existing)}"
 
 
 ##

utilities/random.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from random import Random, SystemRandom
+from random import Random
 from typing import TYPE_CHECKING
 
 from utilities.functools import cache
@@ -11,12 +11,6 @@ if TYPE_CHECKING:
     from utilities.types import Seed
 
 
-SYSTEM_RANDOM = SystemRandom()
-
-
-##
-
-
 def bernoulli(*, true: float = 0.5, seed: Seed | None = None) -> bool:
     """Return a Bernoulli random variate."""
     state = get_state(seed)
@@ -66,4 +60,4 @@ def shuffle[T](iterable: Iterable[T], /, *, seed: Seed | None = None) -> list[T]
     return copy
 
 
-__all__ = ["SYSTEM_RANDOM", "bernoulli", "get_docker_name", "get_state", "shuffle"]
+__all__ = ["bernoulli", "get_docker_name", "get_state", "shuffle"]