dycw-utilities 0.120.0__tar.gz → 0.121.0__tar.gz

{dycw_utilities-0.120.0 → dycw_utilities-0.121.0}/PKG-INFO

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

{dycw_utilities-0.120.0 → dycw_utilities-0.121.0}/pyproject.toml

@@ -92,7 +92,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.120.0"
+version = "0.121.0"
 
 [project.optional-dependencies]
 test = [
@@ -334,7 +334,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.120.0"
+current_version = "0.121.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.120.0 → dycw_utilities-0.121.0}/src/tests/test_asyncio.py

@@ -5,7 +5,7 @@ from dataclasses import dataclass, field
 from functools import partial
 from itertools import chain, count
 from re import search
-from typing import TYPE_CHECKING, Self, override
+from typing import TYPE_CHECKING, Any, Self, cast, override
 
 from hypothesis import HealthCheck, Phase, given, settings
 from hypothesis.strategies import (
@@ -23,12 +23,12 @@ from pytest import LogCaptureFixture, mark, raises
 from utilities.asyncio import (
     EnhancedTaskGroup,
     InfiniteLooper,
-    InfiniteLooperError,
     InfiniteQueueLooper,
     InfiniteQueueLooperError,
     UniquePriorityQueue,
     UniqueQueue,
-    _DurationOrEvery,
+    _InfiniteLooperDefaultEventError,
+    _InfiniteLooperNoSuchEventError,
     get_event,
     get_items,
     get_items_nowait,
@@ -56,7 +56,13 @@ from utilities.timer import Timer
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterator
 
-    from utilities.types import Coroutine1, Duration, MaybeCallableEvent, MaybeType
+    from utilities.types import (
+        Coroutine1,
+        Duration,
+        DurationOrEveryDuration,
+        MaybeCallableEvent,
+        MaybeType,
+    )
 
 
 class TestEnhancedTaskGroup:
@@ -130,7 +136,7 @@ class TestGetEvent:
 
 class TestInfiniteLooper:
     @given(n=integers(10, 11), sleep_core=sampled_from([0.1, ("every", 0.1)]))
-    async def test_main(self, *, n: int, sleep_core: _DurationOrEvery) -> None:
+    async def test_main(self, *, n: int, sleep_core: DurationOrEveryDuration) -> None:
         class TrueError(BaseException): ...
 
         class FalseError(BaseException): ...
@@ -147,7 +153,7 @@ class TestInfiniteLooper:
             async def _core(self) -> None:
                 self.counter += 1
                 if self.counter >= n:
-                    self._set_event(n % 2 == 0)
+                    self._set_event(event=n % 2 == 0)
 
             @override
             def _yield_events_and_exceptions(
@@ -166,15 +172,8 @@ class TestInfiniteLooper:
                     _ = await looper()
 
     async def test_hashable(self) -> None:
-        class CustomError(Exception): ...
-
         @dataclass(kw_only=True, unsafe_hash=True)
-        class Example(InfiniteLooper[None]):
-            @override
-            def _yield_events_and_exceptions(
-                self,
-            ) -> Iterator[tuple[None, MaybeType[Exception]]]:
-                yield (None, CustomError)
+        class Example(InfiniteLooper[None]): ...
 
         looper = Example(sleep_core=0.1)
         _ = hash(looper)
@@ -189,8 +188,6 @@ class TestInfiniteLooper:
                 obj.counter += 1
                 await sleep(0.05)
 
-        class CustomError(Exception): ...
-
         @dataclass(kw_only=True)
         class Example(InfiniteLooper[None]):
             initializations: int = 0
@@ -205,18 +202,12 @@ class TestInfiniteLooper:
             async def _core(self) -> None:
                 self.counter += 1
                 if self.counter >= 5:
-                    self._set_event(None)
+                    self._set_event()
 
             @override
             def _yield_coroutines(self) -> Iterator[Callable[[], Coroutine1[None]]]:
                 yield partial(inc_external, self)
 
-            @override
-            def _yield_events_and_exceptions(
-                self,
-            ) -> Iterator[tuple[None, MaybeType[BaseException]]]:
-                yield (None, CustomError)
-
         looper = Example(sleep_core=0.05, sleep_restart=0.05)
         with raises(TimeoutError):
             async with timeout_dur(duration=1.0):
@@ -251,12 +242,6 @@ class TestInfiniteLooper:
             def _yield_coroutines(self) -> Iterator[Callable[[], Coroutine1[None]]]:
                 yield dummy
 
-            @override
-            def _yield_events_and_exceptions(
-                self,
-            ) -> Iterator[tuple[None, MaybeType[BaseException]]]:
-                yield (None, CustomError)
-
         looper = Example(sleep_core=0.05, sleep_restart=0.05)
         with raises(TimeoutError):
             async with timeout_dur(duration=1.0):
@@ -294,12 +279,6 @@ class TestInfiniteLooper:
             def _yield_coroutines(self) -> Iterator[Callable[[], Coroutine1[None]]]:
                 yield dummy
 
-            @override
-            def _yield_events_and_exceptions(
-                self,
-            ) -> Iterator[tuple[None, MaybeType[BaseException]]]:
-                yield (None, CustomError)
-
         looper = Example(sleep_core=0.05, sleep_restart=0.05, logger=logger)
         with raises(CancelledError):
             async with timeout_dur(duration=1.0):
@@ -307,6 +286,17 @@ class TestInfiniteLooper:
         assert 3 <= looper.initializations <= 5
         assert 1 <= looper.counter <= 6
 
+    async def test_error_default_event(self) -> None:
+        @dataclass(kw_only=True)
+        class Example(InfiniteLooper[None]): ...
+
+        looper = Example()
+
+        with raises(
+            _InfiniteLooperDefaultEventError, match=r"'Example' default event error"
+        ):
+            raise _InfiniteLooperDefaultEventError(looper=looper)
+
     @given(logger=just("logger") | none())
     @mark.parametrize(
         ("sleep_restart", "desc"),
@@ -321,7 +311,7 @@ class TestInfiniteLooper:
     async def test_error_upon_initialize(
         self,
         *,
-        sleep_restart: _DurationOrEvery,
+        sleep_restart: DurationOrEveryDuration,
         desc: str,
         logger: str | None,
         caplog: LogCaptureFixture,
@@ -361,7 +351,7 @@ class TestInfiniteLooper:
     async def test_error_group_upon_coroutines(
         self,
         *,
-        sleep_restart: _DurationOrEvery,
+        sleep_restart: DurationOrEveryDuration,
         desc: str,
         logger: str | None,
         caplog: LogCaptureFixture,
@@ -374,12 +364,6 @@ class TestInfiniteLooper:
             async def _core(self) -> None:
                 raise CustomError
 
-            @override
-            def _yield_events_and_exceptions(
-                self,
-            ) -> Iterator[tuple[None, MaybeType[BaseException]]]:
-                yield (None, CustomError)
-
         looper = Example(sleep_core=0.1, sleep_restart=sleep_restart, logger=logger)
         with raises(TimeoutError):
             async with timeout_dur(duration=0.5):
@@ -402,10 +386,13 @@ class TestInfiniteLooper:
             async def _core(self) -> None:
                 self.counter += 1
                 if self.counter >= 10:
-                    self._set_event(None)
+                    self._set_event(event=cast("Any", "invalid"))
 
-        looper = Example(sleep_core=0.1)
-        with raises(InfiniteLooperError, match="'Example' does not have an event None"):
+        looper = Example()
+        with raises(
+            _InfiniteLooperNoSuchEventError,
+            match="'Example' does not have an event 'invalid'",
+        ):
             _ = await looper()
 
 

{dycw_utilities-0.120.0 → dycw_utilities-0.121.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.120.0"
+__version__ = "0.121.0"

{dycw_utilities-0.120.0 → dycw_utilities-0.121.0}/src/utilities/asyncio.py

@@ -26,7 +26,6 @@ from typing import (
     TYPE_CHECKING,
     Any,
     Generic,
-    Literal,
     NoReturn,
     TextIO,
     TypeVar,
@@ -49,6 +48,7 @@ from utilities.reprlib import get_repr
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import (
     Coroutine1,
+    DurationOrEveryDuration,
     MaybeCallableEvent,
     MaybeType,
     THashable,
@@ -121,17 +121,14 @@ class EnhancedTaskGroup(TaskGroup):
 ##
 
 
-type _DurationOrEvery = Duration | tuple[Literal["every"], Duration]
-
-
 @dataclass(kw_only=True, unsafe_hash=True)
 class InfiniteLooper(ABC, Generic[THashable]):
     """An infinite loop which can throw exceptions by setting events."""
 
-    sleep_core: _DurationOrEvery = SECOND
-    sleep_restart: _DurationOrEvery = MINUTE
+    sleep_core: DurationOrEveryDuration = SECOND
+    sleep_restart: DurationOrEveryDuration = MINUTE
     logger: str | None = None
-    _events: Mapping[THashable, Event] = field(
+    _events: Mapping[THashable | None, Event] = field(
         default_factory=dict, init=False, repr=False, hash=False
     )
 
@@ -229,7 +226,7 @@ class InfiniteLooper(ABC, Generic[THashable]):
             msgs.append(f"Sleeping {self._sleep_restart_desc}...")
             getLogger(name=self.logger).error("\n".join(msgs))
 
-    def _raise_error(self, event: THashable, /) -> NoReturn:
+    def _raise_error(self, event: THashable | None, /) -> NoReturn:
         """Raise the error corresponding to given event."""
         mapping = dict(self._yield_events_and_exceptions())
         error = mapping.get(event, InfiniteLooperError)
@@ -241,7 +238,7 @@ class InfiniteLooper(ABC, Generic[THashable]):
             event: Event() for event, _ in self._yield_events_and_exceptions()
         }
 
-    async def _run_sleep(self, sleep: _DurationOrEvery, /) -> None:
+    async def _run_sleep(self, sleep: DurationOrEveryDuration, /) -> None:
         """Sleep until the next part of the loop."""
         match sleep:
             case int() | float() | dt.timedelta() as duration:
@@ -264,12 +261,12 @@ class InfiniteLooper(ABC, Generic[THashable]):
             case _ as never:
                 assert_never(never)
 
-    def _set_event(self, event: THashable, /) -> None:
+    def _set_event(self, *, event: THashable | None = None) -> None:
         """Set the given event."""
         try:
             event_obj = self._events[event]
         except KeyError:
-            raise InfiniteLooperError(looper=self, event=event) from None
+            raise _InfiniteLooperNoSuchEventError(looper=self, event=event) from None
         event_obj.set()
 
     def _yield_coroutines(self) -> Iterator[Callable[[], Coroutine1[None]]]:
@@ -278,14 +275,18 @@ class InfiniteLooper(ABC, Generic[THashable]):
 
     def _yield_events_and_exceptions(
         self,
-    ) -> Iterator[tuple[THashable, MaybeType[BaseException]]]:
+    ) -> Iterator[tuple[THashable | None, MaybeType[BaseException]]]:
         """Yield the events & exceptions."""
-        yield from []
+        yield (None, _InfiniteLooperDefaultEventError)
 
 
 @dataclass(kw_only=True, slots=True)
 class InfiniteLooperError(Exception):
     looper: InfiniteLooper[Any]
+
+
+@dataclass(kw_only=True, slots=True)
+class _InfiniteLooperNoSuchEventError(InfiniteLooperError):
     event: Hashable
 
     @override
@@ -293,6 +294,13 @@ class InfiniteLooperError(Exception):
         return f"{get_class_name(self.looper)!r} does not have an event {self.event!r}"
 
 
+@dataclass(kw_only=True, slots=True)
+class _InfiniteLooperDefaultEventError(InfiniteLooperError):
+    @override
+    def __str__(self) -> str:
+        return f"{get_class_name(self.looper)!r} default event error"
+
+
 ##
 
 

{dycw_utilities-0.120.0 → dycw_utilities-0.121.0}/src/utilities/types.py

@@ -92,6 +92,7 @@ type DateTimeLike = MaybeStr[dt.datetime]
 type DateOrDateTime = dt.date | dt.datetime
 type Duration = Number | dt.timedelta
 type DurationLike = MaybeStr[Duration]
+type DurationOrEveryDuration = Duration | tuple[Literal["every"], Duration]
 type MaybeCallableDate = MaybeCallable[dt.date]
 type MaybeCallableDateTime = MaybeCallable[dt.datetime]
 type TimeLike = MaybeStr[dt.time]
@@ -270,6 +271,7 @@ __all__ = [
     "DateTimeLike",
     "Duration",
     "DurationLike",
+    "DurationOrEveryDuration",
     "EnumLike",
     "ExcInfo",
     "IterableHashable",