dycw-utilities 0.113.3__tar.gz → 0.113.5__tar.gz

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.113.3
+Version: 0.113.5
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
 Requires-Dist: typing-extensions<4.14,>=4.13.1
 Provides-Extra: test
-Requires-Dist: hypothesis<6.132,>=6.131.14; extra == 'test'
+Requires-Dist: hypothesis<6.132,>=6.131.15; extra == 'test'
 Requires-Dist: pytest-asyncio<0.27,>=0.26.0; extra == 'test'
 Requires-Dist: pytest-cov<6.2,>=6.1.1; extra == 'test'
 Requires-Dist: pytest-instafail<0.6,>=0.5.0; extra == 'test'
@@ -14,7 +14,7 @@ Requires-Dist: pytest-lazy-fixtures<1.2,>=1.1.2; extra == 'test'
 Requires-Dist: pytest-only<2.2,>=2.1.2; extra == 'test'
 Requires-Dist: pytest-randomly<3.17,>=3.16.0; extra == 'test'
 Requires-Dist: pytest-regressions<2.8,>=2.7.0; extra == 'test'
-Requires-Dist: pytest-rerunfailures<16,>=15.0; extra == 'test'
+Requires-Dist: pytest-rerunfailures<16,>=15.1; extra == 'test'
 Requires-Dist: pytest-rng<1.1,>=1.0.0; extra == 'test'
 Requires-Dist: pytest-timeout<2.5,>=2.4.0; extra == 'test'
 Requires-Dist: pytest-xdist<3.7,>=3.6.1; extra == 'test'
@@ -37,7 +37,7 @@ Requires-Dist: atools<0.15,>=0.14.2; extra == 'zzz-test-atools'
 Provides-Extra: zzz-test-cachetools
 Requires-Dist: cachetools<5.6,>=5.5.2; extra == 'zzz-test-cachetools'
 Provides-Extra: zzz-test-click
-Requires-Dist: click<8.2,>=8.1.8; extra == 'zzz-test-click'
+Requires-Dist: click<8.3,>=8.2.0; extra == 'zzz-test-click'
 Requires-Dist: sqlalchemy<2.1,>=2.0.40; extra == 'zzz-test-click'
 Requires-Dist: whenever<0.8,>=0.7.3; extra == 'zzz-test-click'
 Provides-Extra: zzz-test-contextlib
@@ -80,7 +80,7 @@ Provides-Extra: zzz-test-hypothesis
 Requires-Dist: aiosqlite<0.22,>=0.21.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: asyncpg<0.31,>=0.30.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: greenlet<3.3,>=3.2.0; extra == 'zzz-test-hypothesis'
-Requires-Dist: hypothesis<6.132,>=6.131.14; extra == 'zzz-test-hypothesis'
+Requires-Dist: hypothesis<6.132,>=6.131.15; extra == 'zzz-test-hypothesis'
 Requires-Dist: luigi<3.7,>=3.6.0; extra == 'zzz-test-hypothesis'
 Requires-Dist: numpy<2.3,>=2.2.5; extra == 'zzz-test-hypothesis'
 Requires-Dist: pathvalidate<3.3,>=3.2.3; extra == 'zzz-test-hypothesis'
@@ -101,7 +101,7 @@ Requires-Dist: polars-lts-cpu<1.30,>=1.29.0; extra == 'zzz-test-jupyter'
 Provides-Extra: zzz-test-logging
 Requires-Dist: atomicwrites<1.5,>=1.4.1; extra == 'zzz-test-logging'
 Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'zzz-test-logging'
-Requires-Dist: concurrent-log-handler<0.10,>=0.9.25; extra == 'zzz-test-logging'
+Requires-Dist: concurrent-log-handler<0.10,>=0.9.26; extra == 'zzz-test-logging'
 Requires-Dist: rich<14.1,>=14.0.0; extra == 'zzz-test-logging'
 Requires-Dist: tomlkit<0.14,>=0.13.2; extra == 'zzz-test-logging'
 Requires-Dist: tzlocal<5.4,>=5.3.1; extra == 'zzz-test-logging'
