dycw-utilities 0.125.19__tar.gz → 0.125.20__tar.gz

{dycw_utilities-0.125.19 → dycw_utilities-0.125.20}/PKG-INFO

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

{dycw_utilities-0.125.19 → dycw_utilities-0.125.20}/pyproject.toml

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

{dycw_utilities-0.125.19 → dycw_utilities-0.125.20}/src/tests/test_asyncio.py

@@ -42,6 +42,7 @@ from utilities.asyncio import (
     put_items,
     put_items_nowait,
     sleep_dur,
+    sleep_max_dur,
     sleep_until,
     sleep_until_rounded,
     stream_command,
@@ -1428,7 +1429,7 @@ class TestSleepDur:
     async def test_main(self, *, duration: Duration) -> None:
         with Timer() as timer:
             await sleep_dur(duration=duration)
-        assert timer >= datetime_duration_to_timedelta(duration / 2)
+        assert timer <= datetime_duration_to_timedelta(2 * duration)
 
     async def test_none(self) -> None:
         with Timer() as timer:
@@ -1436,6 +1437,20 @@ class TestSleepDur:
         assert timer <= 0.01
 
 
+class TestSleepMaxDur:
+    @given(duration=sampled_from([0.1, 10 * MILLISECOND]))
+    @settings(phases={Phase.generate})
+    async def test_main(self, *, duration: Duration) -> None:
+        with Timer() as timer:
+            await sleep_max_dur(duration=duration)
+        assert timer <= datetime_duration_to_timedelta(2 * duration)
+
+    async def test_none(self) -> None:
+        with Timer() as timer:
+            await sleep_max_dur()
+        assert timer <= 0.01
+
+
 class TestSleepUntil:
     async def test_main(self) -> None:
         await sleep_until(get_now() + 10 * MILLISECOND)

{dycw_utilities-0.125.19 → dycw_utilities-0.125.20}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.125.19"
+__version__ = "0.125.20"

{dycw_utilities-0.125.19 → dycw_utilities-0.125.20}/src/utilities/asyncio.py

@@ -59,6 +59,7 @@ from utilities.datetime import (
 )
 from utilities.errors import ImpossibleCaseError, repr_error
 from utilities.functions import ensure_int, ensure_not_none, get_class_name
+from utilities.random import SYSTEM_RANDOM
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import (
     Coroutine1,
@@ -75,6 +76,7 @@ if TYPE_CHECKING:
     from collections import deque
     from collections.abc import AsyncIterator, Sequence
     from contextvars import Context
+    from random import Random
     from types import TracebackType
 
     from utilities.types import Duration
@@ -1305,6 +1307,18 @@ async def sleep_dur(*, duration: Duration | None = None) -> None:
 ##
 
 
+async def sleep_max_dur(
+    *, duration: Duration | None = None, random: Random = SYSTEM_RANDOM
+) -> None:
+    """Sleep which accepts max durations."""
+    if duration is None:
+        return
+    await sleep(random.uniform(0.0, datetime_duration_to_float(duration)))
+
+
+##
+
+
 async def sleep_until(datetime: dt.datetime, /) -> None:
     """Sleep until a given time."""
     await sleep_dur(duration=datetime - get_now())
@@ -1407,6 +1421,7 @@ __all__ = [
     "put_items",
     "put_items_nowait",
     "sleep_dur",
+    "sleep_max_dur",
     "sleep_until",
     "sleep_until_rounded",
     "stream_command",