dycw-utilities 0.156.0__tar.gz → 0.157.1__tar.gz

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/PKG-INFO

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

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/pyproject.toml

@@ -227,7 +227,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.156.0"
+version = "0.157.1"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -259,7 +259,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.156.0"
+current_version = "0.157.1"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/tests/test_asyncio.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from asyncio import Queue, TaskGroup, run
+from asyncio import Queue, run
 from collections.abc import ItemsView, KeysView, ValuesView
 from contextlib import asynccontextmanager
 from re import search
@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING, ClassVar
 
 from hypothesis import HealthCheck, given, settings
 from hypothesis.strategies import booleans, dictionaries, integers, lists, none
-from pytest import LogCaptureFixture, RaisesGroup, mark, param, raises
+from pytest import RaisesGroup, raises
 
 from utilities.asyncio import (
     AsyncDict,
@@ -16,7 +16,6 @@ from utilities.asyncio import (
     get_coroutine_name,
     get_items,
     get_items_nowait,
-    loop_until_succeed,
     put_items,
     put_items_nowait,
     sleep_max,
@@ -29,7 +28,6 @@ from utilities.asyncio import (
 )
 from utilities.hypothesis import pairs, text_ascii
 from utilities.pytest import skipif_windows
-from utilities.text import unique_str
 from utilities.timer import Timer
 from utilities.whenever import MILLISECOND, SECOND, get_now
 
@@ -319,70 +317,6 @@ class TestGetItems:
         assert result == xs[:max_size]
 
 
-class TestLoopUntilSucceed:
-    @mark.parametrize("sleep", [param(MILLISECOND), param(None)])
-    @mark.parametrize("use_logger", [param(True), param(False)])
-    async def test_main(
-        self, *, caplog: LogCaptureFixture, sleep: TimeDelta | None, use_logger: bool
-    ) -> None:
-        class CustomError(Exception): ...
-
-        caplog.set_level("DEBUG", logger=(name := unique_str()))
-        counter = 0
-
-        async def func() -> None:
-            nonlocal counter
-            counter += 1
-            if counter <= 3:
-                raise CustomError
-
-        assert await loop_until_succeed(
-            lambda: func(), logger=name if use_logger else None, sleep=sleep
-        )
-        assert counter == 4
-
-        if use_logger:
-            messages = [r.message for r in caplog.records if r.name == name]
-            expected = 3 * (
-                ["Error running 'func'"]
-                + ([] if sleep is None else ["Sleeping for PT0.001S..."])
-                + ["Retrying 'func'..."]
-            )
-            assert messages == expected
-
-    async def test_error_flat(self) -> None:
-        class CustomError(Exception): ...
-
-        counter = 0
-
-        async def func() -> None:
-            nonlocal counter
-            counter += 1
-            if counter <= 3:
-                raise CustomError
-
-        assert not await loop_until_succeed(lambda: func(), errors=CustomError)
-        assert counter == 1
-
-    async def test_error_nested(self) -> None:
-        class CustomError(Exception): ...
-
-        counter = 0
-
-        async def func() -> None:
-            async with TaskGroup() as tg:
-                _ = tg.create_task(inner())
-
-        async def inner() -> None:
-            nonlocal counter
-            counter += 1
-            if counter <= 3:
-                raise CustomError
-
-        assert not await loop_until_succeed(lambda: func(), errors=CustomError)
-        assert counter == 1
-
-
 class TestPutItems:
     @given(xs=lists(integers(), min_size=1), wait=booleans())
     async def test_main(self, *, xs: list[int], wait: bool) -> None:

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/tests/test_logging.py

@@ -12,7 +12,7 @@ from hypothesis.strategies import booleans, integers
 from pytest import LogCaptureFixture, mark, param, raises
 
 from tests.conftest import SKIPIF_CI_AND_WINDOWS
-from utilities.hypothesis import pairs, temp_paths, text_ascii, zoned_date_times
+from utilities.hypothesis import pairs, temp_paths, zoned_date_times
 from utilities.iterables import one
 from utilities.logging import (
     GetLoggingLevelNumberError,
@@ -527,12 +527,12 @@ class TestToLogger:
     def test_default(self) -> None:
         assert to_logger().name == "root"
 
-    @given(name=text_ascii(min_size=1))
-    def test_logger(self, *, name: str) -> None:
+    def test_logger(self) -> None:
+        name = unique_str()
         assert to_logger(getLogger(name)).name == name
 
-    @given(name=text_ascii(min_size=1))
-    def test_str(self, *, name: str) -> None:
+    def test_str(self) -> None:
+        name = unique_str()
         assert to_logger(name).name == name
 
     def test_none(self) -> None:

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/tests/test_os.py

@@ -22,6 +22,7 @@ from utilities.os import (
     get_cpu_use,
     get_env_var,
     is_debug,
+    is_pytest,
     temp_environ,
 )
 from utilities.pytest import skipif_windows
@@ -124,6 +125,11 @@ class TestIsDebug:
         assert isinstance(result, bool)
 
 
+class TestIsPytest:
+    def test_main(self) -> None:
+        assert is_pytest()
+
+
 class TestTempEnviron:
     @given(key=text.map(_prefix), value=text)
     def test_set(self, *, key: str, value: str) -> None:

dycw_utilities-0.157.1/src/tests/test_pottery.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from asyncio import TaskGroup
+from typing import TYPE_CHECKING, ClassVar
+
+from pottery import AIORedlock
+from pytest import mark, param, raises
+
+from utilities.asyncio import sleep_td
+from utilities.pottery import (
+    _YieldAccessNumLocksError,
+    _YieldAccessUnableToAcquireLockError,
+    extend_lock,
+    yield_access,
+)
+from utilities.text import unique_str
+from utilities.timer import Timer
+from utilities.whenever import SECOND
+
+if TYPE_CHECKING:
+    from redis.asyncio import Redis
+    from whenever import TimeDelta
+
+
+class TestExtendLock:
+    async def test_main(self, *, test_redis: Redis) -> None:
+        lock = AIORedlock(key=unique_str(), masters={test_redis})
+        async with lock:
+            await extend_lock(lock=lock)
+
+    async def test_none(self) -> None:
+        await extend_lock()
+
+
+class TestYieldAccess:
+    delta: ClassVar[TimeDelta] = 0.1 * SECOND
+
+    @mark.parametrize(
+        ("num_tasks", "num_locks", "min_multiple"),
+        [
+            param(1, 1, 1),
+            param(1, 2, 1),
+            param(1, 3, 1),
+            param(2, 1, 2),
+            param(2, 2, 1),
+            param(2, 3, 1),
+            param(2, 4, 1),
+            param(2, 5, 1),
+            param(3, 1, 3),
+            param(3, 2, 2),
+            param(3, 3, 1),
+            param(3, 4, 1),
+            param(3, 5, 1),
+            param(4, 1, 4),
+            param(4, 2, 2),
+            param(4, 3, 2),
+            param(4, 4, 1),
+            param(4, 5, 1),
+        ],
+    )
+    async def test_main(
+        self, *, test_redis: Redis, num_tasks: int, num_locks: int, min_multiple: int
+    ) -> None:
+        with Timer() as timer:
+            await self.func(test_redis, num_tasks, unique_str(), num_locks=num_locks)
+        assert (min_multiple * self.delta) <= timer <= (5 * min_multiple * self.delta)
+
+    async def test_error_num_locks(self, *, test_redis: Redis) -> None:
+        with raises(
+            _YieldAccessNumLocksError,
+            match=r"Number of locks for '\w+' must be positive; got 0",
+        ):
+            async with yield_access(test_redis, unique_str(), num=0):
+                ...
+
+    async def test_error_unable_to_acquire_lock(self, *, test_redis: Redis) -> None:
+        key = unique_str()
+        delta = 0.1 * SECOND
+
+        async def coroutine(key: str, /) -> None:
+            async with yield_access(
+                test_redis, key, num=1, timeout_acquire=delta, throttle=5 * delta
+            ):
+                await sleep_td(delta)
+
+        with raises(ExceptionGroup) as exc_info:
+            async with TaskGroup() as tg:
+                _ = tg.create_task(coroutine(key))
+                _ = tg.create_task(coroutine(key))
+        assert exc_info.group_contains(
+            _YieldAccessUnableToAcquireLockError,
+            match=r"Unable to acquire any 1 of 1 locks for '\w+' after .*",
+        )
+
+    async def func(
+        self, redis: Redis, num_tasks: int, key: str, /, *, num_locks: int = 1
+    ) -> None:
+        async def coroutine() -> None:
+            async with yield_access(redis, key, num=num_locks):
+                await sleep_td(self.delta)
+
+        async with TaskGroup() as tg:
+            _ = [tg.create_task(coroutine()) for _ in range(num_tasks)]

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/tests/test_pytest.py

@@ -9,7 +9,7 @@ from pytest import fixture, mark, param, raises
 
 from utilities.iterables import one
 from utilities.os import temp_environ
-from utilities.pytest import NodeIdToPathError, is_pytest, node_id_path, throttle
+from utilities.pytest import NodeIdToPathError, node_id_path, throttle
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
@@ -25,11 +25,6 @@ def set_asyncio_default_fixture_loop_scope(*, testdir: Testdir) -> None:
     """)
 
 
-class TestIsPytest:
-    def test_main(self) -> None:
-        assert is_pytest()
-
-
 class TestNodeIdPath:
     @mark.parametrize(
         ("node_id", "expected"),

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.156.0"
+__version__ = "0.157.1"

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/asyncio.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 import asyncio
-import sys
 from asyncio import (
     Lock,
     Queue,
@@ -36,9 +35,8 @@ from typing import (
     override,
 )
 
-from utilities.errors import ImpossibleCaseError, is_instance_error
 from utilities.functions import ensure_int, ensure_not_none
-from utilities.logging import to_logger
+from utilities.os import is_pytest
 from utilities.random import SYSTEM_RANDOM
 from utilities.sentinel import Sentinel, sentinel
 from utilities.shelve import yield_shelf
@@ -70,8 +68,6 @@ if TYPE_CHECKING:
     from utilities.types import (
         Coro,
         Delta,
-        ExceptionTypeLike,
-        LoggerLike,
         MaybeCallableBoolLike,
         MaybeType,
         PathLike,
@@ -369,8 +365,6 @@ async def get_items[T](queue: Queue[T], /, *, max_size: int | None = None) -> li
     try:
         items = [await queue.get()]
     except RuntimeError as error:  # pragma: no cover
-        from utilities.pytest import is_pytest
-
         if (not is_pytest()) or (error.args[0] != "Event loop is closed"):
             raise
         return []
@@ -400,43 +394,6 @@ def get_items_nowait[T](queue: Queue[T], /, *, max_size: int | None = None) -> l
 ##
 
 
-async def loop_until_succeed(
-    func: Callable[[], Coro[None]],
-    /,
-    *,
-    logger: LoggerLike | None = None,
-    errors: ExceptionTypeLike[Exception] | None = None,
-    sleep: Delta | None = None,
-) -> bool:
-    """Repeatedly call a coroutine until it succeeds."""
-    name = get_coroutine_name(func)
-    while True:
-        try:
-            await func()
-        except Exception as error:  # noqa: BLE001
-            if logger is not None:
-                to_logger(logger).error("Error running %r", name, exc_info=True)
-            exc_type, exc_value, traceback = sys.exc_info()
-            if (exc_type is None) or (exc_value is None):  # pragma: no cover
-                raise ImpossibleCaseError(
-                    case=[f"{exc_type=}", f"{exc_value=}"]
-                ) from None
-            sys.excepthook(exc_type, exc_value, traceback)
-            if (errors is not None) and is_instance_error(error, errors):
-                return False
-            if sleep is not None:
-                if logger is not None:
-                    to_logger(logger).info("Sleeping for %s...", sleep)
-                await sleep_td(sleep)
-            if logger is not None:
-                to_logger(logger).info("Retrying %r...", name)
-        else:
-            return True
-
-
-##
-
-
 async def put_items[T](items: Iterable[T], queue: Queue[T], /) -> None:
     """Put items into a queue; if full then wait."""
     for item in items:
@@ -589,7 +546,6 @@ __all__ = [
     "get_coroutine_name",
     "get_items",
     "get_items_nowait",
-    "loop_until_succeed",
     "put_items",
     "put_items_nowait",
     "sleep_max",

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/os.py

@@ -126,7 +126,15 @@ class GetEnvVarError(Exception):
 
 def is_debug() -> bool:
     """Check if we are in `DEBUG` mode."""
-    return get_env_var("DEBUG", nullable=True) is not None
+    return "DEBUG" in environ
+
+
+##
+
+
+def is_pytest() -> bool:
+    """Check if `pytest` is running."""
+    return "PYTEST_VERSION" in environ
 
 
 ##
@@ -164,5 +172,6 @@ __all__ = [
     "get_cpu_use",
     "get_env_var",
     "is_debug",
+    "is_pytest",
     "temp_environ",
 ]

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/pottery.py

@@ -1,32 +1,27 @@
 from __future__ import annotations
 
-from contextlib import nullcontext, suppress
+from contextlib import suppress
 from dataclasses import dataclass
-from functools import wraps
 from sys import maxsize
 from typing import TYPE_CHECKING, override
 
-from pottery import AIORedlock, ExtendUnlockedLock
+from pottery import AIORedlock
 from pottery.exceptions import ReleaseUnlockedLock
 from redis.asyncio import Redis
 
-from utilities.asyncio import loop_until_succeed, sleep_td, timeout_td
+from utilities.asyncio import sleep_td, timeout_td
 from utilities.contextlib import enhanced_async_context_manager
-from utilities.contextvars import yield_set_context
 from utilities.iterables import always_iterable
-from utilities.logging import to_logger
 from utilities.whenever import MILLISECOND, SECOND, to_seconds
 
 if TYPE_CHECKING:
-    from collections.abc import AsyncIterator, Callable, Iterable
-    from contextvars import ContextVar
+    from collections.abc import AsyncIterator, Iterable
 
     from whenever import Delta
 
-    from utilities.types import Coro, LoggerLike, MaybeIterable
+    from utilities.types import MaybeIterable
 
 _NUM: int = 1
-_TIMEOUT_TRY_ACQUIRE: Delta = SECOND
 _TIMEOUT_RELEASE: Delta = 10 * SECOND
 _SLEEP: Delta = MILLISECOND
 
@@ -45,79 +40,6 @@ async def extend_lock(
 ##
 
 
-@enhanced_async_context_manager
-async def try_yield_coroutine_looper(
-    redis: MaybeIterable[Redis],
-    key: str,
-    /,
-    *,
-    num: int = _NUM,
-    timeout_release: Delta = _TIMEOUT_RELEASE,
-    num_extensions: int | None = None,
-    timeout_acquire: Delta = _TIMEOUT_TRY_ACQUIRE,
-    sleep_acquire: Delta = _SLEEP,
-    throttle: Delta | None = None,
-    logger: LoggerLike | None = None,
-    sleep_error: Delta | None = None,
-    context: ContextVar[bool] | None = None,
-) -> AsyncIterator[CoroutineLooper | None]:
-    """Try acquire access to a coroutine looper."""
-    try:  # skipif-ci-and-not-linux
-        async with yield_access(
-            redis,
-            key,
-            num=num,
-            timeout_release=timeout_release,
-            num_extensions=num_extensions,
-            timeout_acquire=timeout_acquire,
-            sleep=sleep_acquire,
-            throttle=throttle,
-        ) as lock:
-            looper = CoroutineLooper(lock=lock, logger=logger, sleep=sleep_error)
-            if context is None:
-                yield looper
-            else:
-                with yield_set_context(context):
-                    yield looper
-    except _YieldAccessUnableToAcquireLockError as error:  # skipif-ci-and-not-linux
-        if logger is not None:
-            to_logger(logger).info("%s", error)
-        async with nullcontext():
-            yield
-
-
-@dataclass(order=True, unsafe_hash=True, kw_only=True)
-class CoroutineLooper:
-    """Looper, guarded by a lock, to repeatedly call a coroutine until it succeeds."""
-
-    lock: AIORedlock
-    logger: LoggerLike | None = None
-    sleep: Delta | None = None
-
-    async def __call__[**P](
-        self, func: Callable[P, Coro[None]], *args: P.args, **kwargs: P.kwargs
-    ) -> bool:
-        return await loop_until_succeed(
-            lambda: self._make_coro(func, *args, **kwargs),
-            logger=self.logger,
-            errors=ExtendUnlockedLock,
-            sleep=self.sleep,
-        )
-
-    def _make_coro[**P](
-        self, func: Callable[P, Coro[None]], /, *args: P.args, **kwargs: P.kwargs
-    ) -> Coro[None]:
-        @wraps(func)
-        async def wrapped() -> None:
-            await extend_lock(lock=self.lock)
-            return await func(*args, **kwargs)
-
-        return wrapped()
-
-
-##
-
-
 @enhanced_async_context_manager
 async def yield_access(
     redis: MaybeIterable[Redis],
@@ -212,10 +134,4 @@ class _YieldAccessUnableToAcquireLockError(YieldAccessError):
         return f"Unable to acquire any 1 of {self.num} locks for {self.key!r} after {self.timeout}"  # skipif-ci-and-not-linux
 
 
-__all__ = [
-    "CoroutineLooper",
-    "YieldAccessError",
-    "extend_lock",
-    "try_yield_coroutine_looper",
-    "yield_access",
-]
+__all__ = ["YieldAccessError", "extend_lock", "yield_access"]

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/pytest.py

@@ -111,14 +111,6 @@ def add_pytest_configure(config: Config, options: Iterable[tuple[str, str]], /)
 ##
 
 
-def is_pytest() -> bool:
-    """Check if `pytest` is running."""
-    return "PYTEST_VERSION" in environ
-
-
-##
-
-
 def node_id_path(
     node_id: str, /, *, root: PathLike | None = None, suffix: str | None = None
 ) -> Path:
@@ -257,7 +249,6 @@ __all__ = [
     "add_pytest_addoption",
     "add_pytest_collection_modifyitems",
     "add_pytest_configure",
-    "is_pytest",
     "node_id_path",
     "skipif_linux",
     "skipif_mac",

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/redis.py

@@ -25,6 +25,7 @@ from utilities.contextlib import enhanced_async_context_manager
 from utilities.errors import ImpossibleCaseError
 from utilities.functions import ensure_int, identity
 from utilities.iterables import always_iterable, one
+from utilities.os import is_pytest
 from utilities.whenever import MILLISECOND, SECOND, to_milliseconds, to_seconds
 
 if TYPE_CHECKING:
@@ -730,8 +731,6 @@ async def subscribe[T](
         try:
             _ = task.cancel()
         except RuntimeError as error:  # pragma: no cover
-            from utilities.pytest import is_pytest
-
             if (not is_pytest()) or (error.args[0] != "Event loop is closed"):
                 raise
         with suppress(CancelledError):

{dycw_utilities-0.156.0 → dycw_utilities-0.157.1}/src/utilities/sqlalchemy.py

@@ -95,6 +95,7 @@ from utilities.iterables import (
     merge_str_mappings,
     one,
 )
+from utilities.os import is_pytest
 from utilities.reprlib import get_repr
 from utilities.text import secret_str, snake_case
 from utilities.types import (
@@ -976,8 +977,6 @@ async def yield_connection(
         async with timeout_td(timeout, error=error), engine.begin() as conn:
             yield conn
     except GeneratorExit:  # pragma: no cover
-        from utilities.pytest import is_pytest
-
         if not is_pytest():
             raise
         return