dycw-utilities 0.134.0__tar.gz → 0.134.1__tar.gz

{dycw_utilities-0.134.0 → dycw_utilities-0.134.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.134.0
+Version: 0.134.1
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.134.0 → dycw_utilities-0.134.1}/pyproject.toml

@@ -64,6 +64,7 @@ pottery = ["pottery >= 3.0.1, < 3.1"]
 pottery-test = ["orjson", "pytest-rerunfailures"]
 pqdm = ["pqdm >= 0.2.0, < 0.3"]
 psutil = ["psutil >= 7.0.0, < 7.1"]
+pudb = ["pudb >= 2025.1, < 2025.2"]
 pydantic = ["pydantic >= 2.11.4, < 2.12"]
 pyinstrument = ["pyinstrument >= 5.0.2, < 5.1"]
 pytest = [
@@ -104,7 +105,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.134.0"
+version = "0.134.1"
 
 [project.optional-dependencies]
 logging = [
@@ -131,7 +132,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.134.0"
+current_version = "0.134.1"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.134.1/src/tests/test_pudb.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+from asyncio import sleep
+
+from hypothesis import given
+from pytest import raises
+
+from utilities.hypothesis import text_ascii
+from utilities.pudb import call_pudb
+
+
+class TestCallPUDB:
+    def test_sync(self) -> None:
+        @call_pudb
+        def func(x: int, y: int, /) -> float:
+            return x / y
+
+        with raises(ZeroDivisionError):
+            _ = func(1, 0)
+
+    async def test_async(self) -> None:
+        @call_pudb
+        async def func(x: int, y: int, /) -> float:
+            await sleep(0.01)
+            return x / y
+
+        with raises(ZeroDivisionError):
+            _ = await func(1, 0)
+
+    @given(env_var=text_ascii(min_size=1))
+    def test_custom_env_var(self, *, env_var: str) -> None:
+        @call_pudb(env_var=env_var)
+        def func(x: int, y: int, /) -> float:
+            return x / y
+
+        with raises(ZeroDivisionError):
+            _ = func(1, 0)

{dycw_utilities-0.134.0 → dycw_utilities-0.134.1}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.134.0"
+__version__ = "0.134.1"

{dycw_utilities-0.134.0 → dycw_utilities-0.134.1}/src/utilities/functools.py

@@ -18,16 +18,19 @@ def cache[F: Callable](func: F, /) -> F:
 ##
 
 
+_MAX_SIZE = 128
+
+
 @overload
 def lru_cache[F: Callable](
-    func: F, /, *, max_size: int = ..., typed: bool = ...
+    func: F, /, *, max_size: int = _MAX_SIZE, typed: bool = False
 ) -> F: ...
 @overload
 def lru_cache[F: Callable](
-    func: None = None, /, *, max_size: int = ..., typed: bool = ...
+    func: None = None, /, *, max_size: int = _MAX_SIZE, typed: bool = False
 ) -> Callable[[F], F]: ...
 def lru_cache[F: Callable](
-    func: F | None = None, /, *, max_size: int = 128, typed: bool = False
+    func: F | None = None, /, *, max_size: int = _MAX_SIZE, typed: bool = False
 ) -> F | Callable[[F], F]:
     """Typed version of `lru_cache`."""
     if func is None:

dycw_utilities-0.134.1/src/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"]