dycw-utilities 0.113.5__py3-none-any.whl → 0.114.1__py3-none-any.whl

{dycw_utilities-0.113.5.dist-info → dycw_utilities-0.114.1.dist-info}/METADATA

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

{dycw_utilities-0.113.5.dist-info → dycw_utilities-0.114.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
-utilities/__init__.py,sha256=ZrPzCX_NTAeiRK-IwTswtKYPrKcHyvHM-9skmFcsa3Q,60
+utilities/__init__.py,sha256=cCgankjsOm9nkKXgXTLbYLmBYYnt73fexYfZXeoBRUc,60
 utilities/altair.py,sha256=Gpja-flOo-Db0PIPJLJsgzAlXWoKUjPU1qY-DQ829ek,9156
 utilities/astor.py,sha256=xuDUkjq0-b6fhtwjhbnebzbqQZAjMSHR1IIS5uOodVg,777
-utilities/asyncio.py,sha256=q6hRkJ8GLJcmbah9ifdkw9LUcXAZlLh0g10aZ8cjZ54,17883
+utilities/asyncio.py,sha256=XVvmVNXKhP246JawvQCpFh4bMOl_NYm7QM60e-zrSFQ,20850
 utilities/atomicwrites.py,sha256=geFjn9Pwn-tTrtoGjDDxWli9NqbYfy3gGL6ZBctiqSo,5393
 utilities/atools.py,sha256=IYMuFSFGSKyuQmqD6v5IUtDlz8PPw0Sr87Cub_gRU3M,1168
 utilities/cachetools.py,sha256=C1zqOg7BYz0IfQFK8e3qaDDgEZxDpo47F15RTfJM37Q,2910
@@ -64,9 +64,9 @@ utilities/rich.py,sha256=t50MwwVBsoOLxzmeVFSVpjno4OW6Ufum32skXbV8-Bs,1911
 utilities/scipy.py,sha256=X6ROnHwiUhAmPhM0jkfEh0-Fd9iRvwiqtCQMOLmOQF8,945
 utilities/sentinel.py,sha256=3jIwgpMekWgDAxPDA_hXMP2St43cPhciKN3LWiZ7kv0,1248
 utilities/shelve.py,sha256=HZsMwK4tcIfg3sh0gApx4-yjQnrY4o3V3ZRimvRhoW0,738
-utilities/slack_sdk.py,sha256=SeDNMh24IPiEBWoGMdgvrflUaFa9TGlTS03H9-NKaQw,4132
+utilities/slack_sdk.py,sha256=Gbla983KulSSXnNyzaXgYQLKoq84KvLH8SdhxU-jQ0Q,4126
 utilities/socket.py,sha256=K77vfREvzoVTrpYKo6MZakol0EYu2q1sWJnnZqL0So0,118
-utilities/sqlalchemy.py,sha256=GWzp54TP3F2mGhxPTn0c56KxxDeN9VKLMagcRSELhf4,35453
+utilities/sqlalchemy.py,sha256=bs7rD1f8yB0uaFMYgmjo8wEoGow0x6aiELSYTPY_Img,35447
 utilities/sqlalchemy_polars.py,sha256=wjJpoUo-yO9E2ujpG_06vV5r2OdvBiQ4yvV6wKCa2Tk,15605
 utilities/statsmodels.py,sha256=koyiBHvpMcSiBfh99wFUfSggLNx7cuAw3rwyfAhoKpQ,3410
 utilities/streamlit.py,sha256=U9PJBaKP1IdSykKhPZhIzSPTZsmLsnwbEPZWzNhJPKk,2955
@@ -87,7 +87,7 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 utilities/whenever.py,sha256=iLRP_-8CZtBpHKbGZGu-kjSMg1ZubJ-VSmgSy7Eudxw,17787
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=-Xm57PMMwDTYpxJdkiJG13wnbwK--I7XItBh5WVhD-o,1874
-dycw_utilities-0.113.5.dist-info/METADATA,sha256=A14piT2adjIjfWnw8bf7FeFVUDRZfuzcsKkbFdZLrzc,12943
-dycw_utilities-0.113.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.113.5.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.113.5.dist-info/RECORD,,
+dycw_utilities-0.114.1.dist-info/METADATA,sha256=Cw2lgBuLscK2IEbNCzzQltYWeAGsvTcdpsxT5CyWNJw,12943
+dycw_utilities-0.114.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.114.1.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.114.1.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.113.5"
+__version__ = "0.114.1"

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, Mapping
+from collections.abc import Callable, Hashable, Iterable, Iterator, Mapping
 from contextlib import (
     AsyncExitStack,
     _AsyncGeneratorContextManager,
@@ -31,6 +30,7 @@ from sys import stderr, stdout
 from typing import (
     TYPE_CHECKING,
     Generic,
+    NoReturn,
     Self,
     TextIO,
     TypeVar,
@@ -44,7 +44,6 @@ from utilities.errors import ImpossibleCaseError
 from utilities.functions import ensure_int, ensure_not_none
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import (
-    Coroutine1,
     MaybeCallableEvent,
     MaybeType,
     THashable,
@@ -240,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(
@@ -265,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:
@@ -282,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:
@@ -330,61 +328,155 @@ class ExceptionProcessor(QueueProcessor[Exception | type[Exception]]):
 class InfiniteLooper(ABC, Generic[THashable]):
     """An infinite loop which can throw exceptions by setting events."""
 
-    events: Mapping[THashable, Event] = field(
+    _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]:
+        self._events = {
+            event: Event() for event, _ in self._yield_events_and_exceptions()
+        }
+
+    async def __call__(self) -> None:
+        """Create a coroutine to run the looper."""
+        loopers = list(self._yield_loopers())
+        if len(loopers) == 0:
+            return await self._run_looper()
+        return await self._run_multiple_loopers(*loopers)
+
+    async def _run_looper(self) -> None:
+        """Run the looper by itself."""
         while True:
             try:
                 self._reset_events()
                 try:
-                    await self.initialize()
+                    await self._initialize()
                 except Exception as error:  # noqa: BLE001
-                    self.error_upon_initialize(error)
+                    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()
+                                for (key, value) in self._events.items()
                                 if value.is_set()
                             )
                         except StopIteration:
-                            await self.core()
+                            await self._core()
                             await sleep_dur(duration=self.sleep_core)
                         else:
-                            raise self.events_and_exceptions[event]
+                            self._raise_error(event)
+            except InfiniteLooperError:
+                raise
             except Exception as error:  # noqa: BLE001
-                self.error_upon_core(error)
+                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 _run_multiple_loopers(self, *loopers: InfiniteLooper) -> None:
+        """Run multiple loopers."""
+        while True:
+            self._reset_events()
+            try:
+                async with TaskGroup() as tg:
+                    _ = tg.create_task(self._run_looper())
+                    _ = [tg.create_task(looper()) for looper in loopers]
+            except Exception as error:  # noqa: BLE001
+                self._error_upon_core(error)  # pragma: no cover
+                await sleep_dur(duration=self.sleep_restart)  # pragma: no cover
 
-    async def initialize(self) -> None:
+    async def _initialize(self) -> None:
         """Initialize the loop."""
 
-    async def core(self) -> None:
-        """Run the core."""
+    async def _core(self) -> None:
+        """Run the core part of the loop."""
 
-    def error_upon_initialize(self, error: Exception, /) -> None:
+    def _error_upon_initialize(self, error: Exception, /) -> None:
+        """Handle any errors upon initializing the looper."""
         _ = error
 
-    def error_upon_core(self, error: Exception, /) -> None:
+    def _error_upon_core(self, error: Exception, /) -> None:
+        """Handle any errors upon running the core function."""
         _ = error
 
+    def _raise_error(self, event: THashable, /) -> NoReturn:
+        """Raise the error corresponding to given event."""
+        mapping = dict(self._yield_events_and_exceptions())
+        error = mapping.get(event, InfiniteLooperError)
+        raise error
+
     def _reset_events(self) -> None:
         """Reset the events."""
-        self.events = {event: Event() for event in self.events_and_exceptions}
+        self._events = {
+            event: Event() for event, _ in self._yield_events_and_exceptions()
+        }
+
+    def _set_event(self, event: THashable, /) -> None:
+        """Set the given event."""
+        try:
+            event_obj = self._events[event]
+        except KeyError:
+            raise InfiniteLooperError(event=event) from None
+        event_obj.set()
+
+    def _yield_events_and_exceptions(
+        self,
+    ) -> Iterator[tuple[THashable, MaybeType[BaseException]]]:
+        """Yield the events & exceptions."""
+        yield from []
+
+    def _yield_loopers(self) -> Iterator[InfiniteLooper]:
+        """Yield any other infinite loopers which must also be run."""
+        yield from []
+
+
+@dataclass(kw_only=True, slots=True)
+class InfiniteLooperError(Exception):
+    event: Hashable
+
+    @override
+    def __str__(self) -> str:
+        return f"No event {self.event!r} found"
+
+
+##
+
+
+@dataclass(kw_only=True)
+class InfiniteQueueLooper(InfiniteLooper[THashable], Generic[THashable, _T]):
+    """An infinite loop which processes a queue."""
+
+    queue_type: type[Queue[_T]] = field(default=Queue, repr=False)
+    _queue: Queue[_T] = field(init=False)
+    _current: Queue[_T] = field(init=False)
+
+    @override
+    def __post_init__(self) -> None:
+        super().__post_init__()
+        self._queue = self.queue_type()
+        self._current = self.queue_type()
+
+    @override
+    async def _core(self) -> None:
+        """Run the core part of the loop."""
+        items = await get_items(self._queue)
+        _ = get_items_nowait(self._current)
+        put_items_nowait(items, self._current)
+        try:
+            await self._process_items(*items)
+        except Exception:
+            put_items_nowait(items, self._queue)
+            raise
+
+    @abstractmethod
+    async def _process_items(self, *items: _T) -> None:
+        """Process the items."""
+
+    def put_items_nowait(self, *items: _T) -> None:
+        """Put items into the queue."""
+        put_items_nowait(items, self._queue)
 
 
 ##
@@ -465,9 +557,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()]
@@ -476,28 +566,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:
@@ -517,6 +591,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:
@@ -595,6 +684,7 @@ __all__ = [
     "AsyncService",
     "EnhancedTaskGroup",
     "ExceptionProcessor",
+    "InfiniteLooperError",
     "QueueProcessor",
     "StreamCommandOutput",
     "UniquePriorityQueue",
@@ -602,6 +692,8 @@ __all__ = [
     "get_event",
     "get_items",
     "get_items_nowait",
+    "put_items",
+    "put_items_nowait",
     "sleep_dur",
     "stream_command",
     "timeout_dur",

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):

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,