dycw-utilities 0.125.23__py3-none-any.whl → 0.125.25__py3-none-any.whl

{dycw_utilities-0.125.23.dist-info → dycw_utilities-0.125.25.dist-info}/METADATA

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

{dycw_utilities-0.125.23.dist-info → dycw_utilities-0.125.25.dist-info}/RECORD

@@ -1,6 +1,6 @@
-utilities/__init__.py,sha256=wPKNBX6ygqFYs-IuHSilaZXm0vMIdcuqBGP9j1b_5O8,61
+utilities/__init__.py,sha256=3MYZAqKLfaJb4ielcVRGJ7gJj-yObA5kgfPLoc-wN1Q,61
 utilities/altair.py,sha256=Gpja-flOo-Db0PIPJLJsgzAlXWoKUjPU1qY-DQ829ek,9156
-utilities/asyncio.py,sha256=wtMOjHG85exqdwVBNH-DazTprkUCvMFv-JgY-9REhYs,51259
+utilities/asyncio.py,sha256=K5Kj7rsM0nA17-b7d7mrNgPR1U_NbkfQmTruq5LBLRA,51778
 utilities/atomicwrites.py,sha256=geFjn9Pwn-tTrtoGjDDxWli9NqbYfy3gGL6ZBctiqSo,5393
 utilities/atools.py,sha256=IYMuFSFGSKyuQmqD6v5IUtDlz8PPw0Sr87Cub_gRU3M,1168
 utilities/cachetools.py,sha256=C1zqOg7BYz0IfQFK8e3qaDDgEZxDpo47F15RTfJM37Q,2910
@@ -66,7 +66,7 @@ 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=Q8UakiB7qo6SUfaBDB0j1N4b8MuFzaD9lG5HGq7rtuw,3200
+utilities/slack_sdk.py,sha256=h2DiVkcFyYcT5zzZOAo6CSith5BBlHUbXeOJSL1neK8,5948
 utilities/socket.py,sha256=K77vfREvzoVTrpYKo6MZakol0EYu2q1sWJnnZqL0So0,118
 utilities/sqlalchemy.py,sha256=p8vsHaNRoeq5zJouIKyp9piFM26wtm5yR4DkzCMFDSw,35471
 utilities/sqlalchemy_polars.py,sha256=s7hQNep2O5DTgIRXyN_JRQma7a4DAtNd25tshaZW8iw,15490
@@ -90,7 +90,7 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 utilities/whenever.py,sha256=jS31ZAY5OMxFxLja_Yo5Fidi87Pd-GoVZ7Vi_teqVDA,16743
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=-5j7IQ9nb7gR43rdgA7ms05im-XuqhAk9EJnQBXxCoQ,1874
-dycw_utilities-0.125.23.dist-info/METADATA,sha256=sTzpB8MuDKbN3vHMg9otGuFDqzQ6Ko-_iYSb_9W94QY,12852
-dycw_utilities-0.125.23.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.125.23.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.125.23.dist-info/RECORD,,
+dycw_utilities-0.125.25.dist-info/METADATA,sha256=TYTHhscXtNic_ikhuiW7WQN30GUx2y-ay4RXYCt3qFI,12852
+dycw_utilities-0.125.25.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.125.25.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.125.25.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.125.23"
+__version__ = "0.125.25"

utilities/asyncio.py

@@ -688,6 +688,7 @@ class Looper(Generic[_T]):
     auto_start: bool = field(default=False, repr=False)
     freq: Duration = field(default=SECOND, repr=False)
     backoff: Duration = field(default=10 * SECOND, repr=False)
+    empty_upon_exit: bool = field(default=False, repr=False)
     logger: str | None = field(default=None, repr=False)
     timeout: Duration | None = field(default=None, repr=False)
     timeout_error: type[Exception] = field(default=LooperTimeoutError, repr=False)
@@ -791,6 +792,8 @@ class Looper(Generic[_T]):
                     )
                 _ = await self._stack.__aexit__(exc_type, exc_value, traceback)
                 await self.stop()
+                if self.empty_upon_exit:
+                    await self.run_until_empty()
             case False:
                 _ = self._debug and self._logger.debug("%s: already exited", self)
             case _ as never:
@@ -891,23 +894,27 @@ class Looper(Generic[_T]):
         self,
         *,
         auto_start: bool | Sentinel = sentinel,
+        empty_upon_exit: bool | Sentinel = sentinel,
         freq: Duration | Sentinel = sentinel,
         backoff: Duration | Sentinel = sentinel,
         logger: str | None | Sentinel = sentinel,
         timeout: Duration | None | Sentinel = sentinel,
         timeout_error: type[Exception] | Sentinel = sentinel,
         _debug: bool | Sentinel = sentinel,
