dycw-utilities 0.131.7__tar.gz → 0.131.9__tar.gz

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/PKG-INFO

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

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/pyproject.toml

@@ -94,7 +94,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.131.7"
+version = "0.131.9"
 
 [project.optional-dependencies]
 logging = [
@@ -121,7 +121,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.131.7"
+current_version = "0.131.9"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/tests/test_aiolimiter.py

@@ -6,6 +6,7 @@ from typing import ClassVar
 from utilities.aiolimiter import get_async_limiter
 from utilities.text import unique_str
 from utilities.timer import Timer
+from utilities.whenever2 import SECOND
 
 
 class TestGetAsyncLimiter:
@@ -22,7 +23,7 @@ class TestGetAsyncLimiter:
             for _ in range(2):
                 async with get_async_limiter(name, rate=0.5):
                     await increment()
-        assert timer >= 0.48
+        assert timer >= 0.48 * SECOND
 
     shared: ClassVar[str] = unique_str()
 

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/tests/test_asyncio.py

@@ -177,14 +177,14 @@ class TestEnhancedTaskGroup:
             async with EnhancedTaskGroup() as tg:
                 for _ in range(10):
                     _ = tg.create_task(sleep(0.01))
-        assert timer <= 0.05
+        assert timer.timedelta.in_seconds() <= 0.05
 
     async def test_max_tasks_enabled(self) -> None:
         with Timer() as timer:
             async with EnhancedTaskGroup(max_tasks=2) as tg:
                 for _ in range(10):
                     _ = tg.create_task(sleep(0.01))
-        assert timer >= 0.05
+        assert timer.timedelta.in_seconds() >= 0.05
 
     async def test_timeout_pass(self) -> None:
         async with EnhancedTaskGroup(timeout=0.2) as tg:
@@ -610,7 +610,7 @@ class TestLooper:
         looper = Example()
         with Timer() as timer:
             await looper.restart()
-        assert timer.timedelta >= self._restart_min_elapsed
+        assert timer.timedelta.py_timedelta() >= self._restart_min_elapsed
         pattern = rf": encountered {get_class_name(CountingLooperError)}\(\) whilst restarting \(initialize\); sleeping for .*\.\.\.$"
         _ = one(m for m in caplog.messages if search(pattern, m))
 
@@ -627,7 +627,7 @@ class TestLooper:
         looper = Example()
         with Timer() as timer:
             await looper.restart()
-        assert timer.timedelta >= self._restart_min_elapsed
+        assert timer.timedelta.py_timedelta() >= self._restart_min_elapsed
         pattern = rf": encountered {get_class_name(CountingLooperError)}\(\) whilst restarting \(tear down\); sleeping for .*\.\.\.$"
         _ = one(m for m in caplog.messages if search(pattern, m))
 
@@ -650,7 +650,7 @@ class TestLooper:
         looper = Example()
         with Timer() as timer:
             await looper.restart()
-        assert timer.timedelta >= self._restart_min_elapsed
+        assert timer.timedelta.py_timedelta() >= self._restart_min_elapsed
         pattern = rf": encountered {get_class_name(CountingLooperError)}\(\) \(tear down\) and then {get_class_name(CountingLooperError)}\(\) \(initialization\) whilst restarting; sleeping for .*\.\.\.$"
         _ = one(m for m in caplog.messages if search(pattern, m))
 
@@ -658,7 +658,7 @@ class TestLooper:
         looper = CountingLooper()
         with Timer() as timer:
             await looper.restart()
-        assert timer.timedelta <= self._restart_max_elapsed
+        assert timer.timedelta.py_timedelta() <= self._restart_max_elapsed
         pattern = r": finished restarting$"
         _ = one(m for m in caplog.messages if search(pattern, m))
 
@@ -911,12 +911,14 @@ 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(2 * duration)
+        assert timer.timedelta.py_timedelta() <= datetime_duration_to_timedelta(
+            2 * duration
+        )
 
     async def test_none(self) -> None:
         with Timer() as timer:
             await sleep_dur()
-        assert timer <= 0.01
+        assert timer.timedelta.in_seconds() <= 0.01
 
 
 class TestSleepMaxDur:
@@ -925,12 +927,14 @@ class TestSleepMaxDur:
     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)
