dycw-utilities 0.138.5__py3-none-any.whl → 0.138.6__py3-none-any.whl

{dycw_utilities-0.138.5.dist-info → dycw_utilities-0.138.6.dist-info}/METADATA

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

{dycw_utilities-0.138.5.dist-info → dycw_utilities-0.138.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=8_NgkEVVSVQiH0KSjlNRZwW_d9Lb2cnfj8c1HrNPmGA,60
+utilities/__init__.py,sha256=V7k67oxstsllNw_dt-tpMRsylqRrsJMOdAMNNakV9po,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=yE85i5nlXXdW9HFE2KzjmP2yyWhnZYQkMZ9TjQ8UQRk,4454
+utilities/pathlib.py,sha256=1QTfoMze_RYX0wrbm9F9FSaZNfO8n1bSFD60-E1Vmc0,6912
 utilities/period.py,sha256=6jEff_qAiE7xdFaQ1DnKgNf10D2wHhzt7hQXCBoKlgc,6842
 utilities/pickle.py,sha256=MBT2xZCsv0pH868IXLGKnlcqNx2IRVKYNpRcqiQQqxw,653
 utilities/platform.py,sha256=5uCKRf_ij7ukJDcbnNfhY2ay9fbrpiNLRO1t2QvcwqQ,2825
@@ -87,7 +87,7 @@ 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.5.dist-info/METADATA,sha256=49xR0EeDJd73mcxgxDir4zIZrsvAyW3Cb-iorojBolY,1638
-dycw_utilities-0.138.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.138.5.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.138.5.dist-info/RECORD,,
+dycw_utilities-0.138.6.dist-info/METADATA,sha256=EMQ0EEZfe_ywhxuelhNvMoXkahxUom89cJL4Hh40abU,1638
+dycw_utilities-0.138.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.138.6.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.138.6.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.138.5"
+__version__ = "0.138.6"

utilities/pathlib.py

@@ -9,7 +9,7 @@ from os.path import expandvars
 from pathlib import Path
 from re import IGNORECASE, search
 from subprocess import PIPE, CalledProcessError, check_output
-from typing import TYPE_CHECKING, assert_never, overload, override
+from typing import TYPE_CHECKING, Literal, assert_never, overload, override
 
 from utilities.errors import ImpossibleCaseError
 from utilities.sentinel import Sentinel, sentinel
@@ -132,6 +132,85 @@ class GetRootError(Exception):
 ##
 
 
+type _GetTailDisambiguate = Literal["raise", "earlier", "later"]
+
+
+def get_tail(
+    path: PathLike, root: PathLike, /, *, disambiguate: _GetTailDisambiguate = "raise"
+) -> Path:
+    """Get the tail of a path following a root match."""
+    path_parts, root_parts = [Path(p).parts for p in [path, root]]
+    len_path, len_root = map(len, [path_parts, root_parts])
+    if len_root > len_path:
+        raise _GetTailLengthError(path=path, root=root, len_root=len_root)
+    candidates = {
+        i + len_root: path_parts[i : i + len_root]
+        for i in range(len_path + 1 - len_root)
+    }
+    matches = {k: v for k, v in candidates.items() if v == root_parts}
+    match len(matches), disambiguate:
+        case 0, _:
+            raise _GetTailEmptyError(path=path, root=root)
+        case 1, _:
+            return _get_tail_core(path, next(iter(matches)))
+        case _, "raise":
+            first, second, *_ = matches
+            raise _GetTailNonUniqueError(
+                path=path,
+                root=root,
+                first=_get_tail_core(path, first),
+                second=_get_tail_core(path, second),
+            )
+        case _, "earlier":
+            return _get_tail_core(path, next(iter(matches)))
+        case _, "later":
+            return _get_tail_core(path, next(iter(reversed(matches))))
+        case _ as never:
+            assert_never(never)
+
+
+def _get_tail_core(path: PathLike, i: int, /) -> Path:
+    parts = Path(path).parts
+    return Path(*parts[i:])
+
+
+@dataclass(kw_only=True, slots=True)
+class GetTailError(Exception):
+    path: PathLike
+    root: PathLike
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetTailLengthError(GetTailError):
+    len_root: int
+
+    @override
+    def __str__(self) -> str:
+        return f"Unable to get the tail of {str(self.path)!r} with root of length {self.len_root}"
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetTailEmptyError(GetTailError):
+    @override
+    def __str__(self) -> str:
+        return (
+            f"Unable to get the tail of {str(self.path)!r} with root {str(self.root)!r}"
+        )
+
+
+@dataclass(kw_only=True, slots=True)
+class _GetTailNonUniqueError(GetTailError):
+    first: Path
+    second: Path
+
+    @override
+    def __str__(self) -> str:
+        return f"Path {str(self.path)!r} must contain exactly one tail with root {str(self.root)!r}; got {str(self.first)!r}, {str(self.second)!r} and perhaps more"
+
+
+##
+
+
 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]]
@@ -162,9 +241,11 @@ def temp_cwd(path: PathLike, /) -> Iterator[None]:
 
 __all__ = [
     "PWD",
+    "GetTailError",
     "ensure_suffix",
     "expand_path",
     "get_path",
+    "get_tail",
     "is_sub_path",
     "list_dir",
     "temp_cwd",