dycw-utilities 0.110.5__tar.gz → 0.110.7__tar.gz

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/PKG-INFO

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

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/pyproject.toml

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

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/tests/test_functions.py

@@ -12,6 +12,7 @@ from typing import TYPE_CHECKING, Any, ClassVar, ParamSpec, TypeVar, cast
 from hypothesis import given
 from hypothesis.strategies import (
     DataObject,
+    SearchStrategy,
     booleans,
     builds,
     data,
@@ -73,7 +74,7 @@ from utilities.functions import (
     is_dataclass_class,
     is_dataclass_instance,
     is_hashable,
-    is_instance_int_not_bool,
+    is_instance_not_bool_int,
     is_iterable_of,
     is_none,
     is_not_none,
@@ -82,7 +83,7 @@ from utilities.functions import (
     is_sized,
     is_sized_not_str,
     is_string_mapping,
-    is_subclass_int_not_bool,
+    is_subclass_not_bool_int,
     is_tuple,
     is_tuple_or_str_mapping,
     make_isinstance,
@@ -621,14 +622,37 @@ class TestIsHashable:
         assert is_hashable(obj) is expected
 
 
-class TestIsInstanceIntNotBool:
-    @given(int_=integers())
-    def test_int(self, *, int_: int) -> None:
-        assert is_instance_int_not_bool(int_)
+class TestIsInstanceNotIntBool:
+    @given(
+        data=data(),
+        case=sampled_from([
+            (booleans(), bool, True),
+            (booleans(), int, False),
+            (integers(), bool, False),
+            (integers(), int, True),
+            (booleans(), (bool, int), True),
+            (integers(), (bool, int), True),
+        ]),
+    )
+    def test_main(
+        self, *, data: DataObject, case: tuple[SearchStrategy[Any], type[Any], bool]
+    ) -> None:
+        strategy, type_, expected = case
+        value = data.draw(strategy)
+        assert is_instance_not_bool_int(value, type_) is expected
 
     @given(bool_=booleans())
-    def test_bool(self, *, bool_: bool) -> None:
-        assert not is_instance_int_not_bool(bool_)
+    def test_bool_value_vs_custom_int(self, *, bool_: bool) -> None:
+        class MyInt(int): ...
+
+        assert not is_instance_not_bool_int(bool_, MyInt)
+
+    @given(int_=integers())
+    def test_int_value_vs_custom_int(self, *, int_: int) -> None:
+        class MyInt(int): ...
+
+        assert not is_instance_not_bool_int(int_, MyInt)
+        assert is_instance_not_bool_int(MyInt(int_), MyInt)
 
 
 class TestIsIterableOf:
@@ -751,11 +775,29 @@ class TestIsStringMapping:
         assert result is expected
 
 
-class TestIsSubclassIntNotBool:
-    @given(case=sampled_from([(int, True), (bool, False)]))
-    def test_main(self, *, case: tuple[type[Any], bool]) -> None:
-        type_, expected = case
-        assert is_subclass_int_not_bool(type_) is expected
+class TestIsSubclassNotBoolInt:
+    @given(
+        case=sampled_from([
+            (bool, bool, True),
+            (bool, int, False),
+            (int, bool, False),
+            (int, int, True),
+            (bool, (bool, int), True),
+            (int, (bool, int), True),
+        ])
+    )
+    def test_main(self, *, case: tuple[type[Any], type[Any], bool]) -> None:
+        child, parent, expected = case
+        assert is_subclass_not_bool_int(child, parent) is expected
+
+    def test_custom_int(self) -> None:
+        class MyInt(int): ...
+
+        assert not is_subclass_not_bool_int(bool, MyInt)
+        assert not is_subclass_not_bool_int(MyInt, bool)
+        assert not is_subclass_not_bool_int(int, MyInt)
+        assert is_subclass_not_bool_int(MyInt, int)
+        assert is_subclass_not_bool_int(MyInt, MyInt)
 
 
 class TestIsTuple:

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/tests/test_modules.py

@@ -28,6 +28,8 @@ if TYPE_CHECKING:
     from collections.abc import Callable
     from types import ModuleType
 
+    from utilities.types import TypeLike
+
 
 class TestIsInstalled:
     @given(case=sampled_from([("importlib", True), ("invalid", False)]))
@@ -90,7 +92,7 @@ class TestYieldModuleContents:
         self,
         *,
         case1: tuple[ModuleType, bool, int],
-        case2: tuple[type[Any] | tuple[type[Any], ...], Callable[[Any], bool], int],
+        case2: tuple[TypeLike[Any], Callable[[Any], bool], int],
     ) -> None:
         module, recursive, factor = case1
         type_, predicate, expected = case2

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.110.5"
+__version__ = "0.110.7"

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/eventkit.py

@@ -39,7 +39,7 @@ from eventkit import (
 from utilities.functions import apply_decorators
 from utilities.iterables import always_iterable
 from utilities.logging import get_logger
-from utilities.types import TCallable, TCallableMaybeCoroutine1None
+from utilities.types import TCallable, TCallableMaybeCoroutine1None, TypeLike
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -59,7 +59,7 @@ def add_listener(
     /,
     *,
     error: Callable[[Event, BaseException], MaybeCoroutine1[None]] | None = None,
-    ignore: type[BaseException] | tuple[type[BaseException], ...] | None = None,
+    ignore: TypeLike[BaseException] | None = None,
     logger: LoggerOrName | None = None,
     decorators: MaybeIterable[Callable[[TCallable], TCallable]] | None = None,
     done: Callable[..., MaybeCoroutine1[None]] | None = None,
@@ -104,7 +104,7 @@ class LiftedEvent(Generic[TCallableMaybeCoroutine1None]):
         /,
         *,
         error: Callable[[Event, BaseException], MaybeCoroutine1[None]] | None = None,
-        ignore: type[BaseException] | tuple[type[BaseException], ...] | None = None,
+        ignore: TypeLike[BaseException] | None = None,
         logger: LoggerOrName | None = None,
         decorators: MaybeIterable[Callable[[TCallable], TCallable]] | None = None,
         done: Callable[..., MaybeCoroutine1[None]] | None = None,
@@ -267,7 +267,7 @@ class TypedEvent(Event, Generic[TCallableMaybeCoroutine1None]):
         done: Callable[[Self], MaybeCoroutine1[None]] | None = None,
         keep_ref: bool = False,
         *,
-        ignore: type[BaseException] | tuple[type[BaseException], ...] | None = None,
+        ignore: TypeLike[BaseException] | None = None,
         logger: LoggerOrName | None = None,
         decorators: MaybeIterable[Callable[[TCallable], TCallable]] | None = None,
     ) -> Self:
@@ -295,7 +295,7 @@ def lift_listener(
     /,
     *,
     error: Callable[[Event, BaseException], MaybeCoroutine1[None]] | None = None,
-    ignore: type[BaseException] | tuple[type[BaseException], ...] | None = None,
+    ignore: TypeLike[BaseException] | None = None,
     logger: LoggerOrName | None = None,
     decorators: MaybeIterable[Callable[[TCallable], TCallable]] | None = None,
 ) -> Callable[..., MaybeCoroutine1[None]]:

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/functions.py

@@ -22,6 +22,7 @@ from typing import (
     Literal,
     TypeGuard,
     TypeVar,
+    assert_never,
     cast,
     overload,
     override,
@@ -40,6 +41,7 @@ from utilities.types import (
     TCallable2,
     TSupportsRichComparison,
     TupleOrStrMapping,
+    TypeLike,
 )
 
 if TYPE_CHECKING:
@@ -181,9 +183,9 @@ def ensure_class(
     *,
     nullable: Literal[False] = False,
 ) -> _T1 | _T2 | _T3 | _T4 | _T5: ...
-def ensure_class(
-    obj: Any, cls: type[_T] | tuple[type[_T], ...], /, *, nullable: bool = False
-) -> Any:
+@overload
+def ensure_class(obj: Any, cls: TypeLike[_T], /, *, nullable: bool = False) -> Any: ...
+def ensure_class(obj: Any, cls: TypeLike[_T], /, *, nullable: bool = False) -> Any:
     """Ensure an object is of the required class."""
     if isinstance(obj, cls) or ((obj is None) and nullable):
         return obj
@@ -193,7 +195,7 @@ def ensure_class(
 @dataclass(kw_only=True, slots=True)
 class EnsureClassError(Exception):
     obj: Any
-    cls: type[Any] | tuple[type[Any], ...]
+    cls: TypeLike[Any]
     nullable: bool
 
     @override
@@ -658,9 +660,23 @@ def is_hashable(obj: Any, /) -> TypeGuard[Hashable]:
 ##
 
 
-def is_instance_int_not_bool(obj: Any, /) -> TypeGuard[int]:
-    """Check if an object is an integer, and not a boolean."""
-    return isinstance(obj, int) and not isinstance(obj, bool)
+def is_instance_not_bool_int(
+    obj: Any, class_or_tuple: TypeLike[Any], /
+) -> TypeGuard[int]:
+    """Check if an instance relationship holds, except bool<int."""
+    match class_or_tuple:
+        case type() as type_:
+            return _is_instance_not_bool_int(obj, type_)
+        case tuple() as types:
+            return any(_is_instance_not_bool_int(obj, p) for p in types)
+        case _ as never:
+            assert_never(never)
+
+
+def _is_instance_not_bool_int(obj: Any, type_: type[Any], /) -> bool:
+    return isinstance(obj, type_) and not (
+        isinstance(obj, bool) and issubclass(type_, int) and not issubclass(type_, bool)
+    )
 
 
 ##
@@ -686,7 +702,9 @@ def is_iterable_of(
 def is_iterable_of(
     obj: Any, cls: tuple[type[_T1], type[_T2], type[_T3], type[_T4], type[_T5]], /
 ) -> TypeGuard[Iterable[_T1 | _T2 | _T3 | _T4 | _T5]]: ...
-def is_iterable_of(obj: Any, cls: Any, /) -> TypeGuard[Iterable[Any]]:
+@overload
+def is_iterable_of(obj: Any, cls: TypeLike[_T], /) -> TypeGuard[Iterable[_T]]: ...
+def is_iterable_of(obj: Any, cls: TypeLike[_T], /) -> TypeGuard[Iterable[_T]]:
     """Check if an object is a iterable of tuple or string mappings."""
     return isinstance(obj, Iterable) and all(map(make_isinstance(cls), obj))
 
@@ -730,7 +748,9 @@ def is_sequence_of(
 def is_sequence_of(
     obj: Any, cls: tuple[type[_T1], type[_T2], type[_T3], type[_T4], type[_T5]], /
 ) -> TypeGuard[Sequence[_T1 | _T2 | _T3 | _T4 | _T5]]: ...
-def is_sequence_of(obj: Any, cls: Any, /) -> TypeGuard[Sequence[Any]]:
+@overload
+def is_sequence_of(obj: Any, cls: TypeLike[_T], /) -> TypeGuard[Sequence[_T]]: ...
+def is_sequence_of(obj: Any, cls: TypeLike[_T], /) -> TypeGuard[Sequence[_T]]:
     """Check if an object is a sequence of tuple or string mappings."""
     return isinstance(obj, Sequence) and is_iterable_of(obj, cls)
 
@@ -776,9 +796,23 @@ def is_string_mapping(obj: Any, /) -> TypeGuard[StrMapping]:
 ##
 
 
-def is_subclass_int_not_bool(cls: type[Any], /) -> TypeGuard[type[int]]:
-    """Check if a class is an integer, and not a boolean."""
-    return issubclass(cls, int) and not issubclass(cls, bool)
+def is_subclass_not_bool_int(cls: type[Any], class_or_tuple: TypeLike[Any], /) -> bool:
+    """Check if a subclass relationship holds, except bool<int."""
+    match class_or_tuple:
+        case type() as parent:
+            return _is_subclass_int_not_bool_one(cls, parent)
+        case tuple() as parents:
+            return any(_is_subclass_int_not_bool_one(cls, p) for p in parents)
+        case _ as never:
+            assert_never(never)
+
+
+def _is_subclass_int_not_bool_one(cls: type[Any], parent: type[Any], /) -> bool:
+    return issubclass(cls, parent) and not (
+        issubclass(cls, bool)
+        and issubclass(parent, int)
+        and not issubclass(parent, bool)
+    )
 
 
 ##
@@ -820,19 +854,14 @@ def make_isinstance(
 def make_isinstance(
     cls: tuple[type[_T1], type[_T2], type[_T3], type[_T4], type[_T5]], /
 ) -> Callable[[Any], TypeGuard[_T1 | _T2 | _T3 | _T4 | _T5]]: ...
-def make_isinstance(
-    cls: type[_T] | tuple[type[_T], ...], /
-) -> Callable[[Any], TypeGuard[Any]]:
+@overload
+def make_isinstance(cls: TypeLike[_T], /) -> Callable[[Any], TypeGuard[_T]]: ...
+def make_isinstance(cls: TypeLike[_T], /) -> Callable[[Any], TypeGuard[_T]]:
     """Make a curried `isinstance` function."""
     return partial(_make_instance_core, cls=cls)
 
 
-##
-
-
-def _make_instance_core(
-    obj: Any, /, *, cls: type[_T] | tuple[type[_T], ...]
-) -> TypeGuard[_T]:
+def _make_instance_core(obj: Any, /, *, cls: TypeLike[_T]) -> TypeGuard[_T]:
     return isinstance(obj, cls)
 
 
@@ -1046,7 +1075,7 @@ __all__ = [
     "is_dataclass_class",
     "is_dataclass_instance",
     "is_hashable",
-    "is_instance_int_not_bool",
+    "is_instance_not_bool_int",
     "is_iterable_of",
     "is_none",
     "is_not_none",
@@ -1054,7 +1083,7 @@ __all__ = [
     "is_sized",
     "is_sized_not_str",
     "is_string_mapping",
-    "is_subclass_int_not_bool",
+    "is_subclass_not_bool_int",
     "is_tuple",
     "is_tuple_or_str_mapping",
     "make_isinstance",

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/modules.py

@@ -11,6 +11,8 @@ if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Iterator
     from types import ModuleType
 
+    from utilities.types import TypeLike
+
 
 def is_installed(module: str, /) -> bool:
     """Check if a module is installed."""
@@ -63,7 +65,7 @@ def yield_module_contents(
     *,
     missing_ok: Iterable[str] | None = None,
     recursive: bool = False,
-    type: type[Any] | tuple[type[Any], ...] | None = None,  # noqa: A002
+    type: TypeLike[Any] | None = None,  # noqa: A002
     predicate: Callable[[Any], bool] | None = None,
 ) -> Iterator[Any]:
     """Yield all the module contents under a package.

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/parse.py

@@ -14,7 +14,7 @@ from utilities.datetime import (
     is_subclass_date_not_datetime,
 )
 from utilities.enum import ParseEnumError, parse_enum
-from utilities.functions import is_subclass_int_not_bool
+from utilities.functions import is_subclass_not_bool_int
 from utilities.iterables import OneEmptyError, OneNonUniqueError, one, one_str
 from utilities.math import ParseNumberError, parse_number
 from utilities.re import ExtractGroupError, extract_group
@@ -174,7 +174,7 @@ def _parse_object_type(
             return parse_bool(text)
         except ParseBoolError:
             raise _ParseObjectParseError(type_=cls, text=text) from None
-    if is_subclass_int_not_bool(cls):
+    if is_subclass_not_bool_int(cls, int):
         try:
             return int(text)
         except ValueError:

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/pyrsistent.py

@@ -15,6 +15,8 @@ from pyrsistent._field_common import (
 if TYPE_CHECKING:
     from collections.abc import Callable
 
+    from utilities.types import TypeLike
+
 
 _T = TypeVar("_T")
 _U = TypeVar("_U")
@@ -62,7 +64,7 @@ def field(
 ) -> Any: ...
 def field(
     *,
-    type: type[_T] | tuple[type[_T], ...] = PFIELD_NO_TYPE,  # noqa: A002
+    type: TypeLike[_T] = PFIELD_NO_TYPE,  # noqa: A002
     invariant: Callable[[Any], tuple[bool, Any]] = PFIELD_NO_INVARIANT,
     default: Any = PFIELD_NO_INITIAL,
     mandatory: bool = False,

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/redis.py

@@ -42,7 +42,7 @@ if TYPE_CHECKING:
     from redis.typing import ResponseT
 
     from utilities.iterables import MaybeIterable
-    from utilities.types import Duration
+    from utilities.types import Duration, TypeLike
 
 
 _K = TypeVar("_K")
@@ -69,9 +69,9 @@ class RedisHashMapKey(Generic[_K, _V]):
     """A hashmap key in a redis store."""
 
     name: str
-    key: type[_K]
+    key: TypeLike[_K]
     key_serializer: Callable[[_K], bytes] | None = None
-    value: type[_V]
+    value: TypeLike[_V]
     value_serializer: Callable[[_V], bytes] | None = None
     value_deserializer: Callable[[bytes], _V] | None = None
     timeout: Duration | None = None
@@ -262,10 +262,24 @@ def redis_hash_map_key(
     error: type[Exception] = TimeoutError,
     ttl: Duration | None = None,
 ) -> RedisHashMapKey[_K1 | _K2 | _K3, _V1 | _V2 | _V3]: ...
+@overload
+def redis_hash_map_key(
+    name: str,
+    key: TypeLike[_K],
+    value: TypeLike[_V],
+    /,
+    *,
+    key_serializer: Callable[[_K1 | _K2 | _K3], bytes] | None = None,
+    value_serializer: Callable[[_V1 | _V2 | _V3], bytes] | None = None,
+    value_deserializer: Callable[[bytes], _V1 | _V2 | _V3] | None = None,
+    timeout: Duration | None = None,
+    error: type[Exception] = TimeoutError,
+    ttl: Duration | None = None,
+) -> RedisHashMapKey[_K, _V]: ...
 def redis_hash_map_key(
     name: str,
-    key: Any,
-    value: Any,
+    key: TypeLike[_K],
+    value: TypeLike[_V],
     /,
     *,
     key_serializer: Callable[[Any], bytes] | None = None,
@@ -274,7 +288,7 @@ def redis_hash_map_key(
     timeout: Duration | None = None,
     ttl: Duration | None = None,
     error: type[Exception] = TimeoutError,
-) -> RedisHashMapKey[Any, Any]:
+) -> RedisHashMapKey[_K, _V]:
     """Create a redis key."""
     return RedisHashMapKey(  # skipif-ci-and-not-linux
         name=name,
@@ -297,7 +311,7 @@ class RedisKey(Generic[_T]):
     """A key in a redis store."""
 
     name: str
-    type: type[_T]
+    type: TypeLike[_T]
     serializer: Callable[[_T], bytes] | None = None
     deserializer: Callable[[bytes], _T] | None = None
     timeout: Duration | None = None
@@ -420,9 +434,21 @@ def redis_key(
     error: type[Exception] = TimeoutError,
     ttl: Duration | None = None,
 ) -> RedisKey[_T1 | _T2 | _T3 | _T4 | _T5]: ...
+@overload
+def redis_key(
+    name: str,
+    type_: TypeLike[_T],
+    /,
+    *,
+    serializer: Callable[[_T1 | _T2 | _T3 | _T4 | _T5], bytes] | None = None,
+    deserializer: Callable[[bytes], _T1 | _T2 | _T3 | _T4 | _T5] | None = None,
+    timeout: Duration | None = None,
+    error: type[Exception] = TimeoutError,
+    ttl: Duration | None = None,
+) -> RedisKey[_T]: ...
 def redis_key(
     name: str,
-    type_: Any,
+    type_: TypeLike[_T],
     /,
     *,
     serializer: Callable[[Any], bytes] | None = None,
@@ -430,7 +456,7 @@ def redis_key(
     timeout: Duration | None = None,
     error: type[Exception] = TimeoutError,
     ttl: Duration | None = None,
-) -> RedisKey[Any]:
+) -> RedisKey[_T]:
     """Create a redis key."""
     return RedisKey(  # skipif-ci-and-not-linux
         name=name,

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/types.py

@@ -45,12 +45,13 @@ type OpenMode = Literal[
     "x+b",
     "a+b",
 ]
-type StrMapping = Mapping[str, Any]
-type StrStrMapping = Mapping[str, str]
-type TupleOrStrMapping = tuple[Any, ...] | StrMapping
 type MaybeCallable[_T] = _T | Callable[[], _T]
 type MaybeStr[_T] = _T | str
 type MaybeType[_T] = _T | type[_T]
+type StrMapping = Mapping[str, Any]
+type StrStrMapping = Mapping[str, str]
+type TypeLike[_T] = type[_T] | tuple[type[_T], ...]
+type TupleOrStrMapping = tuple[Any, ...] | StrMapping
 
 
 # asyncio
@@ -327,5 +328,6 @@ __all__ = [
     "TimeZone",
     "TimeZoneLike",
     "TupleOrStrMapping",
+    "TypeLike",
     "WeekDay",
 ]

{dycw_utilities-0.110.5 → dycw_utilities-0.110.7}/src/utilities/warnings.py

@@ -7,12 +7,12 @@ from warnings import catch_warnings, filterwarnings
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
+    from utilities.types import TypeLike
+
 
 @contextmanager
 def catch_warnings_as_errors(
-    *,
-    message: str = "",
-    category: type[Warning] | tuple[type[Warning], ...] | None = None,
+    *, message: str = "", category: TypeLike[Warning] | None = None
 ) -> Iterator[None]:
     """Catch warnings as errors."""
     with _handle_warnings("error", message=message, category=category):
@@ -21,9 +21,7 @@ def catch_warnings_as_errors(
 
 @contextmanager
 def suppress_warnings(
-    *,
-    message: str = "",
-    category: type[Warning] | tuple[type[Warning], ...] | None = None,
+    *, message: str = "", category: TypeLike[Warning] | None = None
 ) -> Iterator[None]:
     """Suppress warnings."""
     with _handle_warnings("ignore", message=message, category=category):
@@ -38,7 +36,7 @@ def _handle_warnings(
     /,
     *,
     message: str = "",
-    category: type[Warning] | tuple[type[Warning], ...] | None = None,
+    category: TypeLike[Warning] | None = None,
 ) -> ExitStack:
     """Handle a set of warnings."""
     stack = ExitStack()