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

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

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

{dycw_utilities-0.138.8 → 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.8"
+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.8"
+current_version = "0.138.9"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.138.8 → 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,7 +22,9 @@ from utilities.pathlib import (
     _GetTailNonUniqueError,
     ensure_suffix,
     expand_path,
+    get_package_root,
     get_path,
+    get_repo_root,
     get_root,
     get_tail,
     is_sub_path,
@@ -106,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
+
+    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(data=data())
+    @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()

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

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

{dycw_utilities-0.138.8 → 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)
@@ -259,10 +302,14 @@ 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",