dycw-utilities 0.133.7__py3-none-any.whl → 0.134.1__py3-none-any.whl

utilities/pudb.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+from asyncio import iscoroutinefunction
+from functools import partial, wraps
+from typing import TYPE_CHECKING, Any, NoReturn, cast, overload
+
+from pudb import post_mortem
+
+from utilities.os import GetEnvVarError, get_env_var
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+_ENV_VAR = "DEBUG"
+
+
+@overload
+def call_pudb[F: Callable](func: F, /, *, env_var: str = _ENV_VAR) -> F: ...
+@overload
+def call_pudb[F: Callable](
+    func: None = None, /, *, env_var: str = _ENV_VAR
+) -> Callable[[F], F]: ...
+def call_pudb[F: Callable](
+    func: F | None = None, /, *, env_var: str = _ENV_VAR
+) -> F | Callable[[F], F]:
+    """Call `pudb` upon failure, if the required environment variable is set."""
+    if func is None:
+        result = partial(call_pudb, env_var=env_var)
+        return cast("Callable[[F], F]", result)
+
+    if not iscoroutinefunction(func):
+
+        @wraps(func)
+        def wrapped_sync(*args: Any, **kwargs: Any) -> Any:
+            try:
+                return func(*args, **kwargs)
+            except Exception as error:  # noqa: BLE001
+                _call_pudb(error, env_var=env_var)
+
+        return cast("F", wrapped_sync)
+
+    @wraps(func)
+    async def wrapped_async(*args: Any, **kwargs: Any) -> Any:
+        try:
+            return await func(*args, **kwargs)
+        except Exception as error:  # noqa: BLE001
+            _call_pudb(error, env_var=env_var)
+
+    return cast("F", wrapped_async)
+
+
+def _call_pudb(error: Exception, /, *, env_var: str = _ENV_VAR) -> NoReturn:
+    try:
+        _ = get_env_var(env_var)
+    except GetEnvVarError:
+        raise error from None
+    post_mortem()  # pragma: no cover
+    raise error  # pragma: no cover
+
+
+__all__ = ["call_pudb"]

utilities/pydantic.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from pathlib import Path
-from typing import TYPE_CHECKING, TypeVar, override
+from typing import TYPE_CHECKING, override
 
 from pydantic import BaseModel
 
@@ -11,8 +11,6 @@ from utilities.atomicwrites import writer
 if TYPE_CHECKING:
     from utilities.types import PathLike
 
-_TBaseModel = TypeVar("_TBaseModel", bound=BaseModel)
-
 
 class HashableBaseModel(BaseModel):
     """Subclass of BaseModel which is hashable."""
@@ -22,7 +20,7 @@ class HashableBaseModel(BaseModel):
         return hash((type(self), *self.__dict__.values()))
 
 
-def load_model(model: type[_TBaseModel], path: PathLike, /) -> _TBaseModel:
+def load_model[T: BaseModel](model: type[T], path: PathLike, /) -> T:
     path = Path(path)
     try:
         with path.open() as fh:

utilities/pytest.py

@@ -5,7 +5,7 @@ from functools import partial, wraps
 from inspect import iscoroutinefunction
 from os import environ
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, ParamSpec, assert_never, cast, override
+from typing import TYPE_CHECKING, Any, assert_never, cast, override
 
 from pytest import fixture
 from whenever import ZonedDateTime
@@ -24,6 +24,7 @@ from utilities.platform import (
     IS_WINDOWS,
 )
 from utilities.random import get_state
+from utilities.types import MaybeCoro
 from utilities.whenever import SECOND, get_now_local
 
 if TYPE_CHECKING:
@@ -32,7 +33,7 @@ if TYPE_CHECKING:
 
     from whenever import TimeDelta
 
-    from utilities.types import Coroutine1, PathLike, TCallableMaybeCoroutine1None
+    from utilities.types import Coro, PathLike
 
 try:  # WARNING: this package cannot use unguarded `pytest` imports
     from _pytest.config import Config
@@ -56,12 +57,6 @@ else:
     skipif_not_linux = mark.skipif(IS_NOT_LINUX, reason="Skipped for non-Linux")
 
 
