dycw-utilities 0.153.0__tar.gz → 0.153.2__tar.gz

{dycw_utilities-0.153.0 → dycw_utilities-0.153.2}/PKG-INFO

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

{dycw_utilities-0.153.0 → dycw_utilities-0.153.2}/pyproject.toml

@@ -229,7 +229,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.153.0"
+version = "0.153.2"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -262,7 +262,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.153.0"
+current_version = "0.153.2"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.153.0 → dycw_utilities-0.153.2}/src/tests/test_text.py

@@ -38,6 +38,7 @@ from utilities.text import (
     str_encode,
     strip_and_dedent,
     to_bool,
+    to_str,
     unique_str,
 )
 
@@ -340,6 +341,20 @@ class TestToBool:
         assert to_bool(lambda: bool_) is bool_
 
 
+class TestToStr:
+    @given(text=text_ascii())
+    def test_str(self, *, text: str) -> None:
+        assert to_str(text) == text
+
+    @given(text=text_ascii())
+    def test_callable(self, *, text: str) -> None:
+        assert to_str(lambda: text) == text
+
+    @given(text=none() | sentinels())
+    def test_none_or_sentinel(self, *, text: None | Sentinel) -> None:
+        assert to_str(text) is text
+
+
 class TestUniqueStrs:
     def test_main(self) -> None:
         first, second = [unique_str() for _ in range(2)]

{dycw_utilities-0.153.0 → dycw_utilities-0.153.2}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.153.0"
+__version__ = "0.153.2"

{dycw_utilities-0.153.0 → dycw_utilities-0.153.2}/src/utilities/text.py

@@ -28,7 +28,7 @@ from utilities.sentinel import Sentinel
 if TYPE_CHECKING:
     from collections.abc import Iterable, Mapping, Sequence
 
-    from utilities.types import MaybeCallableBoolLike, StrStrMapping
+    from utilities.types import MaybeCallableBoolLike, MaybeCallableStr, StrStrMapping
 
 
 DEFAULT_SEPARATOR = ","
@@ -462,6 +462,26 @@ def to_bool(
 ##
 
 
+@overload
+def to_str(text: MaybeCallableStr, /) -> str: ...
+@overload
+def to_str(text: None, /) -> None: ...
+@overload
+def to_str(text: Sentinel, /) -> Sentinel: ...
+def to_str(text: MaybeCallableStr | None | Sentinel, /) -> str | None | Sentinel:
+    """Convert to a string."""
+    match text:
+        case str() | None | Sentinel():
+            return text
+        case Callable() as func:
+            return to_str(func())
+        case never:
+            assert_never(never)
+
+
+##
+
+
 def unique_str() -> str:
     """Generate at unique string."""
     now = time_ns()
@@ -491,5 +511,6 @@ __all__ = [
     "str_encode",
     "strip_and_dedent",
     "to_bool",
+    "to_str",
     "unique_str",
 ]

{dycw_utilities-0.153.0 → dycw_utilities-0.153.2}/src/utilities/types.py

@@ -39,7 +39,6 @@ _T_contra = TypeVar("_T_contra", contravariant=True)
 
 
 # basic
-type BoolLike = MaybeStr[bool]
 type OpenMode = Literal[
     "r",
     "w",
@@ -63,13 +62,15 @@ type OpenMode = Literal[
     "a+b",
 ]
 type MaybeCallable[T] = T | Callable[[], T]
-type MaybeCallableBoolLike = MaybeCallable[BoolLike]
 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
+type TypeLike[T] = type[T] | tuple[type[T], ...]
+# basic - derived
+type MaybeCallableBoolLike = MaybeCallable[BoolLike]
+type BoolLike = MaybeStr[bool]
 
 
 # asyncio
@@ -114,12 +115,12 @@ IPv6AddressLike = MaybeStr[IPv6Address]
 
 
 # iterables
-type SequenceLT[T] = list[T] | tuple[T, ...]
-# iterables - maybe
 type MaybeCollection[T] = T | Collection[T]
 type MaybeIterable[T] = T | Iterable[T]
+type MaybeList[T] = T | list[T]
+type SequenceLT[T] = list[T] | tuple[T, ...]
+# iterables - dervied
 type MaybeSequence[T] = T | SequenceLT[T]
-# iterables - str
 type SequenceStr = SequenceLT[str]
 type CollectionStr = dict[str, Any] | frozenset[str] | set[str] | SequenceStr
 # iterables - maybe str
@@ -299,6 +300,7 @@ __all__ = [
     "MaybeCollectionStr",
     "MaybeCoro",
     "MaybeIterable",
+    "MaybeList",
     "MaybeSequence",
     "MaybeSequenceStr",
     "MaybeStr",