+        **kwargs: Any,
     ) -> Self:
         """Replace elements of the looper."""
         return replace_non_sentinel(
             self,
             auto_start=auto_start,
+            empty_upon_exit=empty_upon_exit,
             freq=freq,
             backoff=backoff,
             logger=logger,
             timeout=timeout,
             timeout_error=timeout_error,
             _debug=_debug,
+            **kwargs,
         )
 
     def request_restart(self) -> None:
@@ -1061,6 +1068,13 @@ class Looper(Generic[_T]):
                             self._core_successes += 1
                         await sleep(self._freq)
 
+    async def run_until_empty(self) -> None:
+        """Run until the queue is empty."""
+        while not self.empty():
+            await self.core()
+            if not self.empty():
+                await sleep(self._freq)
+
     @property
     def stats(self) -> _LooperStats:
         """Return the statistics."""

utilities/slack_sdk.py

@@ -3,14 +3,20 @@ from __future__ import annotations
 from dataclasses import dataclass
 from http import HTTPStatus
 from logging import NOTSET, Handler, LogRecord
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING, Any, Self, override
 
 from slack_sdk.webhook.async_client import AsyncWebhookClient
 
-from utilities.asyncio import InfiniteQueueLooper, timeout_dur
+from utilities.asyncio import (
+    InfiniteQueueLooper,
+    Looper,
+    LooperTimeoutError,
+    timeout_dur,
+)
 from utilities.datetime import MINUTE, SECOND, datetime_duration_to_float
 from utilities.functools import cache
 from utilities.math import safe_round
+from utilities.sentinel import Sentinel, sentinel
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -73,6 +79,90 @@ class SlackHandler(Handler, InfiniteQueueLooper[None, str]):
             await self.sender(self.url, text)
 
 
+@dataclass(init=False, unsafe_hash=True)
+class SlackHandlerService(Handler, Looper[str]):
+    """Service to send messages to Slack."""
+
+    @override
+    def __init__(
+        self,
+        *,
+        url: str,
+        auto_start: bool = False,
+        empty_upon_exit: bool = True,
+        freq: Duration = SECOND,
+        backoff: Duration = SECOND,
+        logger: str | None = None,
+        timeout: Duration | None = None,
+        timeout_error: type[Exception] = LooperTimeoutError,
+        _debug: bool = False,
+        level: int = NOTSET,
+        sender: Callable[[str, str], Coroutine1[None]] = _send_adapter,
+        send_timeout: Duration = SECOND,
+    ) -> None:
+        Looper.__init__(  # Looper first
+            self,
+            auto_start=auto_start,
+            freq=freq,
+            empty_upon_exit=empty_upon_exit,
+            backoff=backoff,
+            logger=logger,
+            timeout=timeout,
+            timeout_error=timeout_error,
+            _debug=_debug,
+        )
+        Looper.__post_init__(self)
+        Handler.__init__(self, level=level)  # Handler next
+        self.url = url
+        self.sender = sender
+        self.send_timeout = send_timeout
+
+    @override
+    def emit(self, record: LogRecord) -> None:
+        fmtted = self.format(record)
+        try:
+            self.put_right_nowait(fmtted)
+        except Exception:  # noqa: BLE001  # pragma: no cover
+            self.handleError(record)
+
+    @override
+    async def core(self) -> None:
+        await super().core()
+        if self.empty():
+            return
+        text = "\n".join(self.get_all_nowait())
+        async with timeout_dur(duration=self.send_timeout):
+            await self.sender(self.url, text)
+
+    @override
+    def replace(
+        self,
+        *,
+        auto_start: bool | Sentinel = sentinel,
+        empty_upon_exit: bool | Sentinel = sentinel,
+        freq: Duration | Sentinel = sentinel,
+        backoff: Duration | Sentinel = sentinel,
+        logger: str | None | Sentinel = sentinel,
+        timeout: Duration | None | Sentinel = sentinel,
+        timeout_error: type[Exception] | Sentinel = sentinel,
+        _debug: bool | Sentinel = sentinel,
+        **kwargs: Any,
+    ) -> Self:
+        """Replace elements of the looper."""
+        return super().replace(
+            url=self.url,
+            auto_start=auto_start,
+            empty_upon_exit=empty_upon_exit,
+            freq=freq,
+            backoff=backoff,
+            logger=logger,
+            timeout=timeout,
+            timeout_error=timeout_error,
+            _debug=_debug,
+            **kwargs,
+        )
+
+
 ##
 
 
@@ -106,4 +196,4 @@ def _get_client(url: str, /, *, timeout: Duration = _TIMEOUT) -> AsyncWebhookCli
     return AsyncWebhookClient(url, timeout=timeout_use)
 
 
-__all__ = ["SendToSlackError", "SlackHandler", "send_to_slack"]
+__all__ = ["SendToSlackError", "SlackHandler", "SlackHandlerService", "send_to_slack"]