dycw-utilities 0.136.1__tar.gz → 0.136.2__tar.gz

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/PKG-INFO

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

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/pyproject.toml

@@ -106,7 +106,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.136.1"
+version = "0.136.2"
 
 [project.optional-dependencies]
 logging = [
@@ -134,7 +134,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.136.1"
+current_version = "0.136.2"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/tests/test_functions.py

@@ -90,11 +90,13 @@ from utilities.functions import (
     min_nullable,
     not_func,
     second,
+    to_bool,
     yield_object_attributes,
     yield_object_cached_properties,
     yield_object_properties,
 )
-from utilities.sentinel import sentinel
+from utilities.hypothesis import sentinels
+from utilities.sentinel import Sentinel, sentinel
 from utilities.whenever import NOW_UTC, ZERO_TIME, get_now, get_today
 
 if TYPE_CHECKING:
@@ -915,6 +917,16 @@ class TestSecond:
         assert second(pair) == y
 
 
+class TestToBool:
+    @given(bool_=booleans() | none() | sentinels())
+    def test_bool_none_or_sentinel(self, *, bool_: bool | None | Sentinel) -> None:
+        assert to_bool(bool_=bool_) is bool_
+
+    @given(bool_=booleans())
+    def test_callable(self, *, bool_: bool) -> None:
+        assert to_bool(bool_=lambda: bool_) is bool_
+
+
 class TestYieldObjectAttributes:
     @given(n=integers())
     def test_main(self, *, n: int) -> None:

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/tests/test_os.py

@@ -21,6 +21,7 @@ from utilities.os import (
     get_cpu_count,
     get_cpu_use,
     get_env_var,
+    is_debug,
     temp_environ,
 )
 from utilities.pytest import skipif_windows
@@ -117,6 +118,12 @@ class TestGetEnvVar:
             _ = get_env_var(key, case_sensitive=case_sensitive)
 
 
+class TestIsDebug:
+    def test_main(self) -> None:
+        result = is_debug()
+        assert isinstance(result, bool)
+
+
 class TestTempEnviron:
     @given(key=text.map(_prefix), value=text)
     def test_set(self, *, key: str, value: str) -> None:

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.136.1"
+__version__ = "0.136.2"

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/utilities/asyncio.py

@@ -36,10 +36,10 @@ from typing_extensions import deprecated
 
 from utilities.dataclasses import replace_non_sentinel
 from utilities.errors import repr_error
-from utilities.functions import ensure_int, ensure_not_none
+from utilities.functions import ensure_int, ensure_not_none, to_bool
 from utilities.random import SYSTEM_RANDOM
 from utilities.sentinel import Sentinel, sentinel
-from utilities.types import SupportsRichComparison
+from utilities.types import MaybeCallableBool, SupportsRichComparison
 from utilities.whenever import SECOND, get_now
 
 if TYPE_CHECKING:
@@ -223,7 +223,7 @@ class EnhancedTaskGroup(TaskGroup):
     _semaphore: Semaphore | None
     _timeout: TimeDelta | None
     _error: MaybeType[BaseException]
-    _debug: bool
+    _debug: MaybeCallableBool
     _stack: AsyncExitStack
     _timeout_cm: _AsyncGeneratorContextManager[None] | None
 
@@ -234,7 +234,7 @@ class EnhancedTaskGroup(TaskGroup):
         max_tasks: int | None = None,
         timeout: TimeDelta | None = None,
         error: MaybeType[BaseException] = TimeoutError,
-        debug: bool = False,
+        debug: MaybeCallableBool = False,
     ) -> None:
         super().__init__()
         self._semaphore = None if max_tasks is None else Semaphore(max_tasks)
@@ -257,7 +257,7 @@ class EnhancedTaskGroup(TaskGroup):
         tb: TracebackType | None,
     ) -> None:
         _ = await self._stack.__aexit__(et, exc, tb)
-        match self._debug:
+        match to_bool(bool_=self._debug):
             case True:
                 with suppress(Exception):
                     _ = await super().__aexit__(et, exc, tb)
@@ -293,7 +293,7 @@ class EnhancedTaskGroup(TaskGroup):
         name: str | None = None,
         context: Context | None = None,
     ) -> T | Task[T]:
