dycw-utilities 0.113.4__tar.gz → 0.114.0__tar.gz

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/PKG-INFO

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

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/pyproject.toml

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

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/src/tests/test_asyncio.py

@@ -3,7 +3,6 @@ from __future__ import annotations
 from asyncio import (
     CancelledError,
     Event,
-    Lock,
     PriorityQueue,
     Queue,
     TaskGroup,
@@ -22,7 +21,6 @@ from hypothesis.strategies import (
     DataObject,
     data,
     integers,
-    just,
     lists,
     none,
     permutations,
@@ -35,12 +33,15 @@ from utilities.asyncio import (
     AsyncService,
     EnhancedTaskGroup,
     ExceptionProcessor,
+    InfiniteLooper,
     QueueProcessor,
     UniquePriorityQueue,
     UniqueQueue,
     get_event,
     get_items,
     get_items_nowait,
+    put_items,
+    put_items_nowait,
     sleep_dur,
     stream_command,
     timeout_dur,
@@ -54,7 +55,9 @@ from utilities.sentinel import Sentinel, sentinel
 from utilities.timer import Timer
 
 if TYPE_CHECKING:
-    from utilities.types import Duration, MaybeCallableEvent
+    from collections.abc import Mapping
+
+    from utilities.types import Duration, MaybeCallableEvent, MaybeType
 
 
 class TestAsyncLoopingService:
@@ -332,41 +335,110 @@ class TestGetEvent:
         assert get_event(event=lambda: event) is event
 
 
-class TestGetItems:
-    @given(
-        xs=lists(integers(), min_size=1),
-        max_size=integers(1, 10) | none(),
-        lock=just(Lock()) | none(),
-    )
-    async def test_put_then_get(
-        self, *, xs: list[int], max_size: int | None, lock: Lock | None
-    ) -> None:
+class TestInfiniteLooper:
+    @given(n=integers(10, 11))
+    async def test_main(self, *, n: int) -> None:
+        class CustomTrueError(BaseException): ...
+
+        class CustomFalseError(BaseException): ...
+
+        @dataclass(kw_only=True)
+        class Example(InfiniteLooper[bool]):
+            counter: int = field(init=False, repr=False)
+
+            @override
+            async def initialize(self) -> None:
+                self.counter = 0
+
+            @override
+            async def core(self) -> None:
+                self.counter += 1
+                if self.counter >= n:
+                    self.events[n % 2 == 0].set()
+
+            @property
+            @override
+            def events_and_exceptions(self) -> Mapping[bool, MaybeType[BaseException]]:
+                return {True: CustomTrueError, False: CustomFalseError}
+
+        looper = Example(sleep_core=0.1)
+        match n % 2 == 0:
+            case True:
+                with raises(CustomTrueError):
+                    _ = await looper()
+            case False:
+                with raises(CustomFalseError):
+                    _ = await looper()
+
+    async def test_error_upon_initialize(self) -> None:
+        class CustomError(Exception): ...
+
+        @dataclass(kw_only=True)
+        class Example(InfiniteLooper[None]):
+            counter: int = field(init=False, repr=False)
+
+            @override
+            async def initialize(self) -> None:
+                raise CustomError
+
+            @override
+            async def core(self) -> None:
+                raise NotImplementedError
+
+            @property
+            @override
+            def events_and_exceptions(self) -> Mapping[None, MaybeType[BaseException]]:
+                return {None: CustomError}
+
+        with raises(TimeoutError):
+            async with timeout_dur(duration=0.5):
+                _ = await Example(sleep_core=0.1)()
+
+    async def test_error_upon_core(self) -> None:
+        class CustomError(Exception): ...
+
+        @dataclass(kw_only=True)
+        class Example(InfiniteLooper[None]):
+            counter: int = field(init=False, repr=False)
+
+            @override
+            async def initialize(self) -> None: ...
+
+            @override
+            async def core(self) -> None:
+                raise CustomError
+
+            @property
+            @override
+            def events_and_exceptions(self) -> Mapping[None, MaybeType[BaseException]]:
+                return {None: CustomError}
+
+        with raises(TimeoutError):
+            async with timeout_dur(duration=0.5):
+                _ = await Example(sleep_core=0.1)()
+
+
+class TestPutAndGetItems:
+    @given(xs=lists(integers(), min_size=1), max_size=integers(1, 10) | none())
+    async def test_put_then_get(self, *, xs: list[int], max_size: int | None) -> None:
         queue: Queue[int] = Queue()
-        for x in xs:
-            await queue.put(x)
-        result = await get_items(queue, max_size=max_size, lock=lock)
+        await put_items(xs, queue)
+        result = await get_items(queue, max_size=max_size)
         if max_size is None:
             assert result == xs
         else:
             assert result == xs[:max_size]
 
-    @given(
-        xs=lists(integers(), min_size=1),
-        max_size=integers(1, 10) | none(),
-        lock=just(Lock()) | none(),
-    )
-    async def test_get_then_put(
-        self, *, xs: list[int], max_size: int | None, lock: Lock | None
-    ) -> None:
+    @given(xs=lists(integers(), min_size=1), max_size=integers(1, 10) | none())
+    async def test_get_then_put(self, *, xs: list[int], max_size: int | None) -> None:
         queue: Queue[int] = Queue()
 
         async def put() -> None:
             await sleep(0.01)
-            for x in xs:
-                await queue.put(x)
+            await put_items(xs, queue)
 
         async with TaskGroup() as tg:
-            task = tg.create_task(get_items(queue, max_size=max_size, lock=lock))
+            task = tg.create_task(get_items(queue, max_size=max_size))
             _ = tg.create_task(put())
         result = task.result()
         if max_size is None:
@@ -382,19 +454,12 @@ class TestGetItems:
                 _ = tg.create_task(sleep(0.02))
 
 
-class TestGetItemsNoWait:
-    @given(
-        xs=lists(integers(), min_size=1),
-        max_size=integers(1, 10) | none(),
-        lock=just(Lock()) | none(),
-    )
-    async def test_main(
-        self, *, xs: list[int], max_size: int | None, lock: Lock | None
-    ) -> None:
+class TestPutAndGetItemsNoWait:
+    @given(xs=lists(integers(), min_size=1), max_size=integers(1, 10) | none())
+    def test_main(self, *, xs: list[int], max_size: int | None) -> None:
         queue: Queue[int] = Queue()
-        for x in xs:
-            await queue.put(x)
-        result = await get_items_nowait(queue, max_size=max_size, lock=lock)
+        put_items_nowait(xs, queue)
+        result = get_items_nowait(queue, max_size=max_size)
         if max_size is None:
             assert result == xs
         else:
@@ -524,7 +589,7 @@ class TestQueueProcessor:
 
             @override
             async def _process_item(self, _: int, /) -> None:
-                items = await self._get_items_nowait()
+                items = self._get_items_nowait()
                 self.output.add(len(items))
 
         processor = Example()

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.113.4"
+__version__ = "0.114.0"

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/src/utilities/asyncio.py

@@ -4,7 +4,6 @@ from abc import ABC, abstractmethod
 from asyncio import (
     CancelledError,
     Event,
-    Lock,
     PriorityQueue,
     Queue,
     QueueEmpty,
@@ -17,7 +16,7 @@ from asyncio import (
     sleep,
     timeout,
 )
-from collections.abc import Callable
+from collections.abc import Callable, Iterable, Mapping
 from contextlib import (
     AsyncExitStack,
     _AsyncGeneratorContextManager,
@@ -39,11 +38,17 @@ from typing import (
     override,
 )
 
-from utilities.datetime import MILLISECOND, datetime_duration_to_float
+from utilities.datetime import MILLISECOND, MINUTE, SECOND, datetime_duration_to_float
 from utilities.errors import ImpossibleCaseError
 from utilities.functions import ensure_int, ensure_not_none
 from utilities.sentinel import Sentinel, sentinel
-from utilities.types import MaybeCallableEvent, THashable, TSupportsRichComparison
+from utilities.types import (
+    Coroutine1,
+    MaybeCallableEvent,
+    MaybeType,
+    THashable,
+    TSupportsRichComparison,
+)
 
 if TYPE_CHECKING:
     from asyncio import _CoroutineLike
@@ -234,7 +239,6 @@ class QueueProcessor(AsyncService, Generic[_T]):
     sleep: Duration = MILLISECOND
     _await_upon_aenter: bool = field(default=False, init=False, repr=False)
     _queue: Queue[_T] = field(init=False, repr=False)
-    _lock: Lock = field(default_factory=Lock, init=False, repr=False)
 
     def __post_init__(self) -> None:
         self._queue = self.queue_type(
@@ -259,9 +263,9 @@ class QueueProcessor(AsyncService, Generic[_T]):
             await self._run()
             await sleep_dur(duration=self.sleep)
 
-    async def _get_items_nowait(self, *, max_size: int | None = None) -> Sequence[_T]:
+    def _get_items_nowait(self, *, max_size: int | None = None) -> Sequence[_T]:
         """Get items from the queue; no waiting."""
-        return await get_items_nowait(self._queue, max_size=max_size, lock=self._lock)
+        return get_items_nowait(self._queue, max_size=max_size)
 
     @abstractmethod
     async def _process_item(self, item: _T, /) -> None:
@@ -276,7 +280,7 @@ class QueueProcessor(AsyncService, Generic[_T]):
     async def _run(self) -> None:
         """Run the processer."""
         try:
-            (item,) = await self._get_items_nowait(max_size=1)
+            (item,) = self._get_items_nowait(max_size=1)
         except ValueError:
             raise QueueEmpty from None
         try:
@@ -320,6 +324,70 @@ class ExceptionProcessor(QueueProcessor[Exception | type[Exception]]):
 ##
 
 
+@dataclass(kw_only=True)
+class InfiniteLooper(ABC, Generic[THashable]):
+    """An infinite loop which can throw exceptions by setting events."""
+
+    events: Mapping[THashable, Event] = field(
+        default_factory=dict, init=False, repr=False
+    )
+    sleep_core: Duration = SECOND
+    sleep_restart: Duration = MINUTE
+
+    def __post_init__(self) -> None:
+        self._reset_events()
+
+    async def __call__(self) -> Coroutine1[None]:
+        while True:
+            try:
+                self._reset_events()
+                try:
+                    await self.initialize()
+                except Exception as error:  # noqa: BLE001
+                    self.error_upon_initialize(error)
+                    await sleep_dur(duration=self.sleep_restart)
+                else:
+                    while True:
+                        try:
+                            event = next(
+                                key
+                                for (key, value) in self.events.items()
+                                if value.is_set()
+                            )
+                        except StopIteration:
+                            await self.core()
+                            await sleep_dur(duration=self.sleep_core)
+                        else:
+                            raise self.events_and_exceptions[event]
+            except Exception as error:  # noqa: BLE001
+                self.error_upon_core(error)
+                await sleep_dur(duration=self.sleep_restart)
+
+    @property
+    @abstractmethod
+    def events_and_exceptions(self) -> Mapping[THashable, MaybeType[BaseException]]:
+        """A mapping of events to exceptions."""
+
+    async def initialize(self) -> None:
+        """Initialize the loop."""
+
+    async def core(self) -> None:
+        """Run the core."""
+
+    def error_upon_initialize(self, error: Exception, /) -> None:
+        _ = error
+
+    def error_upon_core(self, error: Exception, /) -> None:
+        _ = error
+
+    def _reset_events(self) -> None:
+        """Reset the events."""
+        self.events = {event: Event() for event in self.events_and_exceptions}
+
+
+##
+
+
 class UniquePriorityQueue(PriorityQueue[tuple[TSupportsRichComparison, THashable]]):
     """Priority queue with unique tasks."""
 
@@ -395,9 +463,7 @@ def get_event(
 ##
 
 
-async def get_items(
-    queue: Queue[_T], /, *, max_size: int | None = None, lock: Lock | None = None
-) -> list[_T]:
+async def get_items(queue: Queue[_T], /, *, max_size: int | None = None) -> list[_T]:
     """Get items from a queue; if empty then wait."""
     try:
         items = [await queue.get()]
@@ -406,28 +472,12 @@ async def get_items(
             return []
         raise
     max_size_use = None if max_size is None else (max_size - 1)
-    if lock is None:
-        items.extend(await get_items_nowait(queue, max_size=max_size_use))
-    else:
-        async with lock:
-            items.extend(await get_items_nowait(queue, max_size=max_size_use))
+    items.extend(get_items_nowait(queue, max_size=max_size_use))
     return items
 
 
-async def get_items_nowait(
-    queue: Queue[_T], /, *, max_size: int | None = None, lock: Lock | None = None
-) -> list[_T]:
+def get_items_nowait(queue: Queue[_T], /, *, max_size: int | None = None) -> list[_T]:
     """Get items from a queue; no waiting."""
-    if lock is None:
-        return _get_items_nowait_core(queue, max_size=max_size)
-    async with lock:
-        return _get_items_nowait_core(queue, max_size=max_size)
-
-
-def _get_items_nowait_core(
-    queue: Queue[_T], /, *, max_size: int | None = None
-) -> list[_T]:
-    """Get all the items from a queue; no waiting."""
     items: list[_T] = []
     if max_size is None:
         while True:
@@ -447,6 +497,21 @@ def _get_items_nowait_core(
 ##
 
 
+async def put_items(items: Iterable[_T], queue: Queue[_T], /) -> None:
+    """Put items into a queue; if full then wait."""
+    for item in items:
+        await queue.put(item)
+
+
+def put_items_nowait(items: Iterable[_T], queue: Queue[_T], /) -> None:
+    """Put items into a queue; no waiting."""
+    for item in items:
+        queue.put_nowait(item)
+
+
+##
+
+
 async def sleep_dur(*, duration: Duration | None = None) -> None:
     """Sleep which accepts durations."""
     if duration is None:
@@ -532,6 +597,8 @@ __all__ = [
     "get_event",
     "get_items",
     "get_items_nowait",
+    "put_items",
+    "put_items_nowait",
     "sleep_dur",
     "stream_command",
     "timeout_dur",

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/src/utilities/slack_sdk.py

@@ -78,7 +78,7 @@ class SlackHandler(Handler, QueueProcessor[str]):
     @override
     async def _process_item(self, item: str, /) -> None:
         """Process the first item."""
-        items = list(chain([item], await self._get_items_nowait()))
+        items = list(chain([item], self._get_items_nowait()))
         text = "\n".join(items)
         try:
             async with timeout_dur(duration=self.timeout):

{dycw_utilities-0.113.4 → dycw_utilities-0.114.0}/src/utilities/sqlalchemy.py

@@ -627,7 +627,7 @@ class Upserter(QueueProcessor[_InsertItem]):
     @override
     async def _process_item(self, item: _InsertItem, /) -> None:
         """Process the first item."""
-        items = list(chain([item], await self._get_items_nowait()))
+        items = list(chain([item], self._get_items_nowait()))
         await self._pre_upsert(items)
         await upsert_items(
             self.engine,