-_P = ParamSpec("_P")
-
-
-##
-
-
 def add_pytest_addoption(parser: Parser, options: Sequence[str], /) -> None:
     """Add the `--slow`, etc options to pytest.
 
@@ -167,27 +162,27 @@ def random_state(*, seed: int) -> Random:
 ##
 
 
-def throttle(
+def throttle[F: Callable[..., MaybeCoro[None]]](
     *, root: PathLike | None = None, delta: TimeDelta = SECOND, on_try: bool = False
-) -> Callable[[TCallableMaybeCoroutine1None], TCallableMaybeCoroutine1None]:
+) -> 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(
-    func: TCallableMaybeCoroutine1None,
+def _throttle_inner[F: Callable[..., MaybeCoro[None]]](
+    func: F,
     /,
     *,
     root: PathLike | None = None,
     delta: TimeDelta = SECOND,
     on_try: bool = False,
-) -> TCallableMaybeCoroutine1None:
+) -> F:
     """Throttle a test function/method."""
     match bool(iscoroutinefunction(func)), on_try:
         case False, False:
 
             @wraps(func)
-            def throttle_sync_on_pass(*args: _P.args, **kwargs: _P.kwargs) -> None:
+            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)
@@ -197,7 +192,7 @@ def _throttle_inner(
         case False, True:
 
             @wraps(func)
-            def throttle_sync_on_try(*args: _P.args, **kwargs: _P.kwargs) -> None:
+            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)
@@ -207,11 +202,9 @@ def _throttle_inner(
         case True, False:
 
             @wraps(func)
-            async def throttle_async_on_pass(
-                *args: _P.args, **kwargs: _P.kwargs
-            ) -> None:
+            async def throttle_async_on_pass(*args: Any, **kwargs: Any) -> None:
                 _skipif_recent(root=root, delta=delta)
-                await cast("Callable[..., Coroutine1[None]]", func)(*args, **kwargs)
+                await cast("Callable[..., Coro[None]]", func)(*args, **kwargs)
                 _write(root=root)
 
             return cast("Any", throttle_async_on_pass)
@@ -219,12 +212,10 @@ def _throttle_inner(
         case True, True:
 
             @wraps(func)
-            async def throttle_async_on_try(
-                *args: _P.args, **kwargs: _P.kwargs
-            ) -> None:
+            async def throttle_async_on_try(*args: Any, **kwargs: Any) -> None:
                 _skipif_recent(root=root, delta=delta)
                 _write(root=root)
-                await cast("Callable[..., Coroutine1[None]]", func)(*args, **kwargs)
+                await cast("Callable[..., Coro[None]]", func)(*args, **kwargs)
 
             return cast("Any", throttle_async_on_try)
 

utilities/python_dotenv.py

@@ -11,21 +11,17 @@ from utilities.dataclasses import _ParseDataClassMissingValuesError, parse_datac
 from utilities.iterables import MergeStrMappingsError, merge_str_mappings
 from utilities.pathlib import get_root
 from utilities.reprlib import get_repr
+from utilities.types import Dataclass
 
 if TYPE_CHECKING:
     from collections.abc import Mapping
     from collections.abc import Set as AbstractSet
 
-    from utilities.types import (
-        MaybeCallablePathLike,
-        ParseObjectExtra,
-        StrMapping,
-        TDataclass,
-    )
+    from utilities.types import MaybeCallablePathLike, ParseObjectExtra, StrMapping
 
 
-def load_settings(
-    cls: type[TDataclass],
+def load_settings[T: Dataclass](
+    cls: type[T],
     /,
     *,
     path: MaybeCallablePathLike | None = Path.cwd,
@@ -35,7 +31,7 @@ def load_settings(
     head: bool = False,
     case_sensitive: bool = False,
     extra_parsers: ParseObjectExtra | None = None,
-) -> TDataclass:
+) -> T:
     """Load a set of settings from the `.env` file."""
     path = get_root(path=path).joinpath(".env")
     if not path.exists():

utilities/random.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from random import Random, SystemRandom
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -9,7 +9,6 @@ if TYPE_CHECKING:
     from utilities.types import Seed
 
 
-_T = TypeVar("_T")
 SYSTEM_RANDOM = SystemRandom()
 
 
@@ -54,7 +53,7 @@ def get_state(*, seed: Seed | None = None) -> Random:
 
 
 ##
-def shuffle(iterable: Iterable[_T], /, *, seed: Seed | None = None) -> list[_T]:
+def shuffle[T](iterable: Iterable[T], /, *, seed: Seed | None = None) -> list[T]:
     """Shuffle an iterable."""
     copy = list(iterable).copy()
     state = get_state(seed=seed)