dycw-utilities 0.138.7__tar.gz → 0.138.9__tar.gz

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/PKG-INFO

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

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/pyproject.toml

@@ -106,7 +106,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.138.7"
+version = "0.138.9"
 
 [project.entry-points.pytest11]
 pytest-regressions = "utilities.pytest_regressions_plugin"
@@ -137,7 +137,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.138.7"
+current_version = "0.138.9"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/tests/test_pathlib.py

@@ -6,13 +6,15 @@ from shutil import copytree
 from typing import TYPE_CHECKING, Self
 
 from hypothesis import HealthCheck, given, settings
-from hypothesis.strategies import DataObject, data, integers, sets
+from hypothesis.strategies import integers, sets
 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.pathlib import (
+    GetPackageRootError,
+    GetRepoRootError,
     GetRootError,
     _GetTailDisambiguate,
     _GetTailEmptyError,
@@ -20,11 +22,14 @@ from utilities.pathlib import (
     _GetTailNonUniqueError,
     ensure_suffix,
     expand_path,
+    get_package_root,
     get_path,
+    get_repo_root,
     get_root,
     get_tail,
     is_sub_path,
     list_dir,
+    module_path,
     temp_cwd,
 )
 from utilities.sentinel import Sentinel, sentinel
@@ -105,71 +110,109 @@ class TestGetPath:
         assert get_path(path=lambda: path) == path
 
 
-class TestGetRoot:
-    @given(data=data(), repo=git_repos())
+class TestGetPackageRoot:
+    @given(tail=paths())
     @settings(
         max_examples=1, suppress_health_check={HealthCheck.function_scoped_fixture}
     )
-    def test_git_dir(self, *, data: DataObject, repo: Path) -> None:
-        path = repo.joinpath(data.draw(paths()))
-        path.mkdir(parents=True, exist_ok=True)
-        root = get_root(path=path)
-        expected = repo.resolve()
-        assert root == expected
+    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)
+        expected = tmp_path.resolve()
+        assert result == expected
 
-    @given(data=data(), repo=git_repos())
+    @given(tail=paths(min_depth=1))
     @settings(
         max_examples=1, suppress_health_check={HealthCheck.function_scoped_fixture}
     )
-    def test_git_file(self, *, data: DataObject, repo: Path) -> None:
-        path = repo.joinpath(data.draw(paths(min_depth=1)))
+    def test_file(self, *, tmp_path: Path, tail: Path) -> None:
+        tmp_path.joinpath("pyproject.toml").touch()
+        path = tmp_path.joinpath(tail)
         path.touch()
-        root = get_root(path=path)
+        root = get_package_root(path=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)
+
+
+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))
+        expected = repo.resolve()
+        assert root == expected
+
+    @given(repo=git_repos(), tail=paths(min_depth=1))
+    @settings(max_examples=1)
+    def test_file(self, *, repo: Path, tail: Path) -> None:
+        path = repo.joinpath(tail)
+        path.touch()
+        root = get_repo_root(path=path)
         expected = repo.resolve()
         assert root == expected
 
-    @given(data=data())
+    def test_error(self, *, tmp_path: Path) -> None:
+        with raises(
+            GetRepoRootError, match="Path is not part of a `git` repository: .*"
+        ):
+            _ = get_repo_root(path=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))
+        expected = repo.resolve()
+        assert root == expected
+
+    @given(tail=paths())
     @settings(
         max_examples=1, suppress_health_check={HealthCheck.function_scoped_fixture}
     )
-    def test_envrc(self, *, data: DataObject, tmp_path: Path) -> None:
-        tmp_path.joinpath(".envrc").touch()
-        path = tmp_path.joinpath(data.draw(paths()))
+    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)
         expected = tmp_path.resolve()
         assert result == expected
 
-    @given(data=data(), repo=git_repos())
+    @given(repo=git_repos(), tail=paths())
     @settings(
         max_examples=1, suppress_health_check={HealthCheck.function_scoped_fixture}
     )
-    def test_git_and_envrc(self, *, data: DataObject, repo: Path) -> None:
-        repo.joinpath(".envrc").touch()
-        path = repo.joinpath(data.draw(paths()))
+    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)
         expected = repo.resolve()
         assert root == expected
 
-    @given(data=data(), repo=git_repos())
+    @given(repo=git_repos(), tail=paths(min_depth=1))
     @settings(
         max_examples=1, suppress_health_check={HealthCheck.function_scoped_fixture}
     )
-    def test_git_with_envrc_inside(self, *, data: DataObject, repo: Path) -> None:
-        path = repo.joinpath(data.draw(paths(min_depth=1)))
+    def test_repo_with_package_inside(self, *, repo: Path, tail: Path) -> None:
+        path = repo.joinpath(tail)
         path.mkdir(parents=True)
