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

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

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

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

@@ -229,7 +229,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.152.0"
+version = "0.153.0"
 
 [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.152.0"
+current_version = "0.153.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_functions.py

@@ -90,13 +90,11 @@ from utilities.functions import (
     min_nullable,
     not_func,
     second,
-    to_bool,
     yield_object_attributes,
     yield_object_cached_properties,
     yield_object_properties,
 )
-from utilities.hypothesis import sentinels
-from utilities.sentinel import Sentinel, sentinel
+from utilities.sentinel import sentinel
 from utilities.whenever import NOW_UTC, ZERO_TIME, get_now, get_today
 
 if TYPE_CHECKING:
@@ -917,16 +915,6 @@ class TestSecond:
         assert second(pair) == y
 
 
-class TestToBool:
-    @given(bool_=booleans() | none() | sentinels())
-    def test_bool_none_or_sentinel(self, *, bool_: bool | None | Sentinel) -> None:
-        assert to_bool(bool_=bool_) is bool_
-
-    @given(bool_=booleans())
-    def test_callable(self, *, bool_: bool) -> None:
-        assert to_bool(bool_=lambda: bool_) is bool_
-
-
 class TestYieldObjectAttributes:
     @given(n=integers())
     def test_main(self, *, n: int) -> None:

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_logging.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from asyncio import sleep
 from io import StringIO
-from logging import Formatter, Logger, StreamHandler, getLogger
+from logging import Formatter, StreamHandler, getLogger
 from pathlib import Path
 from re import search
 from typing import TYPE_CHECKING, Any, cast
@@ -32,9 +32,9 @@ from utilities.logging import (
     filter_for_key,
     get_format_str,
     get_formatter,
-    get_logger,
     get_logging_level_number,
     setup_logging,
+    to_logger,
 )
 from utilities.text import unique_str
 from utilities.types import LogLevel
@@ -261,24 +261,6 @@ class TestGetFormatter:
         assert isinstance(formatter, Formatter)
 
 
-class TestGetLogger:
-    def test_logger(self) -> None:
-        logger = getLogger(unique_str())
-        result = get_logger(logger=logger)
-        assert result is logger
-
-    def test_str(self) -> None:
-        name = unique_str()
-        logger = getLogger(name)
-        assert isinstance(logger, Logger)
-        assert logger.name == name
-
-    def test_none(self) -> None:
-        result = get_logger()
-        assert isinstance(result, Logger)
-        assert result.name == "root"
-
-
 class TestGetLoggingLevelNumber:
     @mark.parametrize(
         ("level", "expected"),
@@ -576,3 +558,19 @@ class TestSizeAndTimeRotatingFileHandler:
         record = one(r for r in caplog.records if r.name == name)
         path.unlink()
         assert not handler._should_rollover(record)
+
+
+class TestToLogger:
+    def test_default(self) -> None:
+        assert to_logger().name == "root"
+
+    @given(name=text_ascii(min_size=1))
+    def test_logger(self, *, name: str) -> None:
+        assert to_logger(getLogger(name)).name == name
+
+    @given(name=text_ascii(min_size=1))
+    def test_str(self, *, name: str) -> None:
+        assert to_logger(name).name == name
+
+    def test_none(self) -> None:
+        assert to_logger(None).name == "root"

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_pathlib.py

@@ -11,7 +11,7 @@ from pytest import mark, param, raises
 
 from tests.conftest import SKIPIF_CI_AND_WINDOWS
 from utilities.dataclasses import replace_non_sentinel
-from utilities.hypothesis import git_repos, paths, temp_paths
+from utilities.hypothesis import git_repos, pairs, paths, temp_paths
 from utilities.pathlib import (
     GetPackageRootError,
     GetRepoRootError,
@@ -23,7 +23,6 @@ from utilities.pathlib import (
     ensure_suffix,
     expand_path,
     get_package_root,
-    get_path,
     get_repo_root,
     get_root,
     get_tail,
@@ -31,6 +30,7 @@ from utilities.pathlib import (
     list_dir,
     module_path,
     temp_cwd,
+    to_path,
 )
 from utilities.sentinel import Sentinel, sentinel
 from utilities.tempfile import TemporaryDirectory
@@ -77,42 +77,6 @@ class TestExpandPath:
         assert result == expected
 
 
-class TestGetPath:
-    @given(path=paths())
-    def test_path(self, *, path: Path) -> None:
-        assert get_path(path=path) == path
-
-    @given(path=paths())
-    def test_str(self, *, path: Path) -> None:
-        assert get_path(path=str(path)) == path
-
-    def test_none(self) -> None:
-        assert get_path(path=None) == Path.cwd()
-
-    def test_sentinel(self) -> None:
-        assert get_path(path=sentinel) is sentinel
-
-    @given(path1=paths(), path2=paths())
-    def test_replace_non_sentinel(self, *, path1: Path, path2: Path) -> None:
-        @dataclass(kw_only=True, slots=True)
-        class Example:
-            path: Path = field(default_factory=Path.cwd)
-
-            def replace(
-                self, *, path: MaybeCallablePathLike | Sentinel = sentinel
-            ) -> Self:
-                return replace_non_sentinel(self, path=get_path(path=path))
-
-        obj = Example(path=path1)
-        assert obj.path == path1
-        assert obj.replace().path == path1
-        assert obj.replace(path=path2).path == path2
-
-    @given(path=paths())
-    def test_callable(self, *, path: Path) -> None:
-        assert get_path(path=lambda: path) == path
-
-
 class TestGetPackageRoot:
     @given(tail=paths())
     @settings(
@@ -121,7 +85,7 @@ class TestGetPackageRoot:
     def test_dir(self, *, tmp_path: Path, tail: Path) -> None:
         tmp_path.joinpath("pyproject.toml").touch()
         path = tmp_path.joinpath(tail)
-        result = get_package_root(path=path)
+        result = get_package_root(path)
         expected = tmp_path.resolve()
         assert result == expected
 
@@ -133,20 +97,20 @@ class TestGetPackageRoot:
         tmp_path.joinpath("pyproject.toml").touch()
         path = tmp_path.joinpath(tail)
         path.touch()
-        root = get_package_root(path=path)
+        root = get_package_root(path)
         expected = tmp_path.resolve()
         assert root == expected
 
     def test_error(self, *, tmp_path: Path) -> None:
         with raises(GetPackageRootError, match="Path is not part of a package: .*"):
-            _ = get_package_root(path=tmp_path)
+            _ = get_package_root(tmp_path)
 
 
 class TestGetRepoRoot:
     @given(repo=git_repos(), tail=paths())
     @settings(max_examples=1)
     def test_dir(self, *, repo: Path, tail: Path) -> None:
-        root = get_repo_root(path=repo.joinpath(tail))
+        root = get_repo_root(repo.joinpath(tail))
         expected = repo.resolve()
         assert root == expected
 
@@ -155,7 +119,7 @@ class TestGetRepoRoot:
     def test_file(self, *, repo: Path, tail: Path) -> None:
         path = repo.joinpath(tail)
         path.touch()
-        root = get_repo_root(path=path)
+        root = get_repo_root(path)
         expected = repo.resolve()
         assert root == expected
 
@@ -163,14 +127,14 @@ class TestGetRepoRoot:
         with raises(
             GetRepoRootError, match="Path is not part of a `git` repository: .*"
         ):
-            _ = get_repo_root(path=tmp_path)
+            _ = get_repo_root(tmp_path)
 
 
 class TestGetRoot:
     @given(repo=git_repos(), tail=paths())
     @settings(max_examples=1)
     def test_repo_only(self, *, repo: Path, tail: Path) -> None:
-        root = get_root(path=repo.joinpath(tail))
+        root = get_root(repo.joinpath(tail))
         expected = repo.resolve()
         assert root == expected
 
@@ -181,7 +145,7 @@ class TestGetRoot:
     def test_package_only(self, *, tmp_path: Path, tail: Path) -> None:
         tmp_path.joinpath("pyproject.toml").touch()
         path = tmp_path.joinpath(tail)
-        result = get_root(path=path)
+        result = get_root(path)
         expected = tmp_path.resolve()
         assert result == expected
 
@@ -192,7 +156,7 @@ class TestGetRoot:
     def test_repo_and_package(self, *, repo: Path, tail: Path) -> None:
         repo.joinpath("pyproject.toml").touch()
         path = repo.joinpath(tail)
-        root = get_root(path=path)
+        root = get_root(path)
         expected = repo.resolve()
         assert root == expected
 
@@ -204,7 +168,7 @@ class TestGetRoot:
         path = repo.joinpath(tail)
         path.mkdir(parents=True)
         path.joinpath("pyproject.toml").touch()
-        root = get_root(path=path)
+        root = get_root(path)
         expected = path.resolve()
         assert root == expected
 
@@ -217,13 +181,13 @@ class TestGetRoot:
             temp.joinpath("pyproject.toml").touch()
             path = temp.joinpath(tail)
             _ = copytree(repo, path)
-            root = get_root(path=path)
+            root = get_root(path)
             expected = path.resolve()
             assert root == expected
 
     def test_error(self, *, tmp_path: Path) -> None:
         with raises(GetRootError, match="Unable to determine root from '.*'"):
-            _ = get_root(path=tmp_path)
+            _ = get_root(tmp_path)
 
 
 class TestGetTail:
@@ -317,3 +281,44 @@ class TestTempCWD:
         with temp_cwd(tmp_path):
             assert Path.cwd() == tmp_path
         assert Path.cwd() != tmp_path
+
+
+class TestToPath:
+    def test_default(self) -> None:
+        assert to_path() == Path.cwd()
+
+    @given(path=paths())
+    def test_path(self, *, path: Path) -> None:
+        assert to_path(path) == path
+
+    @given(path=paths())
+    def test_str(self, *, path: Path) -> None:
+        assert to_path(str(path)) == path
+
+    @given(path=paths())
+    def test_callable(self, *, path: Path) -> None:
+        assert to_path(lambda: path) == path
+
+    def test_none(self) -> None:
+        assert to_path(None) == Path.cwd()
+
+    def test_sentinel(self) -> None:
+        assert to_path(sentinel) is sentinel
+
+    @given(paths=pairs(paths()))
+    def test_replace_non_sentinel(self, *, paths: tuple[Path, Path]) -> None:
+        path1, path2 = paths
+
+        @dataclass(kw_only=True, slots=True)
+        class Example:
+            path: Path = field(default_factory=Path.cwd)
+
+            def replace(
+                self, *, path: MaybeCallablePathLike | Sentinel = sentinel
+            ) -> Self:
+                return replace_non_sentinel(self, path=to_path(path))
+
+        obj = Example(path=path1)
+        assert obj.path == path1
+        assert obj.replace().path == path1
+        assert obj.replace(path=path2).path == path2

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_polars.py

@@ -1115,7 +1115,7 @@ class TestDataClassToSchema:
     @given(time_zone=timezones())
     def test_date_or_datetime_as_zoned_datetime(self, *, time_zone: ZoneInfo) -> None:
         with assume_does_not_raise(TimeZoneNotFoundError):
-            now = get_now(time_zone=time_zone).py_datetime()
+            now = get_now(time_zone).py_datetime()
 
         @dataclass(kw_only=True, slots=True)
         class Example:
@@ -1247,7 +1247,7 @@ class TestDataClassToSchema:
     @given(time_zone=timezones())
     def test_zoned_datetime(self, *, time_zone: ZoneInfo) -> None:
         with assume_does_not_raise(TimeZoneNotFoundError):
-            now = get_now(time_zone=time_zone).py_datetime()
+            now = get_now(time_zone).py_datetime()
 
         @dataclass(kw_only=True, slots=True)
         class Example:
@@ -1261,8 +1261,8 @@ class TestDataClassToSchema:
     @given(start=timezones(), end=timezones())
     def test_zoned_datetime_nested(self, *, start: ZoneInfo, end: ZoneInfo) -> None:
         with assume_does_not_raise(TimeZoneNotFoundError):
-            now_start = get_now(time_zone=start).py_datetime()
-            now_end = get_now(time_zone=end).py_datetime()
+            now_start = get_now(start).py_datetime()
+            now_end = get_now(end).py_datetime()
 
         @dataclass(kw_only=True, slots=True)
         class Inner:
@@ -1410,7 +1410,7 @@ class TestFiniteEWMMean:
     )
     def test_main(self, *, case: tuple[float, float, list[float], list[float]]) -> None:
         alpha, min_weight, exp_base, exp_result = case
-        state = get_state(seed=0)
+        state = get_state(0)
         series = Series(values=[state.randint(-10, 10) for _ in range(100)])
         base = series.ewm_mean(alpha=alpha)
         exp_base_sr = Series(values=exp_base, dtype=Float64)

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_pottery.py

@@ -23,7 +23,7 @@ if TYPE_CHECKING:
     from redis.asyncio import Redis
     from whenever import TimeDelta
 
-    from utilities.types import LoggerOrName
+    from utilities.types import LoggerLike
 
 
 class TestExtendLock:
@@ -79,7 +79,7 @@ class TestTryYieldCoroutineLooper:
         lst: list[None],
         /,
         *,
-        logger: LoggerOrName | None = None,
+        logger: LoggerLike | None = None,
         context: ContextVar[bool] | None = None,
     ) -> None:
         async with try_yield_coroutine_looper(
@@ -95,7 +95,7 @@ class TestTryYieldCoroutineLooper:
         lst: list[None],
         /,
         *,
-        logger: LoggerOrName | None = None,
+        logger: LoggerLike | None = None,
         context: ContextVar[bool] | None = None,
     ) -> None:
         await sleep_td(self.delta)

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_pyinstrument.py

@@ -12,7 +12,7 @@ if TYPE_CHECKING:
 
 class TestProfile:
     def test_main(self, tmp_path: Path) -> None:
-        with profile(path=tmp_path):
+        with profile(tmp_path):
             sleep(1e-3)
 
         (file,) = tmp_path.iterdir()

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_random.py

@@ -36,7 +36,7 @@ class TestGetDockerName:
 class TestGetState:
     @given(seed=integers() | just(SYSTEM_RANDOM))
     def test_main(self, *, seed: int | SystemRandom) -> None:
-        state = get_state(seed=seed)
+        state = get_state(seed)
         assert isinstance(state, Random)
 
 

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

@@ -17,7 +17,7 @@ from hypothesis.strategies import (
 )
 from pytest import mark, param, raises
 
-from utilities.hypothesis import text_ascii
+from utilities.hypothesis import sentinels, text_ascii
 from utilities.text import (
     ParseBoolError,
     ParseNoneError,
@@ -37,12 +37,15 @@ from utilities.text import (
     split_str,
     str_encode,
     strip_and_dedent,
+    to_bool,
     unique_str,
 )
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
+    from utilities.sentinel import Sentinel
+
 
 class TestParseBool:
     @given(data=data(), value=booleans())
@@ -323,6 +326,20 @@ class TestStripAndDedent:
         assert result == expected
 
 
+class TestToBool:
+    @given(bool_=booleans() | none() | sentinels())
+    def test_bool_none_or_sentinel(self, *, bool_: bool | None | Sentinel) -> None:
+        assert to_bool(bool_) is bool_
+
+    @given(bool_=booleans())
+    def test_str(self, *, bool_: bool) -> None:
+        assert to_bool(str(bool_)) is bool_
+
+    @given(bool_=booleans())
+    def test_callable(self, *, bool_: bool) -> None:
+        assert to_bool(lambda: bool_) is bool_
+
+
 class TestUniqueStrs:
     def test_main(self) -> None:
         first, second = [unique_str() for _ in range(2)]

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_traceback.py

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING
 
 from hypothesis import given
 from hypothesis.strategies import sampled_from
-from pytest import CaptureFixture, mark, param, raises
+from pytest import CaptureFixture, raises
 
 from utilities.iterables import one
 from utilities.traceback import (
@@ -18,13 +18,10 @@ from utilities.traceback import (
     make_except_hook,
 )
 from utilities.tzlocal import LOCAL_TIME_ZONE_NAME
-from utilities.whenever import get_now
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
 
-    from utilities.types import MaybeCallableZonedDateTime
-
 
 class TestFormatExceptionStack:
     @classmethod
@@ -45,14 +42,11 @@ class TestFormatExceptionStack:
             result = format_exception_stack(error).splitlines()
             self._assert_lines(result)
 
-    @mark.parametrize("start", [param(get_now), param(None)])
-    def test_header(self, *, start: MaybeCallableZonedDateTime) -> None:
+    def test_header(self) -> None:
         try:
             _ = self.func(1, 2, 3, 4, c=5, d=6, e=7)
         except AssertionError as error:
-            result = format_exception_stack(
-                error, header=True, start=start
-            ).splitlines()
+            result = format_exception_stack(error, header=True).splitlines()
             patterns = [
                 rf"^Date/time  \| \d{{8}}T\d{{6}}\[{LOCAL_TIME_ZONE_NAME}\]$",
                 rf"^Started    \| (\d{{8}}T\d{{6}}\[{LOCAL_TIME_ZONE_NAME}\]|)$",

dycw_utilities-0.153.0/src/tests/test_uuid.py

@@ -0,0 +1,89 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from re import search
+from typing import TYPE_CHECKING, Self
+from uuid import UUID
+
+from hypothesis import given
+from hypothesis.strategies import integers, none, randoms, uuids
+
+from utilities.dataclasses import replace_non_sentinel
+from utilities.hypothesis import pairs
+from utilities.sentinel import Sentinel, sentinel
+from utilities.uuid import UUID_EXACT_PATTERN, UUID_PATTERN, get_uuid, to_uuid
+
+if TYPE_CHECKING:
+    from random import Random
+
+    from utilities.sentinel import Sentinel
+    from utilities.types import MaybeCallableUUIDLike
+
+
+class TestGetUUID:
+    @given(seed=randoms() | none())
+    def test_main(self, *, seed: Random | None) -> None:
+        assert isinstance(get_uuid(seed), UUID)
+
+    @given(seed=integers())
+    def test_deterministic(self, *, seed: int) -> None:
+        uuid1, uuid2 = [get_uuid(seed) for _ in range(2)]
+        assert uuid1 == uuid2
+
+
+class TestToUUID:
+    def test_default(self) -> None:
+        assert isinstance(to_uuid(), UUID)
+
+    @given(uuid=uuids())
+    def test_uuid(self, *, uuid: UUID) -> None:
+        assert to_uuid(uuid) == uuid
+
+    @given(uuid=uuids())
+    def test_str(self, *, uuid: UUID) -> None:
+        assert to_uuid(str(uuid)) == uuid
+
+    @given(seed=randoms())
+    def test_seed(self, *, seed: Random) -> None:
+        assert isinstance(to_uuid(seed), UUID)
+
+    @given(uuid=uuids())
+    def test_callable(self, *, uuid: UUID) -> None:
+        assert to_uuid(lambda: uuid) == uuid
+
+    def test_none(self) -> None:
+        assert isinstance(to_uuid(None), UUID)
+
+    def test_sentinel(self) -> None:
+        assert to_uuid(sentinel) is sentinel
+
+    @given(uuids=pairs(uuids()))
+    def test_replace_non_sentinel(self, *, uuids: tuple[UUID, UUID]) -> None:
+        uuid1, uuid2 = uuids
+
+        @dataclass(kw_only=True, slots=True)
+        class Example:
+            uuid: UUID = field(default_factory=get_uuid)
+
+            def replace(
+                self, *, uuid: MaybeCallableUUIDLike | Sentinel = sentinel
+            ) -> Self:
+                return replace_non_sentinel(self, uuid=to_uuid(uuid))
+
+        obj = Example(uuid=uuid1)
+        assert obj.uuid == uuid1
+        assert obj.replace().uuid == uuid1
+        assert obj.replace(uuid=uuid2).uuid == uuid2
+        assert isinstance(obj.replace(uuid=get_uuid).uuid, UUID)
+
+
+class TestUUIDPattern:
+    @given(uuid=uuids())
+    def test_main(self, *, uuid: UUID) -> None:
+        assert search(UUID_PATTERN, str(uuid))
+
+    @given(uuid=uuids())
+    def test_exact(self, *, uuid: UUID) -> None:
+        text = f".{uuid}."
+        assert search(UUID_PATTERN, text)
+        assert not search(UUID_EXACT_PATTERN, text)

{dycw_utilities-0.152.0 → dycw_utilities-0.153.0}/src/tests/test_version.py

@@ -16,32 +16,14 @@ from utilities.version import (
     _VersionNegativeMinorVersionError,
     _VersionNegativePatchVersionError,
     _VersionZeroError,
-    get_version,
     parse_version,
+    to_version,
 )
 
 if TYPE_CHECKING:
     from utilities.sentinel import Sentinel
 
 
-class TestGetVersion:
-    @given(version=versions())
-    def test_version(self, *, version: Version) -> None:
-        assert get_version(version=version) == version
-
-    @given(version=versions())
-    def test_str(self, *, version: Version) -> None:
-        assert get_version(version=str(version)) == version
-
-    @given(version=none() | sentinels())
-    def test_none_or_sentinel(self, *, version: None | Sentinel) -> None:
-        assert get_version(version=version) is version
-
-    @given(version=versions())
-    def test_callable(self, *, version: Version) -> None:
-        assert get_version(version=lambda: version) == version
-
-
 class TestParseVersion:
     @given(version=versions())
     def test_main(self, *, version: Version) -> None:
@@ -140,3 +122,21 @@ class TestVersion:
     def test_error_empty_suffix(self) -> None:
         with raises(_VersionEmptySuffixError, match="Suffix must be non-empty; got .*"):
             _ = Version(suffix="")
+
+
+class TestGetVersion:
+    @given(version=versions())
+    def test_version(self, *, version: Version) -> None:
+        assert to_version(version) == version
+
+    @given(version=versions())
+    def test_str(self, *, version: Version) -> None:
+        assert to_version(str(version)) == version
+
+    @given(version=none() | sentinels())
+    def test_none_or_sentinel(self, *, version: None | Sentinel) -> None:
+        assert to_version(version) is version
+
+    @given(version=versions())
+    def test_callable(self, *, version: Version) -> None:
+        assert to_version(lambda: version) == version