dycw-utilities 0.113.0__tar.gz → 0.113.2__tar.gz

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.113.0
+Version: 0.113.2
 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.9; extra == 'test'
+Requires-Dist: hypothesis<6.132,>=6.131.10; 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'
@@ -16,7 +16,7 @@ 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-rng<1.1,>=1.0.0; extra == 'test'
-Requires-Dist: pytest-timeout<2.4,>=2.3.1; extra == 'test'
+Requires-Dist: pytest-timeout<2.5,>=2.4.0; extra == 'test'
 Requires-Dist: pytest-xdist<3.7,>=3.6.1; extra == 'test'
 Requires-Dist: pytest<8.4,>=8.3.5; extra == 'test'
 Requires-Dist: setuptools>=78.0.2; extra == 'test'
@@ -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.9; extra == 'zzz-test-hypothesis'
+Requires-Dist: hypothesis<6.132,>=6.131.10; 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'

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/pyproject.toml

@@ -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.9, < 6.132",
+  "hypothesis >= 6.131.10, < 6.132",
   "img2pdf >= 0.6.0, < 0.7",
   "lightweight-charts >= 2.1, < 2.2",
   "loguru >= 0.7.3, < 0.8",
@@ -76,7 +76,7 @@ dev = [
   "pytest-randomly >= 3.16.0, < 3.17",
   "pytest-rerunfailures >= 15.0, < 16",
   "pytest-rng >= 1.0.0, < 1.1",
-  "pytest-timeout >= 2.3.1, < 2.4",
+  "pytest-timeout >= 2.4.0, < 2.5",
   "pytest-xdist >= 3.6.1, < 3.7",
   # CI
   "win32_setctime >= 1.2.0, < 1.3",  # https://github.com/Delgan/loguru/issues/147
@@ -92,11 +92,11 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.113.0"
+version = "0.113.2"
 
 [project.optional-dependencies]
 test = [
-  "hypothesis >= 6.131.9, < 6.132",
+  "hypothesis >= 6.131.10, < 6.132",
   "pytest >= 8.3.5, < 8.4",
   "pytest-asyncio >= 0.26.0, < 0.27",
   "pytest-cov >= 6.1.1, < 6.2",
@@ -107,7 +107,7 @@ test = [
   "pytest-regressions >= 2.7.0, < 2.8",
   "pytest-rerunfailures >= 15.0, < 16",
   "pytest-rng >= 1.0.0, < 1.1",
-  "pytest-timeout >= 2.3.1, < 2.4",
+  "pytest-timeout >= 2.4.0, < 2.5",
   "pytest-xdist >= 3.6.1, < 3.7",
   "setuptools >= 78.0.2",  # https://github.com/theY4Kman/pytest-only/issues/14
 ]
@@ -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.9, < 6.132",
+  "hypothesis >= 6.131.10, < 6.132",
   "luigi >= 3.6.0, < 3.7",
   "numpy >= 2.2.5, < 2.3",
   "pathvalidate >= 3.2.3, < 3.3",
@@ -334,7 +334,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.113.0"
+current_version = "0.113.2"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/tests/test_asyncio.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from asyncio import (
     CancelledError,
+    Event,
     Lock,
     PriorityQueue,
     Queue,
@@ -14,7 +15,7 @@ from collections import Counter
 from dataclasses import dataclass, field
 from itertools import chain
 from re import search
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING, Self, override
 
 from hypothesis import Phase, given, settings
 from hypothesis.strategies import (
@@ -37,20 +38,23 @@ from utilities.asyncio import (
     QueueProcessor,
     UniquePriorityQueue,
     UniqueQueue,
+    get_event,
     get_items,
     get_items_nowait,
     sleep_dur,
     stream_command,
     timeout_dur,
 )
+from utilities.dataclasses import replace_non_sentinel
 from utilities.datetime import MILLISECOND, datetime_duration_to_timedelta
-from utilities.hypothesis import text_ascii
+from utilities.hypothesis import sentinels, text_ascii
 from utilities.iterables import one, unique_everseen
 from utilities.pytest import skipif_windows
+from utilities.sentinel import Sentinel, sentinel
 from utilities.timer import Timer
 
 if TYPE_CHECKING:
-    from utilities.types import Duration
+    from utilities.types import Duration, MaybeCallableEvent
 
 
 class TestAsyncLoopingService:
@@ -297,6 +301,37 @@ class TestExceptionProcessor:
                 await sleep(0.1)
 
 
+class TestGetEvent:
+    def test_event(self) -> None:
+        event = Event()
+        assert get_event(event=event) is event
+
+    @given(event=none() | sentinels())
+    def test_none_or_sentinel(self, *, event: None | Sentinel) -> None:
+        assert get_event(event=event) is event
+
+    def test_replace_non_sentinel(self) -> None:
+        @dataclass(kw_only=True, slots=True)
+        class Example:
+            event: Event = field(default_factory=Event)
+
+            def replace(
+                self, *, event: MaybeCallableEvent | Sentinel = sentinel
+            ) -> Self:
+                return replace_non_sentinel(self, event=get_event(event=event))
+
+        event1, event2, event3 = Event(), Event(), Event()
+        obj = Example(event=event1)
+        assert obj.event is event1
+        assert obj.replace().event is event1
+        assert obj.replace(event=event2).event is event2
+        assert obj.replace(event=lambda: event3).event is event3
+
+    def test_callable(self) -> None:
+        event = Event()
+        assert get_event(event=lambda: event) is event
+
+
 class TestGetItems:
     @given(
         xs=lists(integers(), min_size=1),

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/tests/test_dataclasses.py

@@ -1,12 +1,21 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, field
+from functools import total_ordering
 from pathlib import Path
 from types import NoneType
-from typing import Any, Literal, cast, override
+from typing import Any, Literal, Self, cast, override
 
 from hypothesis import given
-from hypothesis.strategies import booleans, integers, lists, sampled_from
+from hypothesis.strategies import (
+    DataObject,
+    booleans,
+    data,
+    integers,
+    lists,
+    permutations,
+    sampled_from,
+)
 from polars import DataFrame
 from pytest import raises
 
@@ -53,6 +62,7 @@ from utilities.dataclasses import (
     _YieldFieldsInstance,
     dataclass_repr,
     dataclass_to_dict,
+    is_nullable_lt,
     mapping_to_dataclass,
     one_field,
     parse_dataclass,
@@ -272,6 +282,25 @@ class TestDataClassToDictAndDataClassRepr:
         assert repr_res == repr_exp
 
 
+class TestIsNullableLT:
+    @given(data=data())
+    def test_main(self, *, data: DataObject) -> None:
+        @dataclass(kw_only=True)
+        @total_ordering
+        class Example:
+            x: int | None = None
+
+            def __lt__(self, other: Self) -> bool:
+                if (cmp := is_nullable_lt(self.x, other.x)) is not None:
+                    return cmp
+                return False
+
+        obj_none, obj1, obj2 = [Example(x=x) for x in [None, 1, 2]]
+        expected = [obj_none, obj_none, obj1, obj1, obj2, obj2]
+        result = sorted(data.draw(permutations(expected)))
+        assert result == expected
+
+
 class TestMappingToDataClass:
     @given(key=sampled_from(["int_", "INT_"]), int_=integers())
     def test_exact_match_case_insensitive(self, *, key: str, int_: int) -> None:

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/tests/test_iterables.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import re
 from dataclasses import dataclass, replace
 from enum import Enum, auto
+from functools import cmp_to_key
 from itertools import chain, repeat
 from math import isfinite, isinf, isnan, nan
 from operator import add, neg, sub
@@ -92,6 +93,7 @@ from utilities.iterables import (
     check_superset,
     check_unique_modulo_case,
     chunked,
+    cmp_nullable,
     ensure_hashables,
     ensure_iterable,
     ensure_iterable_not_str,
@@ -613,6 +615,28 @@ class TestChunked:
         assert result == expected
 
 
+class TestCmpNullable:
+    @given(
+        data=data(),
+        case=sampled_from([
+            ([None, None], [None, None]),
+            ([1, None], [None, 1]),
+            ([1, None, None], [None, None, 1]),
+            ([2, 1, None], [None, 1, 2]),
+            ([2, 1, None, None], [None, None, 1, 2]),
+        ]),
+    )
+    def test_main(
+        self,
+        *,
+        data: DataObject,
+        case: tuple[Sequence[int | None], Sequence[int | None]],
+    ) -> None:
+        values, expected = case
+        result = sorted(data.draw(permutations(values)), key=cmp_to_key(cmp_nullable))
+        assert result == expected
+
+
 @dataclass(unsafe_hash=True, slots=True)
 class _Item:
     n: int

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.113.0"
+__version__ = "0.113.2"

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/utilities/asyncio.py

@@ -17,6 +17,7 @@ from asyncio import (
     sleep,
     timeout,
 )
+from collections.abc import Callable
 from contextlib import (
     AsyncExitStack,
     _AsyncGeneratorContextManager,
@@ -27,12 +28,22 @@ from dataclasses import dataclass, field
 from io import StringIO
 from subprocess import PIPE
 from sys import stderr, stdout
-from typing import TYPE_CHECKING, Generic, Self, TextIO, TypeVar, override
+from typing import (
+    TYPE_CHECKING,
+    Generic,
+    Self,
+    TextIO,
+    TypeVar,
+    assert_never,
+    overload,
+    override,
+)
 
 from utilities.datetime import MILLISECOND, datetime_duration_to_float
 from utilities.errors import ImpossibleCaseError
 from utilities.functions import ensure_int, ensure_not_none
-from utilities.types import THashable, TSupportsRichComparison
+from utilities.sentinel import Sentinel, sentinel
+from utilities.types import MaybeCallableEvent, THashable, TSupportsRichComparison
 
 if TYPE_CHECKING:
     from asyncio import _CoroutineLike
@@ -356,6 +367,34 @@ class UniqueQueue(Queue[THashable]):
 ##
 
 
+@overload
+def get_event(*, event: MaybeCallableEvent) -> Event: ...
+@overload
+def get_event(*, event: None) -> None: ...
+@overload
+def get_event(*, event: Sentinel) -> Sentinel: ...
+@overload
+def get_event(*, event: MaybeCallableEvent | Sentinel) -> Event | Sentinel: ...
+@overload
+def get_event(
+    *, event: MaybeCallableEvent | None | Sentinel = sentinel
+) -> Event | None | Sentinel: ...
+def get_event(
+    *, event: MaybeCallableEvent | None | Sentinel = sentinel
+) -> Event | None | Sentinel:
+    """Get the event."""
+    match event:
+        case Event() | None | Sentinel():
+            return event
+        case Callable() as func:
+            return get_event(event=func())
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
 async def get_items(
     queue: Queue[_T], /, *, max_size: int | None = None, lock: Lock | None = None
 ) -> list[_T]:
@@ -490,6 +529,7 @@ __all__ = [
     "StreamCommandOutput",
     "UniquePriorityQueue",
     "UniqueQueue",
+    "get_event",
     "get_items",
     "get_items_nowait",
     "sleep_dur",

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/utilities/dataclasses.py

@@ -20,7 +20,12 @@ from utilities.functions import (
     is_dataclass_class,
     is_dataclass_instance,
 )
-from utilities.iterables import OneStrEmptyError, OneStrNonUniqueError, one_str
+from utilities.iterables import (
+    OneStrEmptyError,
+    OneStrNonUniqueError,
+    cmp_nullable,
+    one_str,
+)
 from utilities.operator import is_equal
 from utilities.parse import (
     _ParseObjectExtraNonUniqueError,
@@ -43,6 +48,7 @@ from utilities.types import (
     SerializeObjectExtra,
     StrStrMapping,
     TDataclass,
+    TSupportsLT,
 )
 from utilities.typing import get_type_hints
 
@@ -215,6 +221,22 @@ def dataclass_to_dict(
 ##
 
 
+def is_nullable_lt(x: TSupportsLT | None, y: TSupportsLT | None, /) -> bool | None:
+    """Compare two nullable fields."""
+    match cmp_nullable(x, y):
+        case 1:
+            return False
+        case -1:
+            return True
+        case 0:
+            return None
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
 def mapping_to_dataclass(
     cls: type[TDataclass],
     mapping: StrMapping,
@@ -1056,6 +1078,7 @@ __all__ = [
     "YieldFieldsError",
     "dataclass_repr",
     "dataclass_to_dict",
+    "is_nullable_lt",
     "mapping_to_dataclass",
     "one_field",
     "parse_dataclass",

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/utilities/iterables.py

@@ -45,7 +45,7 @@ from utilities.math import (
 )
 from utilities.reprlib import get_repr
 from utilities.sentinel import Sentinel, sentinel
-from utilities.types import THashable, THashable2, TSupportsAdd
+from utilities.types import Sign, THashable, THashable2, TSupportsAdd, TSupportsLT
 from utilities.zoneinfo import UTC
 
 if TYPE_CHECKING:
@@ -696,6 +696,24 @@ class _CheckUniqueModuloCaseDuplicateLowerCaseStringsError(CheckUniqueModuloCase
 ##
 
 
+def cmp_nullable(x: TSupportsLT | None, y: TSupportsLT | None, /) -> Sign:
+    """Compare two nullable objects."""
+    match x, y:
+        case None, None:
+            return 0
+        case None, _:
+            return -1
+        case _, None:
+            return 1
+        case _, _:
+            return cast("Sign", (x > y) - (x < y))
+        case _ as never:
+            assert_never(never)
+
+
+##
+
+
 def chunked(iterable: Iterable[_T], n: int, /) -> Iterator[Sequence[_T]]:
     """Break an iterable into lists of length n."""
     return iter(partial(take, n, iter(iterable)), [])
@@ -1293,7 +1311,7 @@ def sort_iterable(iterable: Iterable[_T], /) -> list[_T]:
     return sorted(iterable, key=cmp_to_key(_sort_iterable_cmp))
 
 
-def _sort_iterable_cmp(x: Any, y: Any, /) -> Literal[-1, 0, 1]:
+def _sort_iterable_cmp(x: Any, y: Any, /) -> Sign:
     """Compare two quantities."""
     if type(x) is not type(y):
         x_qualname = type(x).__qualname__
@@ -1318,7 +1336,7 @@ def _sort_iterable_cmp(x: Any, y: Any, /) -> Literal[-1, 0, 1]:
         return _sort_iterable_cmp_floats(x, y)
     if isinstance(x, str):  # else Sequence
         y = cast("str", y)
-        return cast("Literal[-1, 0, 1]", (x > y) - (x < y))
+        return cast("Sign", (x > y) - (x < y))
 
     # collections
     if isinstance(x, Sized):
@@ -1333,14 +1351,14 @@ def _sort_iterable_cmp(x: Any, y: Any, /) -> Literal[-1, 0, 1]:
         return _sort_iterable_cmp(sort_iterable(x), sort_iterable(y))
     if isinstance(x, Sequence):
         y = cast("Sequence[Any]", y)
-        it: Iterable[Literal[-1, 0, 1]] = (
+        it: Iterable[Sign] = (
             _sort_iterable_cmp(x_i, y_i) for x_i, y_i in zip(x, y, strict=True)
         )
         with suppress(StopIteration):
             return next(r for r in it if r != 0)
 
     try:
-        return cast("Literal[-1, 0, 1]", (x > y) - (x < y))
+        return cast("Sign", (x > y) - (x < y))
     except TypeError:
         raise SortIterableError(x=x, y=y) from None
 
@@ -1355,13 +1373,11 @@ class SortIterableError(Exception):
         return f"Unable to sort {get_repr(self.x)} and {get_repr(self.y)}"
 
 
-def _sort_iterable_cmp_datetimes(
-    x: dt.datetime, y: dt.datetime, /
-) -> Literal[-1, 0, 1]:
+def _sort_iterable_cmp_datetimes(x: dt.datetime, y: dt.datetime, /) -> Sign:
     """Compare two datetimes."""
     match x.tzinfo, y.tzinfo:
         case None, None:
-            return cast("Literal[-1, 0, 1]", (x > y) - (x < y))
+            return cast("Sign", (x > y) - (x < y))
         case dt.tzinfo(), None:
             return 1
         case None, dt.tzinfo():
@@ -1369,20 +1385,19 @@ def _sort_iterable_cmp_datetimes(
         case dt.tzinfo(), dt.tzinfo():
             x_utc = x.astimezone(tz=UTC)
             y_utc = y.astimezone(tz=UTC)
-            result = cast("Literal[-1, 0, 1]", (x_utc > y_utc) - (x_utc < y_utc))
+            result = cast("Sign", (x_utc > y_utc) - (x_utc < y_utc))
             if result != 0:
                 return result
             x_time_zone = ensure_not_none(ensure_not_none(x.tzinfo).tzname(x))
             y_time_zone = ensure_not_none(ensure_not_none(y.tzinfo).tzname(y))
             return cast(
-                "Literal[-1, 0, 1]",
-                (x_time_zone > y_time_zone) - (x_time_zone < y_time_zone),
+                "Sign", (x_time_zone > y_time_zone) - (x_time_zone < y_time_zone)
             )
         case _ as never:
             assert_never(never)
 
 
-def _sort_iterable_cmp_floats(x: float, y: float, /) -> Literal[-1, 0, 1]:
+def _sort_iterable_cmp_floats(x: float, y: float, /) -> Sign:
     """Compare two floats."""
     x_nan, y_nan = map(isnan, [x, y])
     match x_nan, y_nan:
@@ -1393,7 +1408,7 @@ def _sort_iterable_cmp_floats(x: float, y: float, /) -> Literal[-1, 0, 1]:
         case False, True:
             return -1
         case False, False:
-            return cast("Literal[-1, 0, 1]", (x > y) - (x < y))
+            return cast("Sign", (x > y) - (x < y))
         case _ as never:
             assert_never(never)
 
@@ -1517,6 +1532,7 @@ __all__ = [
     "check_superset",
     "check_unique_modulo_case",
     "chunked",
+    "cmp_nullable",
     "ensure_hashables",
     "ensure_iterable",
     "ensure_iterable_not_str",

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/utilities/math.py

@@ -10,7 +10,7 @@ from typing import TYPE_CHECKING, Literal, assert_never, overload, override
 from utilities.errors import ImpossibleCaseError
 
 if TYPE_CHECKING:
-    from utilities.types import Number, RoundMode
+    from utilities.types import Number, RoundMode, Sign
 
 
 MIN_FLOAT32, MAX_FLOAT32 = -3.4028234663852886e38, 3.4028234663852886e38
@@ -860,7 +860,7 @@ class SafeRoundError(Exception):
 
 def sign(
     x: float, /, *, rel_tol: float | None = None, abs_tol: float | None = None
-) -> Literal[-1, 0, 1]:
+) -> Sign:
     """Get the sign of an integer/float."""
     match x:
         case int():

{dycw_utilities-0.113.0 → dycw_utilities-0.113.2}/src/utilities/types.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import datetime as dt
+from asyncio import Event
 from collections.abc import Awaitable, Callable, Coroutine, Hashable, Iterable, Mapping
 from enum import Enum
 from logging import Logger
@@ -57,6 +58,7 @@ type TupleOrStrMapping = tuple[Any, ...] | StrMapping
 # asyncio
 type Coroutine1[_T] = Coroutine[Any, Any, _T]
 type MaybeAwaitable[_T] = _T | Awaitable[_T]
+type MaybeCallableEvent = MaybeCallable[Event]
 type MaybeCoroutine1[_T] = _T | Coroutine1[_T]
 
 
@@ -140,6 +142,7 @@ type RoundMode = Literal[
     "standard-tie-toward-zero",
     "standard-tie-away-zero",
 ]
+type Sign = Literal[-1, 0, 1]
 
 
 # operator
@@ -276,6 +279,7 @@ __all__ = [
     "MaybeCallable",
     "MaybeCallableDate",
     "MaybeCallableDateTime",
+    "MaybeCallableEvent",
     "MaybeCoroutine1",
     "MaybeIterable",
     "MaybeIterableHashable",
@@ -291,6 +295,7 @@ __all__ = [
     "RoundMode",
     "Seed",
     "SerializeObjectExtra",
+    "Sign",
     "StrMapping",
     "StrStrMapping",
     "SupportsAbs",