dycw-pre-commit-hooks 0.10.20__py3-none-any.whl → 0.10.21__py3-none-any.whl

{dycw_pre_commit_hooks-0.10.20.dist-info → dycw_pre_commit_hooks-0.10.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-pre-commit-hooks
-Version: 0.10.20
+Version: 0.10.21
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Python: >=3.11
 Requires-Dist: click<8.2,>=8.1.8

dycw_pre_commit_hooks-0.10.21.dist-info/RECORD

@@ -0,0 +1,13 @@
+pre_commit_hooks/__init__.py,sha256=Kl1CGvFCtMKhwmNrSv6UxFVZCcuERQS4LE1u87kW7ZQ,60
+pre_commit_hooks/common.py,sha256=v2pUvEMLMfAXg2nNJOH9LYHbFWkdOssLFwnDXsIEkqk,2703
+pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pre_commit_hooks/run_bump2version/__init__.py,sha256=1Qgt7njFfTlH39ZY4TucZREUJgqtGMe37U5mLkFmupc,1433
+pre_commit_hooks/run_bump2version/__main__.py,sha256=BZy8mDElAK3-X2iKvqg1XnGbCiYXcLoMDefaPanWx4g,153
+pre_commit_hooks/run_bump_my_version/__init__.py,sha256=cl6KTxPaKPmHuebddgfs_OqPK_oYI3R15AbLo8kcFRY,1837
+pre_commit_hooks/run_bump_my_version/__main__.py,sha256=w2V3y61jrSau-zxjl8ciHtWPlJQwXbYxNJ2tGYVyI4s,156
+pre_commit_hooks/run_ruff_format/__init__.py,sha256=Lr_9M0WHhJl6WARAf8Lr830PG9bMbkDXvNSmEkrSxK8,1993
+pre_commit_hooks/run_ruff_format/__main__.py,sha256=faesqqpMaesg5r-LvkkQt1W9kahvNr-60K3SMYv1NgY,152
+dycw_pre_commit_hooks-0.10.21.dist-info/METADATA,sha256=d07FIgkDzxrNd9xYm63JCiCC0W2ovk9wNhChlh6ZM3Q,884
+dycw_pre_commit_hooks-0.10.21.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_pre_commit_hooks-0.10.21.dist-info/entry_points.txt,sha256=URODtkWLHrg6PagXnVbubNWnEUjExjCM_lCPf2LEllo,196
+dycw_pre_commit_hooks-0.10.21.dist-info/RECORD,,

pre_commit_hooks/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__version__ = "0.10.21"

pre_commit_hooks/common.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from hashlib import md5
+from pathlib import Path
+from re import MULTILINE, findall
+from subprocess import check_output
+from typing import Literal
+
+from loguru import logger
+from semver import VersionInfo
+from tomlkit import TOMLDocument, parse
+from utilities.git import get_repo_root
+from xdg_base_dirs import xdg_cache_home
+
+_ROOT = get_repo_root()
+PYPROJECT_TOML = _ROOT.joinpath("pyproject.toml")
+
+
+##
+
+
+_VERSION_BUMP_SCRIPTS = Literal[
+    "run-bump-my-version", "run-bump2version", "run-hatch-version"
+]
+
+
+def check_versions(
+    path: Path, pattern: str, name: _VERSION_BUMP_SCRIPTS, /
+) -> VersionInfo | None:
+    """Check the versions: current & master.
+
+    If the current is a correct bumping of master, then return `None`. Else,
+    return the patch-bumped master.
+    """
+    with path.open() as fh:
+        current = _parse_version(pattern, fh.read())
+    master = _get_master_version(name, path, pattern)
+    patched = master.bump_patch()
+    if current in {master.bump_major(), master.bump_minor(), patched}:
+        return None
+    return patched
+
+
+def _parse_version(pattern: str, text: str, /) -> VersionInfo:
+    """Parse the version from a block of text."""
+    (match,) = findall(pattern, text, flags=MULTILINE)
+    return VersionInfo.parse(match)
+
+
+def _get_master_version(
+    name: _VERSION_BUMP_SCRIPTS, path: Path, pattern: str, /
+) -> VersionInfo:
+    repo = md5(Path.cwd().as_posix().encode(), usedforsecurity=False).hexdigest()
+    commit = check_output(["git", "rev-parse", "origin/master"], text=True).rstrip("\n")
+    cache = xdg_cache_home().joinpath("pre-commit-hooks", name, repo, commit)
+    try:
+        with cache.open() as fh:
+            return VersionInfo.parse(fh.read())
+    except FileNotFoundError:
+        cache.parent.mkdir(parents=True, exist_ok=True)
+        text = check_output(["git", "show", f"{commit}:{path}"], text=True)
+        version = _parse_version(pattern, text)
+        with cache.open(mode="w") as fh:
+            _ = fh.write(str(version))
+        return version
+
+
+##
+
+
+@dataclass(kw_only=True)
+class PyProject:
+    contents: str
+    doc: TOMLDocument
+
+
+def read_pyproject() -> PyProject:
+    try:
+        with PYPROJECT_TOML.open(mode="r") as fh:
+            contents = fh.read()
+    except FileNotFoundError:
+        logger.exception("pyproject.toml not found")
+        raise
+    doc = parse(contents)
+    return PyProject(contents=contents, doc=doc)
+
+
+##
+
+
+def trim_trailing_whitespaces(path: Path, /) -> None:
+    with path.open() as fh:
+        lines = fh.readlines()
+    with path.open(mode="w") as fh:
+        fh.writelines([line.rstrip(" ") for line in lines])

pre_commit_hooks/run_bump2version/__init__.py

@@ -0,0 +1,46 @@
+from __future__ import annotations
+
+from pathlib import Path
+from subprocess import PIPE, STDOUT, CalledProcessError, check_call
+from typing import Literal
+
+from click import command, option
+from loguru import logger
+
+from pre_commit_hooks.common import (
+    PYPROJECT_TOML,
+    check_versions,
+    trim_trailing_whitespaces,
+)
+
+
+@command()
+@option(
+    "--setup-cfg", is_flag=True, help="Read `setup.cfg` instead of `bumpversion.cfg`"
+)
+def main(*, setup_cfg: bool) -> bool:
+    """CLI for the `run_bump2version` hook."""
+    filename = "setup.cfg" if setup_cfg else ".bumpversion.cfg"
+    return _process(filename=filename)
+
+
+def _process(*, filename: Literal["setup.cfg", ".bumpversion.cfg"]) -> bool:
+    path = Path(filename)
+    pattern = r"current_version = (\d+\.\d+\.\d+)$"
+    version = check_versions(PYPROJECT_TOML, pattern, "run-bump2version")
+    if version is None:
+        return True
+    cmd = ["bump2version", "--allow-dirty", f"--new-version={version}", "patch"]
+    try:
+        _ = check_call(cmd, stdout=PIPE, stderr=STDOUT)
+    except CalledProcessError as error:
+        if error.returncode != 1:
+            logger.exception("Failed to run {cmd!r}", cmd=" ".join(cmd))
+    except FileNotFoundError:
+        logger.exception(
+            "Failed to run {cmd!r}. Is `bump2version` installed?", cmd=" ".join(cmd)
+        )
+    else:
+        trim_trailing_whitespaces(path)
+        return True
+    return False

pre_commit_hooks/run_bump2version/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from pre_commit_hooks.run_bump2version import main
+
+if __name__ == "__main__":
+    raise SystemExit(int(not main()))

pre_commit_hooks/run_bump_my_version/__init__.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+import re
+from pathlib import Path
+from re import MULTILINE
+from subprocess import PIPE, STDOUT, CalledProcessError, check_call, check_output
+
+from click import command
+from loguru import logger
+from utilities.version import Version, parse_version
+
+from pre_commit_hooks.common import PYPROJECT_TOML
+
+
+@command()
+def main() -> bool:
+    """CLI for the `run_bump_my_version` hook."""
+    return _process()
+
+
+def _process() -> bool:
+    path = PYPROJECT_TOML.relative_to(Path.cwd())
+    current = _parse_version_from_file_or_text(path)
+    commit = check_output(["git", "rev-parse", "origin/master"], text=True).rstrip("\n")
+    contents = check_output(["git", "show", f"{commit}:{path}"], text=True)
+    master = _parse_version_from_file_or_text(contents)
+    if current in {master.bump_patch(), master.bump_minor(), master.bump_major()}:
+        return True
+    cmd = ["bump-my-version", "bump", "patch"]
+    try:
+        _ = check_call(cmd, stdout=PIPE, stderr=STDOUT)
+    except CalledProcessError as error:
+        if error.returncode != 1:
+            logger.exception("Failed to run {cmd!r}", cmd=" ".join(cmd))
+    except FileNotFoundError:
+        logger.exception(
+            "Failed to run {cmd!r}. Is `bump-my-version` installed?", cmd=" ".join(cmd)
+        )
+    else:
+        return True
+    return False
+
+
+_PATTERN = re.compile(r'^current_version = "(\d+\.\d+\.\d+)"$', flags=MULTILINE)
+
+
+def _parse_version_from_file_or_text(path_or_text: Path | str, /) -> Version:
+    """Parse the version from a block of text."""
+    match path_or_text:
+        case Path() as path:
+            with path.open() as fh:
+                return _parse_version_from_file_or_text(fh.read())
+        case str() as text:
+            (match,) = _PATTERN.findall(text)
+            return parse_version(match)

pre_commit_hooks/run_bump_my_version/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from pre_commit_hooks.run_bump_my_version import main
+
+if __name__ == "__main__":
+    raise SystemExit(int(not main()))

pre_commit_hooks/run_ruff_format/__init__.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from subprocess import CalledProcessError, check_call
+from typing import cast
+
+from click import command
+from loguru import logger
+from tomlkit import dumps, table
+from tomlkit.container import Container
+
+from pre_commit_hooks.common import PYPROJECT_TOML, PyProject, read_pyproject
+
+
+@command()
+def main() -> bool:
+    """CLI for the `run-ruff-format` hook."""
+    return _process()
+
+
+def _process() -> bool:
+    curr = read_pyproject()
+    new = _get_modified_pyproject()
+    result1 = _run_ruff_format(new)
+    result2 = _run_ruff_format(curr)
+    _write_pyproject(curr)
+    return result1 and result2
+
+
+def _get_modified_pyproject() -> PyProject:
+    pyproject = read_pyproject()
+    doc = pyproject.doc
+    try:
+        tool = cast(Container, doc["tool"])
+    except KeyError:
+        tool = table()
+    try:
+        ruff = cast(Container, tool["ruff"])
+    except KeyError:
+        ruff = table()
+    ruff["line-length"] = 320
+    try:
+        format_ = cast(Container, ruff["format"])
+    except KeyError:
+        format_ = table()
+    format_["skip-magic-trailing-comma"] = True
+    try:
+        lint = cast(Container, ruff["lint"])
+    except KeyError:
+        lint = table()
+    try:
+        isort = cast(Container, lint["isort"])
+    except KeyError:
+        isort = table()
+    isort["split-on-trailing-comma"] = False
+    doc["tool"] = tool
+    tool["ruff"] = ruff
+    ruff["format"] = format_
+    ruff["lint"] = lint
+    lint["isort"] = isort
+    return PyProject(contents=dumps(doc), doc=doc)
+
+
+def _run_ruff_format(pyproject: PyProject, /) -> bool:
+    _write_pyproject(pyproject)
+    cmd = ["ruff", "format", "."]
+    try:
+        code = check_call(cmd)
+    except CalledProcessError:
+        logger.exception("Failed to run {cmd!r}", cmd=" ".join(cmd))
+        return False
+    return code == 0
+
+
+def _write_pyproject(pyproject: PyProject, /) -> None:
+    with PYPROJECT_TOML.open(mode="w") as fh:
+        _ = fh.write(pyproject.contents)

pre_commit_hooks/run_ruff_format/__main__.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from pre_commit_hooks.run_ruff_format import main
+
+if __name__ == "__main__":
+    raise SystemExit(int(not main()))

dycw_pre_commit_hooks-0.10.20.dist-info/RECORD

@@ -1,4 +0,0 @@
-dycw_pre_commit_hooks-0.10.20.dist-info/METADATA,sha256=3HMd82S3AQVIGOWt0mZu-ArSgItNBRPDEh081Phkank,884
-dycw_pre_commit_hooks-0.10.20.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_pre_commit_hooks-0.10.20.dist-info/entry_points.txt,sha256=URODtkWLHrg6PagXnVbubNWnEUjExjCM_lCPf2LEllo,196
-dycw_pre_commit_hooks-0.10.20.dist-info/RECORD,,