dycw-utilities 0.166.6__tar.gz → 0.166.7__tar.gz

{dycw_utilities-0.166.6 → dycw_utilities-0.166.7}/PKG-INFO

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

{dycw_utilities-0.166.6 → dycw_utilities-0.166.7}/pyproject.toml

@@ -61,6 +61,9 @@ fastapi-test = [
 fpdf2 = [
   "fpdf2 >=2.8.3, <2.9",
 ]
+gitpython = [
+  "gitpython >=3.1.45, <3.2",
+]
 hashlib-test = [
   "orjson",
 ]
@@ -233,7 +236,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.166.6"
+version = "0.166.7"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -266,7 +269,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.166.6"
+current_version = "0.166.7"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.166.7/src/tests/test_git.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from hypothesis import given, settings
+
+from utilities.git import get_repo
+from utilities.hypothesis import git_repos, paths
+
+
+class TestGetRepo:
+    @given(repo=git_repos(), tail=paths())
+    @settings(max_examples=1)
+    def test_main(self, *, repo: Path, tail: Path) -> None:
+        obj = get_repo(repo.joinpath(tail))
+        expected = repo.resolve()
+        assert obj.working_tree_dir is not None
+        root = Path(obj.working_tree_dir).resolve()
+        assert root == expected

{dycw_utilities-0.166.6 → dycw_utilities-0.166.7}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.166.6"
+__version__ = "0.166.7"

dycw_utilities-0.166.7/src/utilities/git.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from git import Repo
+
+from utilities.pathlib import to_path
+
+if TYPE_CHECKING:
+    from utilities.types import MaybeCallablePathLike
+
+
+def get_repo(path: MaybeCallablePathLike = Path.cwd, /) -> Repo:
+    """Get the repo object."""
+    return Repo(to_path(path), search_parent_directories=True)
+
+
+__all__ = ["get_repo"]