+        assert timer.timedelta.py_timedelta() <= datetime_duration_to_timedelta(
+            2 * duration
+        )
 
     async def test_none(self) -> None:
         with Timer() as timer:
             await sleep_max_dur()
-        assert timer <= 0.01
+        assert timer.timedelta.in_seconds() <= 0.01
 
 
 class TestSleepUntil:

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/tests/test_re.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import re
 from re import DOTALL
 from typing import TYPE_CHECKING
 
@@ -13,6 +14,7 @@ from utilities.re import (
     _ExtractGroupsMultipleMatchesError,
     _ExtractGroupsNoCaptureGroupsError,
     _ExtractGroupsNoMatchesError,
+    ensure_pattern,
     extract_group,
     extract_groups,
 )
@@ -21,6 +23,16 @@ if TYPE_CHECKING:
     from collections.abc import Sequence
 
 
+class TestEnsurePattern:
+    def test_pattern(self) -> None:
+        pattern = re.compile(r"\d")
+        assert ensure_pattern(pattern) == pattern
+
+    def test_str(self) -> None:
+        pattern = r"\d"
+        assert ensure_pattern(pattern) == re.compile(pattern)
+
+
 class TestExtractGroup:
     def test_main(self) -> None:
         assert extract_group(r"(\d)", "A0A") == "0"

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/tests/test_timer.py

@@ -1,15 +1,16 @@
 from __future__ import annotations
 
-import datetime as dt
 from operator import add, eq, ge, gt, le, lt, mul, ne, sub, truediv
 from re import search
 from time import sleep
 from typing import TYPE_CHECKING, Any
 
 from pytest import mark, param, raises
+from whenever import TimeDelta
 
-from utilities.datetime import SECOND, ZERO_TIME
+from utilities.asyncio import sleep_dur
 from utilities.timer import Timer
+from utilities.whenever2 import SECOND, ZERO_TIME
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -17,32 +18,27 @@ if TYPE_CHECKING:
 
 class TestTimer:
     @mark.parametrize(
-        ("op", "other", "cls"),
+        ("op", "other"),
         [
-            param(add, 0, dt.timedelta),
-            param(add, 0.0, dt.timedelta),
-            param(add, ZERO_TIME, dt.timedelta),
-            param(sub, 0, dt.timedelta),
-            param(sub, 0.0, dt.timedelta),
-            param(sub, ZERO_TIME, dt.timedelta),
-            param(mul, 1, dt.timedelta),
-            param(mul, 1.0, dt.timedelta),
-            param(truediv, 1, dt.timedelta),
-            param(truediv, 1.0, dt.timedelta),
-            param(truediv, SECOND, float),
+            param(add, ZERO_TIME),
+            param(sub, ZERO_TIME),
+            param(mul, 1),
+            param(mul, 1.0),
+            param(truediv, 1),
+            param(truediv, 1.0),
         ],
         ids=str,
     )
     def test_arithmetic_against_numbers_or_timedeltas(
-        self, *, op: Callable[[Any, Any], Any], other: Any, cls: type[Any]
+        self, *, op: Callable[[Any, Any], Any], other: Any
     ) -> None:
         with Timer() as timer:
             pass
-        assert isinstance(op(timer, other), cls)
+        assert isinstance(op(timer, other), TimeDelta)
 
     @mark.parametrize(
         ("op", "cls"),
-        [param(add, dt.timedelta), param(sub, dt.timedelta), param(truediv, float)],
+        [param(add, TimeDelta), param(sub, TimeDelta), param(truediv, float)],
         ids=str,
     )
     def test_arithmetic_against_another_timer(
@@ -83,15 +79,12 @@ class TestTimer:
         ],
         ids=str,
     )
