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

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

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

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=Y_4wr1MFLRZ5ZwdjuZ0h_gSie-eMamrUJhqXhpN6Eo4,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
@@ -22,7 +22,7 @@ utilities/functools.py,sha256=I00ru2gQPakZw2SHVeKIKXfTv741655s6HI0lUoE0D4,1552
 utilities/getpass.py,sha256=DfN5UgMAtFCqS3dSfFHUfqIMZX2shXvwphOz_6J6f6A,103
 utilities/hashlib.py,sha256=SVTgtguur0P4elppvzOBbLEjVM3Pea0eWB61yg2ilxo,309
 utilities/http.py,sha256=WcahTcKYRtZ04WXQoWt5EGCgFPcyHD3EJdlMfxvDt-0,946
-utilities/hypothesis.py,sha256=2VJy9Pxqjy4_ldAwZAR6XEGuG2ZmAN1ycpA_VIGnKew,38819
+utilities/hypothesis.py,sha256=GLw1crgjrPUhCkIMgFkJKNYnixiQAAQ1XjzJBsabkWc,38826
 utilities/importlib.py,sha256=mV1xT_O_zt_GnZZ36tl3xOmMaN_3jErDWY54fX39F6Y,429
 utilities/inflect.py,sha256=DbqB5Q9FbRGJ1NbvEiZBirRMxCxgrz91zy5jCO9ZIs0,347
 utilities/ipython.py,sha256=V2oMYHvEKvlNBzxDXdLvKi48oUq2SclRg5xasjaXStw,763
@@ -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=1QTfoMze_RYX0wrbm9F9FSaZNfO8n1bSFD60-E1Vmc0,6912
+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
@@ -54,9 +54,9 @@ utilities/psutil.py,sha256=0j4YxtVb8VjaaKKiHg6UEK95SUPkEcENgPtLgPJsNv0,3760
 utilities/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 utilities/pydantic.py,sha256=CmxCi4sukeHM3JGjJ1Rbp8UAvcx4MZapLg10mFYJ-nk,1771
 utilities/pyinstrument.py,sha256=HrTGJ2niUAHUFMSN3im9BeedC0faq2DqoFccDxPpsP8,884
-utilities/pytest.py,sha256=f6Yl2vHimin2Ulg0aUsNhdWmf6dC1Hs6nDTFOCOpRJI,8029
+utilities/pytest.py,sha256=WkdZVu5yrh-7y4O4AHSx4t6nlzWxBRoQsYG-kbPJcg8,8043
 utilities/pytest_regressions.py,sha256=X5fN5MjRyTHWV_xe-K5a3f01I1FX0qcCMvtIQeQ93yE,4176
-utilities/pytest_regressions_plugin.py,sha256=kIuQx36EzamLmakQruZjd4ak9PUKcRnrnoBJvgYCiFo,1412
+utilities/pytest_regressions_plugin.py,sha256=Iwhfv_OJH7UCPZCfoh7ugZ2Xjqjil-BBBsOb8sDwiGI,1471
 utilities/python_dotenv.py,sha256=dYooRYwqrvhSoZWuiVbCiKUWiS-M5b5yv2zDWGYPEvI,3209
 utilities/random.py,sha256=YWYzWxQDeyJRiuHGnO1OxF6dDucpq7qc1tH_ealwCRg,4130
 utilities/re.py,sha256=6qxeV0rQZaBDKWcB7apSBmxtg_XzoGY-EdegTkMn-ZY,4578
@@ -76,7 +76,7 @@ utilities/tempfile.py,sha256=VqmZJAhTJ1OaVywFzk5eqROV8iJbW9XQ_QYAV0bpdRo,1384
 utilities/text.py,sha256=ymBFlP_cA8OgNnZRVNs7FAh7OG8HxE6YkiLEMZv5g_A,11297
 utilities/threading.py,sha256=GvBOp4CyhHfN90wGXZuA2VKe9fGzMaEa7oCl4f3nnPU,1009
 utilities/timer.py,sha256=oXfTii6ymu57niP0BDGZjFD55LEHi2a19kqZKiTgaFQ,2588
-utilities/traceback.py,sha256=h9yt4C2XkGHXW9e9bz93IGluhIR_Qil8zu5dhC8DXY0,8884
+utilities/traceback.py,sha256=YPD_MYNWc7k3vWF-YDWw4YUCZQyVR3ZLp6M1FAQR9Xw,8878
 utilities/typed_settings.py,sha256=C2i2VK62us_Z5jjca9NLmDFiT3_mkoSCwgU6FDtDhMI,4501
 utilities/types.py,sha256=-_pXQvmpJhTgEbI13N_zZWINdt0ODBpZ3WdJQUML9GA,17397
 utilities/typing.py,sha256=Z-_XDaWyT_6wIo3qfNK-hvRlzxP2Jxa9PgXzm5rDYRA,13790
@@ -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.7.dist-info/METADATA,sha256=6Xtr3iRQVgzBZqhlaQk5tw2c0Dnpt51AU2A86z1qdAE,1638
-dycw_utilities-0.138.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.138.7.dist-info/entry_points.txt,sha256=uLj5QWWVXv8tnMaRX3ZGYpt7w1xzLWU6LxbFhELEpkc,68
-dycw_utilities-0.138.7.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.138.7.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.7"
+__version__ = "0.138.9"

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)
 

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

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

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

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: