dycw-pre-commit-hooks 0.11.3__py3-none-any.whl → 0.12.1__py3-none-any.whl

{dycw_pre_commit_hooks-0.11.3.dist-info → dycw_pre_commit_hooks-0.12.1.dist-info}/METADATA

@@ -1,14 +1,17 @@
 Metadata-Version: 2.4
 Name: dycw-pre-commit-hooks
-Version: 0.11.3
+Version: 0.12.1
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Python: >=3.12
 Requires-Dist: click<8.3,>=8.2.1
-Requires-Dist: dycw-utilities<0.151,>=0.150.11
+Requires-Dist: dycw-utilities<0.167,>=0.166.5
+Requires-Dist: gitpython<3.2,>=3.1.45
 Requires-Dist: libcst<1.9,>=1.8.2
 Requires-Dist: loguru<0.8,>=0.7.3
+Requires-Dist: orjson<3.12,>=3.11.3
 Requires-Dist: packaging<25.1,>=25.0
 Requires-Dist: tomlkit<0.14,>=0.13.2
+Requires-Dist: xdg-base-dirs<6.1,>=6.0.2
 Description-Content-Type: text/markdown
 
 # pre-commit-hooks
@@ -28,9 +31,10 @@ My [`pre-commit`](https://pre-commit.com/) hooks.
      - repo: https://github.com/dycw/pre-commit-hooks
        rev: master
        hooks:
+         - id: format-requirements
          - id: replace-sequence-str
          - id: run-bump-my-version
-         - id: run-ruff-format
+         - id: tag-commits
    ```
 
 1. Update your `.pre-commit-config.yaml`:

dycw_pre_commit_hooks-0.12.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+pre_commit_hooks/__init__.py,sha256=bMyIveYyxCjAv2_JH9Hd38cd4RL7NmCC4HiW8Td0nQU,59
+pre_commit_hooks/common.py,sha256=x-a-v0esyBPJqPZf6uypbrFaxUKEgfnuAxiUvYSaLbA,2350
+pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pre_commit_hooks/format_requirements/__init__.py,sha256=bn1JsblINCf0ro2QrhsM8XtTOHnPFSZC2t-Hx5AJDfA,3392
+pre_commit_hooks/format_requirements/__main__.py,sha256=15JSp_rhjI_Ddoj4MRkHFShfnYxs6GggUhLRlGtrQ0E,156
+pre_commit_hooks/replace_sequence_str/__init__.py,sha256=a-pCAcBaa7FDsGDNLzMiD-xG20wKl-SRmhWSbm9hrvo,1618
+pre_commit_hooks/replace_sequence_str/__main__.py,sha256=B1dxOxngV4vUVnDVrXSywiySOs1P_zF30_4ZMRsOSaY,157
+pre_commit_hooks/run_bump_my_version/__init__.py,sha256=UGaOu7Ie5LRGsMe34eygSgMWteKfDRGNX49R3kafczk,1353
+pre_commit_hooks/run_bump_my_version/__main__.py,sha256=w2V3y61jrSau-zxjl8ciHtWPlJQwXbYxNJ2tGYVyI4s,156
+pre_commit_hooks/tag_commits/__init__.py,sha256=BvpAqdRDw06Gab3jNXYO6BgosnMybowZUsXV8wQA2gU,3699
+pre_commit_hooks/tag_commits/__main__.py,sha256=qefgYw7LWbvmzZS45-ym6olS4cHqw1Emw2wlqZBXN_o,148
+dycw_pre_commit_hooks-0.12.1.dist-info/METADATA,sha256=CvLbPZLgmY-MZS2dZulcvQHAmS64lk64xP96uvC-dVY,1029
+dycw_pre_commit_hooks-0.12.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_pre_commit_hooks-0.12.1.dist-info/entry_points.txt,sha256=r1tnPzaGvOrSdX-ZRriidf8AhZgUtXfjdTpwpkTBA8U,260
+dycw_pre_commit_hooks-0.12.1.dist-info/RECORD,,

{dycw_pre_commit_hooks-0.11.3.dist-info → dycw_pre_commit_hooks-0.12.1.dist-info}/entry_points.txt

@@ -2,4 +2,4 @@
 format-requirements = pre_commit_hooks.format_requirements:main
 replace-sequence-str = pre_commit_hooks.replace_sequence_str:main
 run-bump-my-version = pre_commit_hooks.run_bump_my_version:main
-run-ruff-format = pre_commit_hooks.run_ruff_format:main
+tag-commits = pre_commit_hooks.tag_commits:main

pre_commit_hooks/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.11.3"
+__version__ = "0.12.1"

pre_commit_hooks/common.py

@@ -1,33 +1,66 @@
 from __future__ import annotations
 
-from dataclasses import dataclass
+from pathlib import Path
+from typing import assert_never
 
 from loguru import logger
 from tomlkit import TOMLDocument, parse
+from tomlkit.items import Table
 from utilities.pathlib import get_repo_root
+from utilities.version import Version, parse_version
 
-_ROOT = get_repo_root()
-PYPROJECT_TOML = _ROOT.joinpath("pyproject.toml")
+PYPROJECT_TOML = get_repo_root().joinpath("pyproject.toml")
 
 
-##
+def get_version(
+    path_or_text: Path | str | bytes | TOMLDocument, /, *, desc: str = ""
+) -> Version:
+    """Parse the version from a block of text."""
+    match path_or_text:
+        case Path() as path:
+            return get_version(
+                path.read_text(), desc=f" from {str(path)!r}" if desc == "" else desc
+            )
+        case str() | bytes() as text:
+            return get_version(parse(text), desc=desc)
+        case TOMLDocument() as doc:
+            try:
+                tool = doc["tool"]
+            except KeyError:
+                logger.exception(
+                    f"Failed to get version{desc}; key 'tool' does not exist"
+                )
+                raise
+            if not isinstance(tool, Table):
+                logger.exception(f"Failed to get version{desc}; `tool` is not a Table")
+                raise TypeError
+            try:
+                bumpversion = tool["bumpversion"]
+            except KeyError:
+                logger.exception(
+                    f"Failed to get version{desc}; key 'bumpversion' does not exist"
+                )
+                raise
+            if not isinstance(bumpversion, Table):
+                logger.exception(
+                    f"Failed to get version{desc}; `bumpversion` is not a Table"
+                )
+                raise TypeError
+            try:
+                version = bumpversion["current_version"]
+            except KeyError:
+                logger.exception(
+                    f"Failed to get version{desc}; key 'current_version' does not exist"
+                )
+                raise
+            if not isinstance(version, str):
+                logger.exception(
+                    f"Failed to get version{desc}; `version` is not a string"
+                )
+                raise TypeError
+            return parse_version(version)
+        case never:  # pyright: ignore[reportUnnecessaryComparison]
+            assert_never(never)
 
 
-@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)
-
-
-__all__ = ["PYPROJECT_TOML", "read_pyproject"]
+__all__ = ["PYPROJECT_TOML", "get_version"]

pre_commit_hooks/format_requirements/__init__.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, override
 
+import utilities.click
 from click import argument, command
 from packaging._tokenizer import ParserSyntaxError
 from packaging.requirements import (
@@ -13,7 +14,6 @@ from packaging.specifiers import Specifier, SpecifierSet
 from tomlkit import array, dumps, loads, string
 from tomlkit.items import Array, Table
 from utilities.atomicwrites import writer
-from utilities.click import FilePath
 
 from pre_commit_hooks.common import PYPROJECT_TOML
 
@@ -25,10 +25,10 @@ if TYPE_CHECKING:
 
 
 @command()
-@argument("paths", nargs=-1, type=FilePath)
+@argument("paths", nargs=-1, type=utilities.click.Path())
 def main(*, paths: tuple[Path, ...]) -> bool:
     """CLI for the `format_requirements` hook."""
-    results = list(map(_process, paths))
+    results = list(map(_process, paths))  # run all
     return all(results)
 
 

pre_commit_hooks/replace_sequence_str/__init__.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING, override
 
+import utilities.click
 from click import argument, command
 from libcst import CSTTransformer, Name, Subscript, parse_module
 from libcst.matchers import Index as MIndex
@@ -10,17 +11,16 @@ from libcst.matchers import Subscript as MSubscript
 from libcst.matchers import SubscriptElement as MSubscriptElement
 from libcst.matchers import matches
 from libcst.metadata import MetadataWrapper
-from utilities.click import FilePath
 
 if TYPE_CHECKING:
     from pathlib import Path
 
 
 @command()
-@argument("paths", nargs=-1, type=FilePath)
+@argument("paths", nargs=-1, type=utilities.click.Path())
 def main(*, paths: tuple[Path, ...]) -> bool:
     """CLI for the `replace_sequence_str` hook."""
-    results = list(map(_process, paths))
+    results = list(map(_process, paths))  # run all
     return all(results)
 
 

pre_commit_hooks/run_bump_my_version/__init__.py

@@ -1,15 +1,12 @@
 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
+from pre_commit_hooks.common import PYPROJECT_TOML, get_version
 
 
 @command()
@@ -20,10 +17,10 @@ def main() -> bool:
 
 def _process() -> bool:
     path = PYPROJECT_TOML.relative_to(Path.cwd())
-    current = _parse_version_from_file_or_text(path)
+    current = get_version(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)
+    master = get_version(contents)
     if current in {master.bump_patch(), master.bump_minor(), master.bump_major()}:
         return True
     cmd = [
@@ -47,18 +44,4 @@ def _process() -> bool:
     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)
-
-
 __all__ = ["main"]

pre_commit_hooks/tag_commits/__init__.py

@@ -0,0 +1,127 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import utilities.click
+from click import command, option
+from git import Commit, GitCommandError, Repo
+from loguru import logger
+from utilities.hashlib import md5_hash
+from utilities.pathlib import get_repo_root
+from utilities.tzlocal import LOCAL_TIME_ZONE_NAME
+from utilities.whenever import from_timestamp, get_now_local
+from whenever import DateTimeDelta, ZonedDateTime
+from xdg_base_dirs import xdg_cache_home
+
+from pre_commit_hooks.common import get_version
+
+if TYPE_CHECKING:
+    from collections.abc import Set as AbstractSet
+
+_RUN_EVERY: DateTimeDelta | None = None
+_MAX_AGE: DateTimeDelta | None = None
+
+
+@command()
+@option(
+    "--run-every",
+    type=utilities.click.DateTimeDelta(),
+    default=_RUN_EVERY,
+    show_default=True,
+)
+@option(
+    "--max-age",
+    type=utilities.click.DateTimeDelta(),
+    default=_MAX_AGE,
+    show_default=True,
+)
+def main(
+    *,
+    run_every: DateTimeDelta | None = _RUN_EVERY,
+    max_age: DateTimeDelta | None = _MAX_AGE,
+) -> bool:
+    """CLI for the `tag_commits` hook."""
+    return _process(run_every=run_every, max_age=max_age)
+
+
+def _process(
+    *,
+    run_every: DateTimeDelta | None = _RUN_EVERY,
+    max_age: DateTimeDelta | None = _MAX_AGE,
+) -> bool:
+    if run_every is not None:
+        last = _get_last_run()
+        min_date_time = get_now_local() - run_every
+        if (last is not None) and (min_date_time <= last):
+            return True
+    return _process_commits(max_age=max_age)
+
+
+def _get_last_run() -> ZonedDateTime | None:
+    hash_ = md5_hash(get_repo_root())
+    path = xdg_cache_home().joinpath("tag-commits", hash_)
+    try:
+        text = path.read_text()
+    except FileNotFoundError:
+        return None
+    try:
+        return ZonedDateTime.parse_common_iso(text.strip("\n"))
+    except ValueError:
+        return None
+
+
+def _process_commits(*, max_age: DateTimeDelta | None = None) -> bool:
+    repo = Repo(".", search_parent_directories=True)
+    tagged = {tag.commit.hexsha for tag in repo.tags}
+    min_date_time = None if max_age is None else (get_now_local() - max_age)
+    commits = reversed(list(repo.iter_commits(repo.refs["origin/master"])))
+    results = [
+        _process_commit(c, tagged, repo, min_date_time=min_date_time) for c in commits
+    ]  # run all
+    return all(results)
+
+
+def _process_commit(
+    commit: Commit,
+    tagged: AbstractSet[str],
+    repo: Repo,
+    /,
+    *,
+    min_date_time: ZonedDateTime | None = None,
+) -> bool:
+    if (commit.hexsha in tagged) or (
+        (min_date_time is not None) and (_get_date_time(commit) < min_date_time)
+    ):
+        return True
+    try:
+        _tag_commit(commit, repo)
+    except GitCommandError:
+        return False
+    return True
+
+
+def _get_date_time(commit: Commit, /) -> ZonedDateTime:
+    return from_timestamp(commit.committed_date, time_zone=LOCAL_TIME_ZONE_NAME)
+
+
+def _tag_commit(commit: Commit, repo: Repo, /) -> None:
+    sha = commit.hexsha[:7]
+    date = _get_date_time(commit)
+    try:
+        joined = commit.tree.join("pyproject.toml")
+    except KeyError:
+        logger.exception(f"`pyproject.toml` not found; failed to tag {sha!r} ({date})")
+        return
+    text = joined.data_stream.read()
+    version = get_version(text, desc=f"'pyproject.toml' @ {sha}")
+    try:
+        tag = repo.create_tag(str(version), ref=sha)
+    except GitCommandError as error:
+        desc = error.stderr.strip("\n").strip()
+        logger.exception(f"Failed to tag {sha!r} ({date}) due to {desc}")
+        return
+    logger.info(f"Tagging {sha!r} ({date}) as {str(version)!r}...")
+    _ = repo.remotes.origin.push(f"refs/tags/{tag.name}")
+
+
+__all__ = ["main"]

pre_commit_hooks/{run_ruff_format → tag_commits}/__main__.py

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

dycw_pre_commit_hooks-0.11.3.dist-info/RECORD

@@ -1,15 +0,0 @@
-pre_commit_hooks/__init__.py,sha256=A7kvce4fHYgV1tEVj_d1Ynre-ZheJHHRqpWXzriT7ko,59
-pre_commit_hooks/common.py,sha256=JDpKC4-T4ucPZkK3bAQZ9xrYKsJ7wi1mTo5gVXFGe80,695
-pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pre_commit_hooks/format_requirements/__init__.py,sha256=OXqdd3J5p9sstWcdEOCQb5wH3tDAZStecO6CKRZvBuA,3381
-pre_commit_hooks/format_requirements/__main__.py,sha256=15JSp_rhjI_Ddoj4MRkHFShfnYxs6GggUhLRlGtrQ0E,156
-pre_commit_hooks/replace_sequence_str/__init__.py,sha256=bPkc3KHbu8RMFykIsegW06hAKUXtXjJD36KtECDsNR8,1607
-pre_commit_hooks/replace_sequence_str/__main__.py,sha256=B1dxOxngV4vUVnDVrXSywiySOs1P_zF30_4ZMRsOSaY,157
-pre_commit_hooks/run_bump_my_version/__init__.py,sha256=9RpVVqTmtmKkV8rMR4sMfI-i_7gaLOmNrfi2GWgtNSk,1953
-pre_commit_hooks/run_bump_my_version/__main__.py,sha256=w2V3y61jrSau-zxjl8ciHtWPlJQwXbYxNJ2tGYVyI4s,156
-pre_commit_hooks/run_ruff_format/__init__.py,sha256=4QYVE-ktOZjJZGqLMpy4_Te1dASzEkEYVBHzpa1EdGM,2062
-pre_commit_hooks/run_ruff_format/__main__.py,sha256=faesqqpMaesg5r-LvkkQt1W9kahvNr-60K3SMYv1NgY,152
-dycw_pre_commit_hooks-0.11.3.dist-info/METADATA,sha256=SXc54B_PuqaSNaiPsVp03dzKQyp_aFyNFtnPz4Yxl58,884
-dycw_pre_commit_hooks-0.11.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_pre_commit_hooks-0.11.3.dist-info/entry_points.txt,sha256=V5pxLTDfSr4UJAWI-1bNEazF1SCSkkpYr0nRx3B0QTg,268
-dycw_pre_commit_hooks-0.11.3.dist-info/RECORD,,

pre_commit_hooks/run_ruff_format/__init__.py

@@ -1,81 +0,0 @@
-from __future__ import annotations
-
-from subprocess import CalledProcessError, check_call
-from typing import TYPE_CHECKING, cast
-
-from click import command
-from loguru import logger
-from tomlkit import dumps, table
-
-from pre_commit_hooks.common import PYPROJECT_TOML, PyProject, read_pyproject
-
-if TYPE_CHECKING:
-    from tomlkit.container import Container
-
-
-@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)
-
-
-__all__ = ["main"]