-        path.joinpath(".envrc").touch()
+        path.joinpath("pyproject.toml").touch()
         root = get_root(path=path)
         expected = path.resolve()
         assert root == expected
 
-    @given(data=data(), repo=git_repos())
+    @given(repo=git_repos(), tail=paths(min_depth=1))
     @settings(
         max_examples=1, suppress_health_check={HealthCheck.function_scoped_fixture}
     )
-    def test_envrc_with_git_inside(self, *, data: DataObject, repo: Path) -> None:
+    def test_package_with_repo_inside(self, *, repo: Path, tail: Path) -> None:
         with TemporaryDirectory() as temp:
-            temp.joinpath(".envrc").touch()
-            path = temp.joinpath(data.draw(paths(min_depth=1)))
+            temp.joinpath("pyproject.toml").touch()
+            path = temp.joinpath(tail)
             _ = copytree(repo, path)
             root = get_root(path=path)
             expected = path.resolve()
@@ -255,6 +298,16 @@ class TestListDir:
         assert result == expected
 
 
+class TestModulePath:
+    @mark.parametrize(
+        ("root", "expected"),
+        [param(None, "foo.bar.baz"), param("foo", "bar.baz"), param("foo/bar", "baz")],
+    )
+    def test_main(self, *, root: PathLike | None, expected: Path) -> None:
+        module = module_path("foo/bar/baz.py", root=root)
+        assert module == expected
+
+
 class TestTempCWD:
     def test_main(self, *, tmp_path: Path) -> None:
         assert Path.cwd() != tmp_path

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/tests/test_pytest.py

@@ -12,7 +12,7 @@ from utilities.iterables import one
 from utilities.pytest import (
     NodeIdToPathError,
     is_pytest,
-    node_id_to_path,
+    node_id_path,
     random_state,
     throttle,
 )
@@ -31,46 +31,53 @@ class TestIsPytest:
         assert is_pytest()
 
 
-class TestNodeIdToPath:
+class TestNodeIdPath:
     @mark.parametrize(
         ("node_id", "expected"),
         [
             param(
                 "src/tests/module/test_funcs.py::TestClass::test_main",
-                Path("src.tests.module.test_funcs", "TestClass__test_main"),
+                Path("src.tests.module.test_funcs/TestClass__test_main"),
             ),
             param(
                 "src/tests/module/test_funcs.py::TestClass::test_main[param1, param2]",
                 Path(
-                    "src.tests.module.test_funcs",
-                    "TestClass__test_main[param1, param2]",
+                    "src.tests.module.test_funcs/TestClass__test_main[param1, param2]"
                 ),
             ),
             param(
                 "src/tests/module/test_funcs.py::TestClass::test_main[EUR.USD]",
-                Path("src.tests.module.test_funcs", "TestClass__test_main[EUR.USD]"),
+                Path("src.tests.module.test_funcs/TestClass__test_main[EUR.USD]"),
             ),
         ],
     )
     def test_main(self, *, node_id: str, expected: Path) -> None:
-        result = node_id_to_path(node_id)
+        result = node_id_path(node_id)
         assert result == expected
 
-    def test_head(self) -> None:
-        node_id = "src/tests/module/test_funcs.py::TestClass::test_main"
-        result = node_id_to_path(node_id, head="src/tests")
-        expected = Path("module.test_funcs", "TestClass__test_main")
+    @mark.parametrize(
+        "node_id",
+        [
+            param("src/tests/module/test_funcs.py::TestClass::test_main"),
+            param(
+                "python/package/src/tests/module/test_funcs.py::TestClass::test_main"
+            ),
+        ],
+    )
+    def test_root(self, *, node_id: str) -> None:
+        result = node_id_path(node_id, root="src/tests")
+        expected = Path("module.test_funcs/TestClass__test_main")
         assert result == expected
 
     def test_suffix(self) -> None:
         node_id = "src/tests/module/test_funcs.py::TestClass::test_main"
-        result = node_id_to_path(node_id, head="src/tests", suffix=".sv")
-        expected = Path("module.test_funcs", "TestClass__test_main.sv")
+        result = node_id_path(node_id, root="src/tests", suffix=".csv")
+        expected = Path("module.test_funcs/TestClass__test_main.csv")
         assert result == expected
 
     def test_error_file_suffix(self) -> None:
         with raises(NodeIdToPathError, match="Node ID must be a Python file; got .*"):
-            _ = node_id_to_path("src/tests/module/test_funcs.csv::TestClass::test_main")
+            _ = node_id_path("src/tests/module/test_funcs.csv::TestClass::test_main")
 
 
 class TestPytestOptions:

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.138.7"
+__version__ = "0.138.9"

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/utilities/hypothesis.py