@@ -172,7 +172,7 @@ Requires-Dist: whenever<0.8,>=0.7.3; extra == 'zzz-test-redis'
 Provides-Extra: zzz-test-rich
 Requires-Dist: rich<14.1,>=14.0.0; extra == 'zzz-test-rich'
 Provides-Extra: zzz-test-scipy
-Requires-Dist: scipy<1.16,>=1.15.2; extra == 'zzz-test-scipy'
+Requires-Dist: scipy<1.16,>=1.15.3; extra == 'zzz-test-scipy'
 Provides-Extra: zzz-test-sentinel
 Provides-Extra: zzz-test-shelve
 Provides-Extra: zzz-test-slack-sdk

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/pyproject.toml

@@ -16,9 +16,9 @@ dev = [
   "atomicwrites >= 1.4.1, < 1.5",
   "atools >= 0.14.2, < 0.15",
   "cachetools >= 5.5.2, < 5.6",
-  "click >= 8.1.8, < 8.2",
+  "click >= 8.2.0, < 8.3",
   "coloredlogs >= 15.0.1, < 15.1",
-  "concurrent-log-handler >= 0.9.25, < 0.10",
+  "concurrent-log-handler >= 0.9.26, < 0.10",
   "cryptography >= 44.0.2, < 44.1",
   "cvxpy >= 1.6.5, < 1.7",
   "eventkit >= 1.0.3, < 1.1",
@@ -26,7 +26,7 @@ dev = [
   "fpdf2 >= 2.8.3, < 2.9",
   "greenlet >= 3.2.0, < 3.3",  # for sqlalchemy async
   "httpx >= 0.28.1, < 0.29",  # for fastapi
-  "hypothesis >= 6.131.14, < 6.132",
+  "hypothesis >= 6.131.15, < 6.132",
   "img2pdf >= 0.6.0, < 0.7",
   "lightweight-charts >= 2.1, < 2.2",
   "loguru >= 0.7.3, < 0.8",
@@ -52,7 +52,7 @@ dev = [
   "redis >= 6.0.0, < 6.1",
   "rich >= 14.0.0, < 14.1",
   "scikit-learn >= 1.6.1, < 1.7",
-  "scipy >= 1.15.2, < 1.16",
+  "scipy >= 1.15.3, < 1.16",
   "slack-sdk >= 3.35.0, < 3.36",
   "sqlalchemy >= 2.0.40, < 2.1",
   "statsmodels >= 0.14.4, < 0.15",
@@ -74,7 +74,7 @@ dev = [
   "pytest-lazy-fixtures >= 1.1.2, < 1.2",
   "pytest-only >= 2.1.2, < 2.2",
   "pytest-randomly >= 3.16.0, < 3.17",
-  "pytest-rerunfailures >= 15.0, < 16",
+  "pytest-rerunfailures >= 15.1, < 16",
   "pytest-rng >= 1.0.0, < 1.1",
   "pytest-timeout >= 2.4.0, < 2.5",
   "pytest-xdist >= 3.6.1, < 3.7",
@@ -92,11 +92,11 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.113.3"
+version = "0.113.5"
 
 [project.optional-dependencies]
 test = [
-  "hypothesis >= 6.131.14, < 6.132",
+  "hypothesis >= 6.131.15, < 6.132",
   "pytest >= 8.3.5, < 8.4",
   "pytest-asyncio >= 0.26.0, < 0.27",
   "pytest-cov >= 6.1.1, < 6.2",
@@ -105,7 +105,7 @@ test = [
   "pytest-only >= 2.1.2, < 2.2",
   "pytest-randomly >= 3.16.0, < 3.17",
   "pytest-regressions >= 2.7.0, < 2.8",
-  "pytest-rerunfailures >= 15.0, < 16",
+  "pytest-rerunfailures >= 15.1, < 16",
   "pytest-rng >= 1.0.0, < 1.1",
   "pytest-timeout >= 2.4.0, < 2.5",
   "pytest-xdist >= 3.6.1, < 3.7",
@@ -127,7 +127,7 @@ zzz-test-atools = [
 ]
 zzz-test-cachetools = ["cachetools >= 5.5.2, < 5.6"]
 zzz-test-click = [
-  "click >= 8.1.8, < 8.2",
+  "click >= 8.2.0, < 8.3",
   "sqlalchemy >= 2.0.40, < 2.1",
   "whenever >= 0.7.3, < 0.8",
 ]
@@ -174,7 +174,7 @@ zzz-test-hypothesis = [
   "aiosqlite >= 0.21.0, < 0.22",
   "asyncpg >= 0.30.0, < 0.31",  # for sqlalchemy async
   "greenlet >= 3.2.0, < 3.3",  # for sqlalchemy async
-  "hypothesis >= 6.131.14, < 6.132",
+  "hypothesis >= 6.131.15, < 6.132",
   "luigi >= 3.6.0, < 3.7",
   "numpy >= 2.2.5, < 2.3",
   "pathvalidate >= 3.2.3, < 3.3",
@@ -197,7 +197,7 @@ zzz-test-jupyter = [
 zzz-test-logging = [
   "atomicwrites >= 1.4.1, < 1.5",
   "coloredlogs >= 15.0.1, < 15.1",
-  "concurrent-log-handler >= 0.9.25, < 0.10",
+  "concurrent-log-handler >= 0.9.26, < 0.10",
   "rich >= 14.0.0, < 14.1",
   "tomlkit >= 0.13.2, < 0.14",
   "tzlocal >= 5.3.1, < 5.4",
@@ -266,7 +266,7 @@ zzz-test-redis = [
   "whenever >= 0.7.3, < 0.8",
 ]
 zzz-test-rich = ["rich >= 14.0.0, < 14.1"]
-zzz-test-scipy = ["scipy >= 1.15.2, < 1.16"]
+zzz-test-scipy = ["scipy >= 1.15.3, < 1.16"]
 zzz-test-sentinel = []
 zzz-test-shelve = []
 zzz-test-slack-sdk = [
@@ -334,7 +334,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.113.3"
+current_version = "0.113.5"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/src/tests/test_asyncio.py

@@ -35,6 +35,7 @@ from utilities.asyncio import (
     AsyncService,
     EnhancedTaskGroup,
     ExceptionProcessor,
+    InfiniteLooper,
     QueueProcessor,
     UniquePriorityQueue,
     UniqueQueue,
@@ -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:
@@ -401,6 +404,89 @@ class TestGetItemsNoWait:
             assert result == xs[:max_size]
 
 
+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 TestQueueProcessor:
     async def test_one_processor_slow_tasks(self) -> None:
         @dataclass(kw_only=True)

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/src/tests/test_click.py

@@ -102,12 +102,12 @@ class TestFileAndDirPaths:
         file_path.touch()
         result = CliRunner().invoke(cli, [str(file_path)])
         assert result.exit_code == 2
-        assert search("is a file", result.stdout)
+        assert search("is a file", result.stderr)
 
         non_existent = tmp_path.joinpath("non-existent")
         result = CliRunner().invoke(cli, [str(non_existent)])
         assert result.exit_code == 2
-        assert search("does not exist", result.stdout)
+        assert search("does not exist", result.stderr)
 
     def test_existing_file_path(self, *, tmp_path: Path) -> None:
         @command()
@@ -119,7 +119,7 @@ class TestFileAndDirPaths:
 
         result = CliRunner().invoke(cli, [str(tmp_path)])
         assert result.exit_code == 2
-        assert search("is a directory", result.stdout)
+        assert search("is a directory", result.stderr)
 
         file_path = tmp_path.joinpath("file.txt")
         file_path.touch()
@@ -129,7 +129,7 @@ class TestFileAndDirPaths:
         non_existent = tmp_path.joinpath("non-existent")
         result = CliRunner().invoke(cli, [str(non_existent)])
         assert result.exit_code == 2
-        assert search("does not exist", result.stdout)
+        assert search("does not exist", result.stderr)
 
     def test_dir_path(self, *, tmp_path: Path) -> None:
         @command()
@@ -146,7 +146,7 @@ class TestFileAndDirPaths:
         file_path.touch()
         result = CliRunner().invoke(cli, [str(file_path)])
         assert result.exit_code == 2
-        assert search("is a file", result.stdout)
+        assert search("is a file", result.stderr)
 
         non_existent = tmp_path.joinpath("non-existent")
         result = CliRunner().invoke(cli, [str(non_existent)])
@@ -162,7 +162,7 @@ class TestFileAndDirPaths:
 
         result = CliRunner().invoke(cli, [str(tmp_path)])
         assert result.exit_code == 2
-        assert search("is a directory", result.stdout)
+        assert search("is a directory", result.stderr)
 
         file_path = tmp_path.joinpath("file.txt")
         file_path.touch()
@@ -394,7 +394,7 @@ class TestParameters:
         assert result.exit_code == 2
         assert search(
             "Invalid value for '--value': Object '0' of type 'int' must be a string",
-            result.stdout,
+            result.stderr,
         )
 
 

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/src/utilities/__init__.py

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

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/src/utilities/asyncio.py

@@ -17,7 +17,7 @@ from asyncio import (
     sleep,
     timeout,
 )
-from collections.abc import Callable
+from collections.abc import Callable, Mapping
 from contextlib import (
     AsyncExitStack,
     _AsyncGeneratorContextManager,
@@ -39,11 +39,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
@@ -320,6 +326,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."""
 

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/src/utilities/click.py

@@ -125,7 +125,8 @@ class Enum(ParamType, Generic[TEnum]):
             self.fail(str(error), param, ctx)
 
     @override
-    def get_metavar(self, param: Parameter) -> str | None:
+    def get_metavar(self, param: Parameter, ctx: Context) -> str | None:
+        _ = ctx
         desc = ",".join(e.name for e in self._enum)
         return _make_metavar(param, desc)
 
@@ -273,8 +274,8 @@ class FrozenSetParameter(ParamType, Generic[_TParam, _T]):
         return frozenset(self._param.convert(v, param, ctx) for v in values)
 
     @override
-    def get_metavar(self, param: Parameter) -> str | None:
-        if (metavar := self._param.get_metavar(param)) is None:
+    def get_metavar(self, param: Parameter, ctx: Context) -> str | None:
+        if (metavar := self._param.get_metavar(param, ctx)) is None:
             name = self.name.upper()
         else:
             name = f"FROZENSET{metavar}"
@@ -397,8 +398,8 @@ class ListParameter(ParamType, Generic[_TParam, _T]):
         return [self._param.convert(v, param, ctx) for v in values]
 
     @override
-    def get_metavar(self, param: Parameter) -> str | None:
-        if (metavar := self._param.get_metavar(param)) is None:
+    def get_metavar(self, param: Parameter, ctx: Context) -> str | None:
+        if (metavar := self._param.get_metavar(param, ctx)) is None:
             name = self.name.upper()
         else:
             name = f"LIST{metavar}"

{dycw_utilities-0.113.3 → dycw_utilities-0.113.5}/src/utilities/redis.py

@@ -607,7 +607,7 @@ class Publisher(QueueProcessor[tuple[str, EncodableT]]):
 
 
 _SUBSCRIBE_TIMEOUT: Duration = SECOND
-_SUBSCRIBE_SLEEP: Duration = 10 * MILLISECOND
+_SUBSCRIBE_SLEEP: Duration = MILLISECOND
 
 
 @overload
@@ -617,8 +617,8 @@ def subscribe(
     /,
     *,
     deserializer: Callable[[bytes], _T],
-    timeout: Duration | None = ...,
-    sleep: Duration = ...,
+    timeout: Duration | None = _SUBSCRIBE_TIMEOUT,
+    sleep: Duration = _SUBSCRIBE_SLEEP,
 ) -> AsyncIterator[_T]: ...
 @overload
 def subscribe(
@@ -627,8 +627,8 @@ def subscribe(
     /,
     *,
     deserializer: None = None,
-    timeout: Duration | None = ...,
-    sleep: Duration = ...,
+    timeout: Duration | None = _SUBSCRIBE_TIMEOUT,
+    sleep: Duration = _SUBSCRIBE_SLEEP,
 ) -> AsyncIterator[bytes]: ...
 async def subscribe(
     pubsub: PubSub,