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

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

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

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

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

{dycw_utilities-0.110.7 → dycw_utilities-0.110.8}/src/tests/test_typing.py

@@ -4,6 +4,7 @@ import datetime as dt
 from collections.abc import Mapping, Sequence
 from dataclasses import dataclass
 from pathlib import Path
+from random import Random
 from types import NoneType
 from typing import TYPE_CHECKING, Any, Literal, NamedTuple, Self
 from uuid import UUID
@@ -39,12 +40,15 @@ from tests.test_typing_funcs.with_future import (
     TrueOrFalseFutureTypeLit,
 )
 from utilities.sentinel import Sentinel
-from utilities.types import LogLevel, Parallelism
+from utilities.types import Duration, LogLevel, Number, Parallelism, Seed
 from utilities.typing import (
+    _GetUnionTypeClassesNotATypeError,
+    _GetUnionTypeClassesNotAUnionTypeError,
     contains_self,
     get_args,
     get_literal_elements,
     get_type_hints,
+    get_union_type_classes,
     is_dict_type,
     is_frozenset_type,
     is_list_type,
@@ -335,6 +339,34 @@ class TestGetTypeHints:
             _ = get_type_hints(Outer, warn_name_errors=True)
 
 
+class TestGetUnionTypeClasses:
+    @given(
+        case=sampled_from([
+            (Duration, (int, float, dt.timedelta)),
+            (Number, (int, float)),
+            (Seed, (int, float, str, bytes, bytearray, Random)),
+        ])
+    )
+    def test_main(self, *, case: tuple[Any, tuple[type[Any], ...]]) -> None:
+        obj, expected = case
+        result = get_union_type_classes(obj)
+        assert result == expected
+
+    def test_error_not_a_union_type(self) -> None:
+        with raises(
+            _GetUnionTypeClassesNotAUnionTypeError,
+            match="Object must be a Union type; got None",
+        ):
+            _ = get_union_type_classes(None)
+
+    def test_error_not_a_type(self) -> None:
+        with raises(
+            _GetUnionTypeClassesNotATypeError,
+            match=r"Union type must contain types only; got typing\.Literal\[True\]",
+        ):
+            _ = get_union_type_classes(Literal[True] | None)
+
+
 class TestIsAnnotationOfType:
     @mark.parametrize(
         ("func", "obj", "expected"),

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

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

{dycw_utilities-0.110.7 → dycw_utilities-0.110.8}/src/utilities/typing.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import datetime as dt
 from collections.abc import Mapping, Sequence
+from dataclasses import dataclass
 from itertools import chain
 from pathlib import Path
 from types import NoneType, UnionType
@@ -15,6 +16,7 @@ from typing import (
     TypeGuard,
     Union,  # pyright: ignore[reportDeprecated]
     get_origin,
+    override,
 )
 from typing import get_args as _get_args
 from typing import get_type_hints as _get_type_hints
@@ -64,7 +66,7 @@ def _get_literal_elements_inner(obj: Any, /) -> list[Any]:
 
 
 def get_type_hints(
-    cls: Any,
+    obj: Any,
     /,
     *,
     globalns: StrMapping | None = None,
@@ -72,15 +74,15 @@ def get_type_hints(
     warn_name_errors: bool = False,
 ) -> dict[str, Any]:
     """Get the type hints of an object."""
-    result: dict[str, Any] = cls.__annotations__
+    result: dict[str, Any] = obj.__annotations__
     _ = {Literal, Path, Sentinel, StrMapping, UUID, dt}
     globalns_use = globals() | ({} if globalns is None else dict(globalns))
     localns_use = {} if localns is None else dict(localns)
     try:
-        hints = _get_type_hints(cls, globalns=globalns_use, localns=localns_use)
+        hints = _get_type_hints(obj, globalns=globalns_use, localns=localns_use)
     except NameError as error:
         if warn_name_errors:
-            warn(f"Error getting type hints for {cls!r}; {error}", stacklevel=2)
+            warn(f"Error getting type hints for {obj!r}; {error}", stacklevel=2)
     else:
         result.update({
             key: value
@@ -93,6 +95,44 @@ def get_type_hints(
 ##
 
 
+def get_union_type_classes(obj: Any, /) -> tuple[type[Any], ...]:
+    if not is_union_type(obj):
+        raise _GetUnionTypeClassesNotAUnionTypeError(obj=obj)
+    types_: Sequence[type[Any]] = []
+    for arg in get_args(obj):
+        if isinstance(arg, type):
+            types_.append(arg)
+        elif is_union_type(arg):
+            types_.extend(get_union_type_classes(arg))
+        else:
+            raise _GetUnionTypeClassesNotATypeError(obj=obj, inner=arg)
+    return tuple(types_)
+
+
+@dataclass(kw_only=True, slots=True)
+class GetUnionTypeClassesError(Exception):
+    obj: Any
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetUnionTypeClassesNotAUnionTypeError(GetUnionTypeClassesError):
+    @override
+    def __str__(self) -> str:
+        return f"Object must be a Union type; got {self.obj}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetUnionTypeClassesNotATypeError(GetUnionTypeClassesError):
+    inner: Any
+
+    @override
+    def __str__(self) -> str:
+        return f"Union type must contain types only; got {self.inner}"
+
+
+##
+
+
 def is_dict_type(obj: Any, /) -> bool:
     """Check if an object is a dict type annotation."""
     return _is_annotation_of_type(obj, dict)
@@ -207,9 +247,11 @@ def _is_annotation_of_type(obj: Any, origin: Any, /) -> bool:
 
 
 __all__ = [
+    "GetUnionTypeClassesError",
     "contains_self",
     "get_literal_elements",
     "get_type_hints",
+    "get_union_type_classes",
     "is_dict_type",
     "is_frozenset_type",
     "is_list_type",