@@ -66,7 +66,7 @@ from utilities.math import (
     is_zero,
 )
 from utilities.os import get_env_var
-from utilities.pathlib import temp_cwd
+from utilities.pathlib import module_path, temp_cwd
 from utilities.platform import IS_WINDOWS
 from utilities.sentinel import Sentinel, sentinel
 from utilities.tempfile import TEMP_DIR, TemporaryDirectory
@@ -567,7 +567,7 @@ def import_froms(
             max_depth=max_depth_,
         )
     )
-    module = ".".join(path.parts)
+    module = module_path(path)
     name = draw(text_ascii(min_size=1))
     asname = draw(text_ascii(min_size=1) | none())
     return generate_import_from(module, name, asname=asname)
@@ -594,7 +594,7 @@ def imports(
             max_depth=max_depth_,
         )
     )
-    module = ".".join(path.parts)
+    module = module_path(path)
     asname = draw(text_ascii(min_size=1) | none())
     return generate_import(module, asname=asname)
 

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/utilities/pathlib.py

@@ -71,8 +71,35 @@ def get_path(
 ##
 
 
-def get_root(*, path: MaybeCallablePathLike | None = None) -> Path:
-    """Get the root of a path."""
+def get_package_root(*, path: MaybeCallablePathLike | None = None) -> Path:
+    """Get the package root."""
+    path = get_path(path=path)
+    path_dir = path.parent if path.is_file() else path
+    all_paths = list(chain([path_dir], path_dir.parents))
+    try:
+        return next(
+            p.resolve()
+            for p in all_paths
+            if any(p_i.name == "pyproject.toml" for p_i in p.iterdir())
+        )
+    except StopIteration:
+        raise GetPackageRootError(path=path) from None
+
+
+@dataclass(kw_only=True, slots=True)
+class GetPackageRootError(Exception):
+    path: PathLike
+
+    @override
+    def __str__(self) -> str:
+        return f"Path is not part of a package: {self.path}"
+
+
+##
+
+
+def get_repo_root(*, path: MaybeCallablePathLike | None = None) -> Path:
+    """Get the repo root."""
     path = get_path(path=path)
     path_dir = path.parent if path.is_file() else path
     try:
@@ -85,36 +112,52 @@ def get_root(*, path: MaybeCallablePathLike | None = None) -> Path:
     except CalledProcessError as error:
         # newer versions of git report "Not a git repository", whilst older
         # versions report "not a git repository"
-        if not search("fatal: not a git repository", error.stderr, flags=IGNORECASE):
-            raise  # pragma: no cover
-        root_git = None
+        if search("fatal: not a git repository", error.stderr, flags=IGNORECASE):
+            raise GetRepoRootError(path=path) from None
+        raise  # pragma: no cover
     else:
-        root_git = Path(output.strip("\n")).resolve()
-    all_paths = list(chain([path_dir], path_dir.parents))
+        return Path(output.strip("\n"))
+
+
+@dataclass(kw_only=True, slots=True)
+class GetRepoRootError(Exception):
+    path: PathLike
+
+    @override
+    def __str__(self) -> str:
+        return f"Path is not part of a `git` repository: {self.path}"
+
+
+##
+
+
+def get_root(*, path: MaybeCallablePathLike | None = None) -> Path:
+    """Get the root of a path."""
+    path = get_path(path=path)
     try:
-        root_envrc = next(
-            p.resolve()
-            for p in all_paths
-            if any(p_i.name == ".envrc" for p_i in p.iterdir())
-        )
-    except StopIteration:
-        root_envrc = None
-    match root_git, root_envrc:
+        repo = get_repo_root(path=path)
+    except GetRepoRootError:
+        repo = None
+    try:
+        package = get_package_root(path=path)
+    except GetPackageRootError:
+        package = None
+    match repo, package:
         case None, None:
             raise GetRootError(path=path)
         case Path(), None:
-            return root_git
+            return repo
         case None, Path():
-            return root_envrc
+            return package
         case Path(), Path():
-            if root_git == root_envrc:
-                return root_git
-            if is_sub_path(root_git, root_envrc, strict=True):
-                return root_git
-            if is_sub_path(root_envrc, root_git, strict=True):
-                return root_envrc
+            if repo == package:
+                return repo
+            if is_sub_path(repo, package, strict=True):
+                return repo
+            if is_sub_path(package, repo, strict=True):
+                return package
             raise ImpossibleCaseError(  # pragma: no cover
-                case=[f"{root_git=}", f"{root_envrc=}"]
+                case=[f"{repo=}", f"{package=}"]
             )
         case _ as never:
             assert_never(never)
@@ -211,6 +254,24 @@ class _GetTailNonUniqueError(GetTailError):
 ##
 
 
+def module_path(
+    path: PathLike,
+    /,
+    *,
+    root: PathLike | None = None,
+    disambiguate: _GetTailDisambiguate = "raise",
+) -> str:
+    """Return a module path."""
+    path = Path(path)
+    if root is not None:
+        path = get_tail(path, root, disambiguate=disambiguate)
+    parts = path.with_suffix("").parts
+    return ".".join(parts)
+
+
+##
+
+
 def is_sub_path(x: PathLike, y: PathLike, /, *, strict: bool = False) -> bool:
     """Check if a path is a sub path of another."""
     x, y = [Path(i).resolve() for i in [x, y]]
@@ -241,12 +302,17 @@ def temp_cwd(path: PathLike, /) -> Iterator[None]:
 
 __all__ = [
     "PWD",
+    "GetPackageRootError",
+    "GetRepoRootError",
     "GetTailError",
     "ensure_suffix",
     "expand_path",
+    "get_package_root",
     "get_path",
+    "get_repo_root",
     "get_tail",
     "is_sub_path",
     "list_dir",
+    "module_path",
     "temp_cwd",
 ]

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/utilities/pytest.py

@@ -13,7 +13,7 @@ from whenever import ZonedDateTime
 from utilities.atomicwrites import writer
 from utilities.functools import cache
 from utilities.hashlib import md5_hash
-from utilities.pathlib import ensure_suffix, get_root
+from utilities.pathlib import ensure_suffix, get_root, get_tail, module_path
 from utilities.platform import (
     IS_LINUX,
     IS_MAC,
@@ -123,18 +123,18 @@ def is_pytest() -> bool:
 ##
 
 
-def node_id_to_path(
-    node_id: str, /, *, head: PathLike | None = None, suffix: str | None = None
+def node_id_path(
+    node_id: str, /, *, root: PathLike | None = None, suffix: str | None = None
 ) -> Path:
-    """Map a node ID to a path."""
+    """Get the path of a node ID."""
     path_file, *parts = node_id.split("::")
     path_file = Path(path_file)
     if path_file.suffix != ".py":
         raise NodeIdToPathError(node_id=node_id)
     path = path_file.with_suffix("")
-    if head is not None:
-        path = path.relative_to(head)
-    path = Path(".".join(path.parts), "__".join(parts))
+    if root is not None:
+        path = get_tail(path, root)
+    path = Path(module_path(path), "__".join(parts))
     if suffix is not None:
         path = ensure_suffix(path, suffix)
     return path
@@ -267,7 +267,7 @@ __all__ = [
     "add_pytest_collection_modifyitems",
     "add_pytest_configure",
     "is_pytest",
-    "node_id_to_path",
+    "node_id_path",
     "random_state",
     "skipif_linux",
     "skipif_mac",

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/utilities/pytest_regressions_plugin.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, cast
 
 if TYPE_CHECKING:
     from pytest import FixtureRequest
@@ -41,11 +41,12 @@ else:
 
 def _get_path(request: FixtureRequest, /) -> Path:
     from utilities.pathlib import get_root
-    from utilities.pytest import node_id_to_path
+    from utilities.pytest import node_id_path
 
-    head = Path("src", "tests")
-    tail = node_id_to_path(request.node.nodeid, head=head)
-    return get_root().joinpath(head, "regressions", tail)
+    path = Path(cast("Any", request).fspath)
+    root = Path("src", "tests")
+    tail = node_id_path(request.node.nodeid, root=root)
+    return get_root(path=path).joinpath(root, "regressions", tail)
 
 
 __all__ = ["orjson_regression", "polars_regression"]

{dycw_utilities-0.138.7 → dycw_utilities-0.138.9}/src/utilities/traceback.py

@@ -16,7 +16,7 @@ from utilities.atomicwrites import writer
 from utilities.errors import repr_error
 from utilities.functions import to_bool
 from utilities.iterables import OneEmptyError, one
-from utilities.pathlib import get_path
+from utilities.pathlib import get_path, module_path
 from utilities.reprlib import (
     RICH_EXPAND_ALL,
     RICH_INDENT_SIZE,
@@ -181,7 +181,7 @@ def _path_to_dots(path: PathLike, /) -> str:
         if (new_path := _trim_path(path, pattern)) is not None:
             break
     path_use = Path(path) if new_path is None else new_path
-    return ".".join(path_use.with_suffix("").parts)
+    return module_path(path_use)
 
 
 def _trim_path(path: PathLike, pattern: str, /) -> Path | None: