dycw-utilities 0.138.8__py3-none-any.whl → 0.138.9__py3-none-any.whl

{dycw_utilities-0.138.8.dist-info → dycw_utilities-0.138.9.dist-info}/METADATA

@@ -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.dist-info → dycw_utilities-0.138.9.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=PNZtdWOozZol0q-8PP5HDXblyuTImCmKVhJDZ6aPzOM,60
+utilities/__init__.py,sha256=ANddrXgdSTBQjO5buynEzt5zVNH6F2WJFjL8c1YlyV8,60
 utilities/aiolimiter.py,sha256=mD0wEiqMgwpty4XTbawFpnkkmJS6R4JRsVXFUaoitSU,628
 utilities/altair.py,sha256=HeZBVUocjkrTNwwKrClppsIqgNFF-ykv05HfZSoHYno,9104
 utilities/asyncio.py,sha256=dcGeKQzjLBXxKzZkVIk5oZsFXEcynVbRB9iNB5XEDZk,38526
@@ -42,7 +42,7 @@ utilities/optuna.py,sha256=C-fhWYiXHVPo1l8QctYkFJ4DyhbSrGorzP1dJb_qvd8,1933
 utilities/orjson.py,sha256=WWV2QukCIuwT8OAOtmKhLhxezXPVbeA_fQCucmGmbRA,37106
 utilities/os.py,sha256=yMNAKMyY8oFgQ1yN3TQYnwa5-A_FXz4tCDbhIctQHSs,3736
 utilities/parse.py,sha256=JcJn5yXKhIWXBCwgBdPsyu7Hvcuw6kyEdqvaebCaI9k,17951
-utilities/pathlib.py,sha256=NT0EzXBzkVMByO1GZdZYN1wLt0_pikAV7rLBtgLKF-Y,7291
+utilities/pathlib.py,sha256=5p9MI8m7iUFksNVGiLavN4MZ3cj1CpBiLBlgaCR0LCs,8334
 utilities/period.py,sha256=6jEff_qAiE7xdFaQ1DnKgNf10D2wHhzt7hQXCBoKlgc,6842
 utilities/pickle.py,sha256=MBT2xZCsv0pH868IXLGKnlcqNx2IRVKYNpRcqiQQqxw,653
 utilities/platform.py,sha256=5uCKRf_ij7ukJDcbnNfhY2ay9fbrpiNLRO1t2QvcwqQ,2825
@@ -88,8 +88,8 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 utilities/whenever.py,sha256=R5d9UCNCdAOyjwLUmfH2Vn8Ykee8OHQi2skRTFfbZMM,20492
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=oEH-nL3t4h9uawyZqWDtNtDAl6M-CLpLYGI_nI6DulM,1971
-dycw_utilities-0.138.8.dist-info/METADATA,sha256=MVaYliyhueRarnK_LZuye5BRShl7DtclUDjY6wyVfdU,1638
-dycw_utilities-0.138.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.138.8.dist-info/entry_points.txt,sha256=uLj5QWWVXv8tnMaRX3ZGYpt7w1xzLWU6LxbFhELEpkc,68
-dycw_utilities-0.138.8.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.138.8.dist-info/RECORD,,
+dycw_utilities-0.138.9.dist-info/METADATA,sha256=og-7pWHDQmHofzZTBE5WqHkkBAcqtjf6rxaKb8gKz-c,1638
+dycw_utilities-0.138.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.138.9.dist-info/entry_points.txt,sha256=uLj5QWWVXv8tnMaRX3ZGYpt7w1xzLWU6LxbFhELEpkc,68
+dycw_utilities-0.138.9.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.138.9.dist-info/RECORD,,

utilities/__init__.py

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

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",