dycw-utilities 0.129.9__tar.gz → 0.129.11__tar.gz

{dycw_utilities-0.129.9 → dycw_utilities-0.129.11}/PKG-INFO

@@ -1,10 +1,15 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.129.9
+Version: 0.129.11
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12
 Requires-Dist: typing-extensions<4.15,>=4.14.0
+Provides-Extra: logging
+Requires-Dist: atomicwrites<1.5,>=1.4.1; extra == 'logging'
+Requires-Dist: coloredlogs<15.1,>=15.0.1; extra == 'logging'
+Requires-Dist: tzlocal<5.4,>=5.3.1; extra == 'logging'
+Requires-Dist: whenever<0.9,>=0.8.4; extra == 'logging'
 Provides-Extra: test
 Requires-Dist: dycw-pytest-only<2.2,>=2.1.1; extra == 'test'
 Requires-Dist: hypothesis<6.136,>=6.135.0; extra == 'test'

{dycw_utilities-0.129.9 → dycw_utilities-0.129.11}/pyproject.toml

@@ -93,9 +93,15 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.129.9"
+version = "0.129.11"
 
 [project.optional-dependencies]
+logging = [
+  "atomicwrites >= 1.4.1, < 1.5",
+  "coloredlogs >= 15.0.1, < 15.1",
+  "tzlocal >= 5.3.1, < 5.4",
+  "whenever >= 0.8.4, < 0.9",
+]
 test = [
   "dycw-pytest-only >= 2.1.1, < 2.2",
   "hypothesis >= 6.135.0, < 6.136",
@@ -332,7 +338,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.129.9"
+current_version = "0.129.11"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

dycw_utilities-0.129.11/src/tests/test_git.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from hypothesis import given, settings
+from pytest import raises
+
+from utilities.git import GetRepoRootError, get_repo_root
+from utilities.hypothesis import git_repos
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+class TestGetRepoRoot:
+    @given(repo=git_repos())
+    @settings(max_examples=1)
+    def test_main(self, *, repo: Path) -> None:
+        root = get_repo_root(path=repo)
+        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)

{dycw_utilities-0.129.9 → dycw_utilities-0.129.11}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.129.9"
+__version__ = "0.129.11"

dycw_utilities-0.129.11/src/utilities/git.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from pathlib import Path
+from re import IGNORECASE, search
+from subprocess import PIPE, CalledProcessError, check_output
+from typing import TYPE_CHECKING, override
+
+from utilities.pathlib import PWD
+
+if TYPE_CHECKING:
+    from utilities.types import PathLike
+
+
+def get_repo_root(*, path: PathLike = PWD) -> Path:
+    """Get the repo root."""
+    try:
+        output = check_output(
+            ["git", "rev-parse", "--show-toplevel"], stderr=PIPE, cwd=path, text=True
+        )
+    except CalledProcessError as error:
+        # newer versions of git report "Not a git repository", whilst older
+        # versions report "not a git repository"
+        if search("fatal: not a git repository", error.stderr, flags=IGNORECASE):
+            raise GetRepoRootError(cwd=path) from error
+        raise  # pragma: no cover
+    else:
+        return Path(output.strip("\n"))
+
+
+@dataclass(kw_only=True, slots=True)
+class GetRepoRootError(Exception):
+    cwd: PathLike
+
+    @override
+    def __str__(self) -> str:
+        return f"Path is not part of a `git` repository: {self.cwd}"
+
+
+__all__ = ["GetRepoRootError", "get_repo_root"]

{dycw_utilities-0.129.9 → dycw_utilities-0.129.11}/src/utilities/logging.py

@@ -85,6 +85,9 @@ except ModuleNotFoundError:  # pragma: no cover
 type _When = Literal[
     "S", "M", "H", "D", "midnight", "W0", "W1", "W2", "W3", "W4", "W5", "W6"
 ]
+_BACKUP_COUNT: int = 100
+_MAX_BYTES: int = 10 * 1024**2
+_WHEN: _When = "D"
 
 
 class SizeAndTimeRotatingFileHandler(BaseRotatingHandler):
@@ -100,10 +103,10 @@ class SizeAndTimeRotatingFileHandler(BaseRotatingHandler):
         encoding: str | None = None,
         delay: bool = False,
         errors: Literal["strict", "ignore", "replace"] | None = None,
-        maxBytes: int = 0,
-        when: _When = "midnight",
+        maxBytes: int = _MAX_BYTES,
+        when: _When = _WHEN,
         interval: int = 1,
-        backupCount: int = 0,
+        backupCount: int = _BACKUP_COUNT,
         utc: bool = False,
         atTime: dt.time | None = None,
     ) -> None:
@@ -554,10 +557,10 @@ def setup_logging(
     console_filters: Iterable[_FilterType] | None = None,
     console_fmt: str = "❯ {_zoned_datetime_str} | {name}:{funcName}:{lineno} | {message}",  # noqa: RUF001
     files_dir: MaybeCallablePathLike | None = get_default_logging_path,
-    files_when: _When = "D",
+    files_when: _When = _WHEN,
     files_interval: int = 1,
-    files_backup_count: int = 10,
-    files_max_bytes: int = 10 * 1024**2,
+    files_backup_count: int = _BACKUP_COUNT,
+    files_max_bytes: int = _MAX_BYTES,
     files_filters: Iterable[_FilterType] | None = None,
     files_fmt: str = "{_zoned_datetime_str} | {name}:{funcName}:{lineno} | {levelname:8} | {message}",
     filters: MaybeIterable[_FilterType] | None = None,