-    @mark.parametrize(
-        "dur", [param(1), param(1.0), param(dt.timedelta(seconds=1))], ids=str
-    )
     def test_comparison(
-        self, *, op: Callable[[Any, Any], bool], dur: Any, expected: bool
+        self, *, op: Callable[[Any, Any], bool], expected: bool
     ) -> None:
         with Timer() as timer:
             pass
-        assert op(timer, dur) is expected
+        assert op(timer, SECOND) is expected
 
     @mark.parametrize(
         "op",
@@ -120,28 +113,27 @@ class TestTimer:
         with raises(TypeError):
             _ = op(timer, "")
 
-    def test_context_manager(self) -> None:
-        duration = 0.01
+    async def test_context_manager(self) -> None:
+        delta = 0.01 * SECOND
         with Timer() as timer:
-            assert isinstance(timer, Timer)
-            sleep(2 * duration)
-        assert timer >= duration
+            await sleep_dur(duration=2 * delta)
+        assert timer >= delta
 
     @mark.parametrize("func", [param(repr), param(str)], ids=str)
     def test_repr_and_str(self, *, func: Callable[[Timer], str]) -> None:
         with Timer() as timer:
             sleep(0.01)
         as_str = func(timer)
-        assert search(r"^\d+:\d{2}:\d{2}\.\d{6}$", as_str)
+        assert search(r"^PT0\.\d+S$", as_str)
 
-    def test_running(self) -> None:
-        duration = 0.01
+    async def test_running(self) -> None:
+        delta = 0.01 * SECOND
         timer = Timer()
-        sleep(2 * duration)
-        assert timer >= duration
-        sleep(2 * duration)
-        assert timer >= 2 * duration
+        await sleep_dur(duration=2 * delta)
+        assert timer >= delta
+        await sleep_dur(duration=2 * delta)
+        assert timer >= 2 * delta
 
     def test_timedelta(self) -> None:
         timer = Timer()
-        assert isinstance(timer.timedelta, dt.timedelta)
+        assert isinstance(timer.timedelta, TimeDelta)

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.131.7"
+__version__ = "0.131.9"

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/utilities/asyncio.py

@@ -43,6 +43,7 @@ from typing import (
 )
 
 from typing_extensions import deprecated
+from whenever import TimeDelta
 
 from utilities.dataclasses import replace_non_sentinel
 from utilities.datetime import (
@@ -961,11 +962,14 @@ def put_items_nowait(items: Iterable[_T], queue: Queue[_T], /) -> None:
 ##
 
 
-async def sleep_dur(*, duration: Duration | None = None) -> None:
+async def sleep_dur(*, duration: Duration | TimeDelta | None = None) -> None:
     """Sleep which accepts durations."""
     if duration is None:
         return
-    await sleep(datetime_duration_to_float(duration))
+    if isinstance(duration, TimeDelta):
+        await sleep(duration.in_seconds())
+    else:
+        await sleep(datetime_duration_to_float(duration))
 
 
 ##

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/utilities/re.py

@@ -2,37 +2,59 @@ from __future__ import annotations
 
 import re
 from dataclasses import dataclass
-from typing import override
+from re import Pattern
+from typing import TYPE_CHECKING, assert_never, override
 
 from utilities.iterables import OneEmptyError, OneNonUniqueError, one
 
+if TYPE_CHECKING:
+    from utilities.types import PatternLike
 
-def extract_group(pattern: str, text: str, /, *, flags: int = 0) -> str:
+
+def ensure_pattern(pattern: PatternLike, /, *, flags: int = 0) -> Pattern[str]:
+    """Ensure a pattern is returned."""
+    match pattern:
+        case Pattern():
+            return pattern
+        case str():
+            return re.compile(pattern, flags=flags)
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
+def extract_group(pattern: PatternLike, text: str, /, *, flags: int = 0) -> str:
     """Extract a group.
 
     The regex must have 1 capture group, and this must match exactly once.
     """
-    compiled = re.compile(pattern, flags=flags)
-    match compiled.groups:
+    pattern_use = ensure_pattern(pattern, flags=flags)
+    match pattern_use.groups:
         case 0:
-            raise _ExtractGroupNoCaptureGroupsError(pattern=pattern, text=text)
+            raise _ExtractGroupNoCaptureGroupsError(pattern=pattern_use, text=text)
         case 1:
-            matches: list[str] = compiled.findall(text)
+            matches: list[str] = pattern_use.findall(text)
             try:
                 return one(matches)
             except OneEmptyError:
-                raise _ExtractGroupNoMatchesError(pattern=pattern, text=text) from None
+                raise _ExtractGroupNoMatchesError(
+                    pattern=pattern_use, text=text
+                ) from None
             except OneNonUniqueError:
                 raise _ExtractGroupMultipleMatchesError(
-                    pattern=pattern, text=text, matches=matches
+                    pattern=pattern_use, text=text, matches=matches
                 ) from None
         case _:
-            raise _ExtractGroupMultipleCaptureGroupsError(pattern=pattern, text=text)
+            raise _ExtractGroupMultipleCaptureGroupsError(
+                pattern=pattern_use, text=text
+            )
 
 
 @dataclass(kw_only=True, slots=True)
 class ExtractGroupError(Exception):
-    pattern: str
+    pattern: Pattern[str]
     text: str
 
 
@@ -68,32 +90,35 @@ class _ExtractGroupNoMatchesError(ExtractGroupError):
         return f"Pattern {self.pattern} must match against {self.text}"
 
 
-def extract_groups(pattern: str, text: str, /, *, flags: int = 0) -> list[str]:
+##
+
+
+def extract_groups(pattern: PatternLike, text: str, /, *, flags: int = 0) -> list[str]:
     """Extract multiple groups.
 
     The regex may have any number of capture groups, and they must collectively
     match exactly once.
     """
-    compiled = re.compile(pattern, flags=flags)
-    if (n_groups := compiled.groups) == 0:
-        raise _ExtractGroupsNoCaptureGroupsError(pattern=pattern, text=text)
-    matches: list[str] = compiled.findall(text)
+    pattern_use = ensure_pattern(pattern, flags=flags)
+    if (n_groups := pattern_use.groups) == 0:
+        raise _ExtractGroupsNoCaptureGroupsError(pattern=pattern_use, text=text)
+    matches: list[str] = pattern_use.findall(text)
     match len(matches), n_groups:
         case 0, _:
-            raise _ExtractGroupsNoMatchesError(pattern=pattern, text=text)
+            raise _ExtractGroupsNoMatchesError(pattern=pattern_use, text=text)
         case 1, 1:
             return matches
         case 1, _:
             return list(one(matches))
         case _:
             raise _ExtractGroupsMultipleMatchesError(
-                pattern=pattern, text=text, matches=matches
+                pattern=pattern_use, text=text, matches=matches
             )
 
 
 @dataclass(kw_only=True, slots=True)
 class ExtractGroupsError(Exception):
-    pattern: str
+    pattern: Pattern[str]
     text: str
 
 
@@ -108,7 +133,7 @@ class _ExtractGroupsMultipleMatchesError(ExtractGroupsError):
 
 @dataclass(kw_only=True, slots=True)
 class _ExtractGroupsNoCaptureGroupsError(ExtractGroupsError):
-    pattern: str
+    pattern: Pattern[str]
     text: str
 
     @override
@@ -123,4 +148,10 @@ class _ExtractGroupsNoMatchesError(ExtractGroupsError):
         return f"Pattern {self.pattern} must match against {self.text}"
 
 
-__all__ = ["ExtractGroupError", "ExtractGroupsError", "extract_group", "extract_groups"]
+__all__ = [
+    "ExtractGroupError",
+    "ExtractGroupsError",
+    "ensure_pattern",
+    "extract_group",
+    "extract_groups",
+]

dycw_utilities-0.131.9/src/utilities/timer.py

@@ -0,0 +1,97 @@
+from __future__ import annotations
+
+from operator import add, eq, ge, gt, le, lt, mul, ne, sub, truediv
+from typing import TYPE_CHECKING, Any, Self, override
+
+from utilities.whenever2 import get_now_local
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+    from whenever import TimeDelta, ZonedDateTime
+
+
+class Timer:
+    """Context manager for timing blocks of code."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._start: ZonedDateTime = get_now_local()
+        self._end: ZonedDateTime | None = None
+
+    # arithmetic
+
+    def __add__(self, other: Any) -> TimeDelta:
+        return self._apply_op(add, other)
+
+    def __float__(self) -> float:
+        return self.timedelta.in_seconds()
+
+    def __sub__(self, other: Any) -> TimeDelta:
+        return self._apply_op(sub, other)
+
+    def __mul__(self, other: Any) -> TimeDelta:
+        return self._apply_op(mul, other)
+
+    def __truediv__(self, other: Any) -> TimeDelta:
+        return self._apply_op(truediv, other)
+
+    # context manager
+
+    def __enter__(self) -> Self:
+        self._start = get_now_local()
+        return self
+
+    def __exit__(self, *_: object) -> bool:
+        self._end = get_now_local()
+        return False
+
+    # repr
+
+    @override
+    def __repr__(self) -> str:
+        return self.timedelta.format_common_iso()
+
+    @override
+    def __str__(self) -> str:
+        return self.timedelta.format_common_iso()
+
+    # comparison
+
+    @override
+    def __eq__(self, other: object) -> bool:
+        return self._apply_op(eq, other)
+
+    def __ge__(self, other: Any) -> bool:
+        return self._apply_op(ge, other)
+
+    def __gt__(self, other: Any) -> bool:
+        return self._apply_op(gt, other)
+
+    def __le__(self, other: Any) -> bool:
+        return self._apply_op(le, other)
+
+    def __lt__(self, other: Any) -> bool:
+        return self._apply_op(lt, other)
+
+    @override
+    def __ne__(self, other: object) -> bool:
+        return self._apply_op(ne, other)
+
+    # properties
+
+    @property
+    def timedelta(self) -> TimeDelta:
+        """The elapsed time, as a `timedelta` object."""
+        end_use = get_now_local() if (end := self._end) is None else end
+        return end_use - self._start
+
+    # private
+
+    def _apply_op(self, op: Callable[[Any, Any], Any], other: Any, /) -> Any:
+        if isinstance(other, Timer):
+            return op(self.timedelta, other.timedelta)
+        return op(self.timedelta, other)
+
+
+__all__ = ["Timer"]

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/utilities/types.py

@@ -7,6 +7,7 @@ from enum import Enum
 from logging import Logger
 from pathlib import Path
 from random import Random
+from re import Pattern
 from types import TracebackType
 from typing import (
     Any,
@@ -249,6 +250,10 @@ type PathLike = MaybeStr[Path]
 type Seed = int | float | str | bytes | bytearray | Random
 
 
+# re
+type PatternLike = MaybeStr[Pattern[str]]
+
+
 # traceback
 type ExcInfo = tuple[type[BaseException], BaseException, TracebackType]
 type OptExcInfo = ExcInfo | tuple[None, None, None]
@@ -294,6 +299,7 @@ __all__ = [
     "Parallelism",
     "ParseObjectExtra",
     "PathLike",
+    "PatternLike",
     "RoundMode",
     "Seed",
     "SerializeObjectExtra",

{dycw_utilities-0.131.7 → dycw_utilities-0.131.9}/src/utilities/whenever2.py

@@ -53,7 +53,7 @@ DATE_DELTA_PARSABLE_MAX = DateDelta(days=999999)
 ## common constants
 
 
-ZERO_TIME = Time()
+ZERO_TIME = TimeDelta()
 MICROSECOND = TimeDelta(microseconds=1)
 MILLISECOND = TimeDelta(milliseconds=1)
 SECOND = TimeDelta(seconds=1)