dycw-utilities 0.135.1__tar.gz → 0.136.0__tar.gz

{dycw_utilities-0.135.1 → dycw_utilities-0.136.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.135.1
+Version: 0.136.0
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
@@ -13,6 +13,7 @@ Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
 Provides-Extra: test
 Requires-Dist: dycw-pytest-only<2.2,>=2.1.1; extra == 'test'
 Requires-Dist: hypothesis<6.136,>=6.135.2; extra == 'test'
+Requires-Dist: pudb<2025.2,>=2025.1; extra == 'test'
 Requires-Dist: pytest-asyncio<1.1,>=1.0.0; extra == 'test'
 Requires-Dist: pytest-cov<6.2,>=6.1.1; extra == 'test'
 Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'

{dycw_utilities-0.135.1 → dycw_utilities-0.136.0}/pyproject.toml

@@ -65,7 +65,6 @@ 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 = [
@@ -107,7 +106,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.135.1"
+version = "0.136.0"
 
 [project.optional-dependencies]
 logging = [
@@ -116,6 +115,7 @@ logging = [
 test = [
   "dycw-pytest-only >= 2.1.1, < 2.2",
   "hypothesis >= 6.135.2, < 6.136",
+  "pudb >= 2025.1, < 2025.2",
   "pytest >= 8.3.5, < 8.4",
   "pytest-asyncio >= 1.0.0, < 1.1",
   "pytest-cov >= 6.1.1, < 6.2",
@@ -134,7 +134,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.135.1"
+current_version = "0.136.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.135.1 → dycw_utilities-0.136.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.135.1"
+__version__ = "0.136.0"

{dycw_utilities-0.135.1 → dycw_utilities-0.136.0}/src/utilities/traceback.py

@@ -11,11 +11,12 @@ from itertools import repeat
 from pathlib import Path
 from socket import gethostname
 from traceback import TracebackException
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING, assert_never, override
 
 from utilities.atomicwrites import writer
 from utilities.errors import repr_error
 from utilities.iterables import OneEmptyError, one
+from utilities.os import get_env_var
 from utilities.pathlib import get_path
 from utilities.reprlib import (
     RICH_EXPAND_ALL,
@@ -30,7 +31,7 @@ from utilities.version import get_version
 from utilities.whenever import format_compact, get_now, to_zoned_date_time
 
 if TYPE_CHECKING:
-    from collections.abc import Callable, Iterator, Sequence
+    from collections.abc import Iterator, Sequence
     from traceback import FrameSummary
     from types import TracebackType
 
@@ -202,6 +203,7 @@ def make_except_hook(
     max_depth: int | None = RICH_MAX_DEPTH,
     expand_all: bool = RICH_EXPAND_ALL,
     slack_url: str | None = None,
+    pudb: str | None = None,
 ) -> Callable[
     [type[BaseException] | None, BaseException | None, TracebackType | None], None
 ]:
@@ -218,6 +220,7 @@ def make_except_hook(
         max_depth=max_depth,
         expand_all=expand_all,
         slack_url=slack_url,
+        pudb=pudb,
     )
 
 
@@ -237,6 +240,7 @@ def _make_except_hook_inner(
     max_depth: int | None = RICH_MAX_DEPTH,
     expand_all: bool = RICH_EXPAND_ALL,
     slack_url: str | None = None,
+    pudb: str | Callable[[], bool] | None = None,
 ) -> None:
     """Exception hook to log the traceback."""
     _ = (exc_type, traceback)
@@ -268,6 +272,18 @@ def _make_except_hook_inner(
 
         send = f"```{slim}```"
         run(send_to_slack(slack_url, send))
+    if pudb is not None:  # pragma: no cover
+        match pudb:
+            case str() as env_var:
+                call_pudb = get_env_var(env_var, nullable=True) is not None
+            case Callable() as func:
+                call_pudb = func()
+            case _ as never:
+                assert_never(never)
+        if call_pudb:
+            from pudb import post_mortem
+
+            post_mortem(tb=traceback, e_type=exc_type, e_value=exc_val)
 
 
 @dataclass(kw_only=True, slots=True)

dycw_utilities-0.135.1/src/tests/test_pudb.py

@@ -1,37 +0,0 @@
-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.135.1/src/utilities/pudb.py

@@ -1,62 +0,0 @@
-from __future__ import annotations
-
-from asyncio import iscoroutinefunction
-from functools import partial, wraps
-from typing import TYPE_CHECKING, Any, NoReturn, cast, overload
-
-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
-    from pudb import post_mortem  # pragma: no cover
-
-    post_mortem()  # pragma: no cover
-    raise error  # pragma: no cover
-
-
-__all__ = ["call_pudb"]