-        match self._debug:
+        match to_bool(bool_=self._debug):
             case True:
                 return await coro
             case False:

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/utilities/functions.py

@@ -14,7 +14,16 @@ from types import (
     MethodWrapperType,
     WrapperDescriptorType,
 )
-from typing import TYPE_CHECKING, Any, Literal, TypeGuard, cast, overload, override
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Literal,
+    TypeGuard,
+    assert_never,
+    cast,
+    overload,
+    override,
+)
 
 from whenever import Date, PlainDateTime, Time, TimeDelta, ZonedDateTime
 
@@ -22,6 +31,7 @@ from utilities.reprlib import get_repr, get_repr_and_class
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import (
     Dataclass,
+    MaybeCallableBool,
     Number,
     StrMapping,
     SupportsRichComparison,
@@ -935,6 +945,28 @@ def second[U](pair: tuple[Any, U], /) -> U:
 ##
 
 
+@overload
+def to_bool(*, bool_: MaybeCallableBool) -> bool: ...
+@overload
+def to_bool(*, bool_: None) -> None: ...
+@overload
+def to_bool(*, bool_: Sentinel) -> Sentinel: ...
+def to_bool(
+    *, bool_: MaybeCallableBool | None | Sentinel = sentinel
+) -> bool | None | Sentinel:
+    """Get the bool."""
+    match bool_:
+        case bool() | None | Sentinel():
+            return bool_
+        case Callable() as func:
+            return to_bool(bool_=func())
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
 def yield_object_attributes(
     obj: Any,
     /,

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/utilities/os.py

@@ -123,6 +123,14 @@ class GetEnvVarError(Exception):
 ##
 
 
+def is_debug() -> bool:
+    """Check if we are in `DEBUG` mode."""
+    return get_env_var("DEBUG", nullable=True) is not None
+
+
+##
+
+
 @contextmanager
 def temp_environ(
     env: Mapping[str, str | None] | None = None, **env_kwargs: str | None
@@ -154,5 +162,6 @@ __all__ = [
     "get_cpu_count",
     "get_cpu_use",
     "get_env_var",
+    "is_debug",
     "temp_environ",
 ]

{dycw_utilities-0.136.1 → dycw_utilities-0.136.2}/src/utilities/traceback.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 import re
 import sys
 from asyncio import run
-from collections.abc import Callable
 from dataclasses import dataclass
 from functools import partial
 from getpass import getuser
@@ -11,12 +10,12 @@ from itertools import repeat
 from pathlib import Path
 from socket import gethostname
 from traceback import TracebackException
-from typing import TYPE_CHECKING, assert_never, override
+from typing import TYPE_CHECKING, override
 
 from utilities.atomicwrites import writer
 from utilities.errors import repr_error
+from utilities.functions import to_bool
 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,
@@ -31,11 +30,12 @@ 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 Iterator, Sequence
+    from collections.abc import Callable, Iterator, Sequence
     from traceback import FrameSummary
     from types import TracebackType
 
     from utilities.types import (
+        MaybeCallableBool,
         MaybeCallablePathLike,
         MaybeCallableZonedDateTime,
         PathLike,
@@ -203,7 +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,
+    pudb: MaybeCallableBool = False,
 ) -> Callable[
     [type[BaseException] | None, BaseException | None, TracebackType | None], None
 ]:
@@ -240,7 +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,
+    pudb: MaybeCallableBool = False,
 ) -> None:
     """Exception hook to log the traceback."""
     _ = (exc_type, traceback)
@@ -272,18 +272,10 @@ 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)
+    if to_bool(bool_=pudb):  # pragma: no cover
+        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.136.1 → dycw_utilities-0.136.2}/src/utilities/types.py

@@ -59,6 +59,7 @@ type OpenMode = Literal[
     "a+b",
 ]
 type MaybeCallable[T] = T | Callable[[], T]
+type MaybeCallableBool = MaybeCallable[bool]
 type MaybeStr[T] = T | str
 type MaybeType[T] = T | type[T]
 type StrMapping = Mapping[str, Any]
@@ -254,6 +255,7 @@ __all__ = [
     "LoggerOrName",
     "MathRoundMode",
     "MaybeCallable",
+    "MaybeCallableBool",
     "MaybeCallableDate",
     "MaybeCallableEvent",
     "MaybeCallablePathLike",