dycw-pre-commit-hooks 0.12.9__py3-none-any.whl → 0.13.0__py3-none-any.whl

{dycw_pre_commit_hooks-0.12.9.dist-info → dycw_pre_commit_hooks-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-pre-commit-hooks
-Version: 0.12.9
+Version: 0.13.0
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Python: >=3.12
 Requires-Dist: click<8.3,>=8.2.1
@@ -8,7 +8,7 @@ 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: more-itertools<10.8,>=10.7.0
+Requires-Dist: more-itertools<10.9,>=10.8.0
 Requires-Dist: orjson<3.12,>=3.11.3
 Requires-Dist: packaging<25.1,>=25.0
 Requires-Dist: tomlkit<0.14,>=0.13.2
@@ -32,8 +32,8 @@ My [`pre-commit`](https://pre-commit.com/) hooks.
      - repo: https://github.com/dycw/pre-commit-hooks
        rev: master
        hooks:
-         - id: check-submodules
          - id: format-requirements
+         - id: mirror-files
          - id: replace-sequence-str
          - id: run-bump-my-version
          - id: tag-commits

dycw_pre_commit_hooks-0.13.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+pre_commit_hooks/__init__.py,sha256=VX99Js9MSUXrTMe_OSKIYhYYPRRvI_8mU7_0pIpdJmw,59
+pre_commit_hooks/common.py,sha256=BkGWepSj_y_y6pOrvKX4G8259o5Klp1C-Yg2cdDTi0s,4482
+pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pre_commit_hooks/format_requirements/__init__.py,sha256=ByGP9oCf5c5-55Tayp8BvnT6O-_Fi5om1AAva1BzLvg,3223
+pre_commit_hooks/format_requirements/__main__.py,sha256=15JSp_rhjI_Ddoj4MRkHFShfnYxs6GggUhLRlGtrQ0E,156
+pre_commit_hooks/mirror_files/__init__.py,sha256=GSoFXo_og3d7NkQcmzdWOZyxQJPCO1nr4JtMVVcNJOI,1646
+pre_commit_hooks/mirror_files/__main__.py,sha256=YzOSNKR2XrVST5dgIVJrpRL28QkcziciOomuKtVX7Jo,149
+pre_commit_hooks/replace_sequence_str/__init__.py,sha256=IUyhpYh89PF9fX65zYe5Pt3cIvvWa0HiUDng0deL0Nw,1628
+pre_commit_hooks/replace_sequence_str/__main__.py,sha256=B1dxOxngV4vUVnDVrXSywiySOs1P_zF30_4ZMRsOSaY,157
+pre_commit_hooks/run_bump_my_version/__init__.py,sha256=FhvLQEEoFm21_2c_12Loy_lc8gfNv2wtwAOrdtBEqrs,2028
+pre_commit_hooks/run_bump_my_version/__main__.py,sha256=w2V3y61jrSau-zxjl8ciHtWPlJQwXbYxNJ2tGYVyI4s,156
+pre_commit_hooks/tag_commits/__init__.py,sha256=6HWjXOcTd9gjiZwXmy2lIhZzru-zeRgbpEYxKi1z5sg,3294
+pre_commit_hooks/tag_commits/__main__.py,sha256=qefgYw7LWbvmzZS45-ym6olS4cHqw1Emw2wlqZBXN_o,148
+dycw_pre_commit_hooks-0.13.0.dist-info/METADATA,sha256=iEdyGf05U2B_FOypZ9Um7DknncrbYhHIdA9_zskLIzU,1101
+dycw_pre_commit_hooks-0.13.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_pre_commit_hooks-0.13.0.dist-info/entry_points.txt,sha256=OTVj55u2A6hqtbiPa_h9Zd9pTToCsI9P5xpzE3g4NZc,310
+dycw_pre_commit_hooks-0.13.0.dist-info/RECORD,,

{dycw_pre_commit_hooks-0.12.9.dist-info → dycw_pre_commit_hooks-0.13.0.dist-info}/entry_points.txt

@@ -1,5 +1,4 @@
 [console_scripts]
-check-submodules = pre_commit_hooks.check_submodules:main
 format-requirements = pre_commit_hooks.format_requirements:main
 mirror-files = pre_commit_hooks.mirror_files:main
 replace-sequence-str = pre_commit_hooks.replace_sequence_str:main

pre_commit_hooks/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.12.9"
+__version__ = "0.13.0"

pre_commit_hooks/common.py

@@ -5,10 +5,10 @@ from typing import TYPE_CHECKING, Literal, assert_never
 
 import utilities.click
 from click import Choice, option
-from loguru import logger
 from tomlkit import TOMLDocument, parse
 from tomlkit.items import Table
 from utilities.atomicwrites import writer
+from utilities.functions import get_class_name
 from utilities.hashlib import md5_hash
 from utilities.pathlib import get_repo_root
 from utilities.typing import get_literal_elements
@@ -17,7 +17,7 @@ from utilities.whenever import get_now_local, to_zoned_date_time
 from xdg_base_dirs import xdg_cache_home
 
 if TYPE_CHECKING:
-    from collections.abc import Callable
+    from collections.abc import Callable, Iterator
 
     from whenever import DateTimeDelta
 
@@ -47,36 +47,35 @@ def get_version(source: Mode | Path | str | bytes | TOMLDocument, /) -> Version:
             try:
                 tool = doc["tool"]
             except KeyError:
-                logger.exception("Failed to get version; key 'tool' does not exist")
-                raise
+                msg = "Key 'tool' does not exist"
+                raise GetVersionError(msg) from None
             if not isinstance(tool, Table):
-                logger.exception("Failed to get version; `tool` is not a Table")
-                raise TypeError
+                msg = "`tool` is not a Table"
+                raise GetVersionError(msg)
             try:
                 bumpversion = tool["bumpversion"]
             except KeyError:
-                logger.exception(
-                    "Failed to get version; key 'bumpversion' does not exist"
-                )
-                raise
+                msg = "Key 'bumpversion' does not exist"
+                raise GetVersionError(msg) from None
             if not isinstance(bumpversion, Table):
-                logger.exception("Failed to get version; `bumpversion` is not a Table")
-                raise TypeError
+                msg = "`bumpversion` is not a Table"
+                raise GetVersionError(msg)
             try:
                 version = bumpversion["current_version"]
             except KeyError:
-                logger.exception(
-                    "Failed to get version; key 'current_version' does not exist"
-                )
-                raise
+                msg = "Key 'current_version' does not exist"
+                raise GetVersionError(msg) from None
             if not isinstance(version, str):
-                logger.exception("Failed to get version; `version` is not a string")
-                raise TypeError
+                msg = f"`version` is not a string; got {get_class_name(version)!r}"
+                raise GetVersionError(msg)
             return parse_version(version)
         case never:  # pyright: ignore[reportUnnecessaryComparison]
             assert_never(never)
 
 
+class GetVersionError(Exception): ...
+
+
 def get_toml_path(mode: Mode = DEFAULT_MODE, /) -> Path:
     """Get the path of the TOML file with the version."""
     match mode:
@@ -88,6 +87,11 @@ def get_toml_path(mode: Mode = DEFAULT_MODE, /) -> Path:
             assert_never(never)
 
 
+def run_all(iterator: Iterator[bool], /) -> bool:
+    """Run all of a set of jobs."""
+    return all(list(iterator))
+
+
 def throttled_run[**P](
     name: str,
     run_every: DateTimeDelta | None,
@@ -116,8 +120,14 @@ def throttled_run[**P](
     try:
         return func(*args, **kwargs)
     finally:
-        with writer(path, overwrite=True) as temp:
-            _ = temp.write_text(str(get_now_local()))
+        _ = write_text(path, str(get_now_local()))
+
+
+def write_text(path: Path, text: str, /) -> Literal[False]:
+    """Write text to a file."""
+    with writer(path, overwrite=True) as temp:
+        _ = temp.write_text(text)
+    return False
 
 
 __all__ = [
@@ -126,6 +136,8 @@ __all__ = [
     "get_toml_path",
     "get_version",
     "mode_option",
+    "run_all",
     "run_every_option",
     "throttled_run",
+    "write_text",
 ]

pre_commit_hooks/format_requirements/__init__.py

@@ -13,7 +13,8 @@ from packaging.requirements import (
 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 pre_commit_hooks.common import run_all, write_text
 
 if TYPE_CHECKING:
     from collections.abc import Iterator
@@ -26,18 +27,13 @@ if TYPE_CHECKING:
 @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))  # run all
-    return all(results)
+    return run_all(map(_process, paths))
 
 
 def _process(path: Path, /) -> bool:
     doc = loads(path.read_text())
     expected = _format_path(path)
-    if doc == expected:
-        return True
-    with writer(path, overwrite=True) as temp:
-        _ = temp.write_text(dumps(expected))
-    return False
+    return True if doc == expected else write_text(path, dumps(expected))
 
 
 def _format_path(path: Path, /) -> TOMLDocument:

pre_commit_hooks/mirror_files/__init__.py

@@ -1,14 +1,13 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Literal
+from typing import TYPE_CHECKING
 
 import utilities.click
 from click import argument, command
 from loguru import logger
 from more_itertools import chunked
-from utilities.atomicwrites import writer
 
-from pre_commit_hooks.common import run_every_option, throttled_run
+from pre_commit_hooks.common import run_all, run_every_option, throttled_run, write_text
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -22,16 +21,19 @@ if TYPE_CHECKING:
 @run_every_option
 def main(*, paths: tuple[Path, ...], run_every: DateTimeDelta | None = None) -> bool:
     """CLI for the `format-requirements` hook."""
-    return throttled_run("mirror-files", run_every, _process, paths)
+    try:
+        return throttled_run("mirror-files", run_every, _process, paths)
+    except MirrorFilesError as error:
+        logger.exception("%s", error.args[0])
+        return False
 
 
 def _process(paths: Iterable[Path], /) -> bool:
     paths = list(paths)
     if len(paths) % 2 == 1:
-        logger.exception(f"Expected an even number of paths; got {len(paths)}")
-        raise RuntimeError
-    results = list(map(_process_pair, chunked(paths, 2, strict=True)))  # run all
-    return all(results)
+        msg = f"Expected an even number of paths; got {len(paths)}"
+        raise MirrorFilesError(msg)
+    return run_all(map(_process_pair, chunked(paths, 2, strict=True)))
 
 
 def _process_pair(paths: Iterable[Path], /) -> bool:
@@ -39,19 +41,16 @@ def _process_pair(paths: Iterable[Path], /) -> bool:
     try:
         text_from = path_from.read_text()
     except FileNotFoundError:
-        logger.exception(f"Source file {str(path_from)!r} not found")
-        raise
+        msg = f"Failed to mirror {str(path_from)!r}; path does not exist"
+        raise MirrorFilesError(msg) from None
     try:
         text_to = path_to.read_text()
     except FileNotFoundError:
-        return _write_text(text_from, path_to)
-    return True if text_from == text_to else _write_text(text_from, path_to)
+        return write_text(path_to, text_from)
+    return True if text_from == text_to else write_text(path_to, text_from)
 
 
-def _write_text(text: str, path: Path, /) -> Literal[False]:
-    with writer(path, overwrite=True) as temp:
-        _ = temp.write_text(text)
-    return False
+class MirrorFilesError(Exception): ...
 
 
 __all__ = ["main"]

pre_commit_hooks/replace_sequence_str/__init__.py

@@ -12,6 +12,8 @@ from libcst.matchers import SubscriptElement as MSubscriptElement
 from libcst.matchers import matches
 from libcst.metadata import MetadataWrapper
 
+from pre_commit_hooks.common import run_all
+
 if TYPE_CHECKING:
     from pathlib import Path
 
@@ -20,8 +22,7 @@ if TYPE_CHECKING:
 @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))  # run all
-    return all(results)
+    return run_all(map(_process, paths))
 
 
 def _process(path: Path, /) -> bool:

pre_commit_hooks/run_bump_my_version/__init__.py

@@ -7,6 +7,7 @@ from loguru import logger
 
 from pre_commit_hooks.common import (
     DEFAULT_MODE,
+    GetVersionError,
     Mode,
     get_toml_path,
     get_version,
@@ -18,15 +19,27 @@ from pre_commit_hooks.common import (
 @mode_option
 def main(*, mode: Mode = DEFAULT_MODE) -> bool:
     """CLI for the `run-bump-my-version` hook."""
-    return _process(mode=mode)
+    try:
+        return _process(mode=mode)
+    except RunBumpMyVersionError as error:
+        logger.exception("%s", error.args[0])
+        return False
 
 
 def _process(*, mode: Mode = DEFAULT_MODE) -> bool:
-    current = get_version(mode)
+    try:
+        current = get_version(mode)
+    except GetVersionError as error:
+        msg = f"Failed to bump version; error getting current verison: {error.args[0]}"
+        raise RunBumpMyVersionError(msg) from None
     commit = check_output(["git", "rev-parse", "origin/master"], text=True).rstrip("\n")
     path = get_toml_path(mode)
     contents = check_output(["git", "show", f"{commit}:{path}"], text=True)
-    master = get_version(contents)
+    try:
+        master = get_version(contents)
+    except GetVersionError as error:
+        msg = f"Failed to bump version; error getting master verison: {error.args[0]}"
+        raise RunBumpMyVersionError(msg) from None
     if current in {master.bump_patch(), master.bump_minor(), master.bump_major()}:
         return True
     cmd = [
@@ -39,15 +52,16 @@ def _process(*, mode: Mode = DEFAULT_MODE) -> bool:
     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))
+        msg = f"Failed to bump version; error running `bump-my-version`: {error.stderr.strip()}"
+        raise GetVersionError(msg) from None
     except FileNotFoundError:
-        logger.exception(
-            "Failed to run {cmd!r}. Is `bump-my-version` installed?", cmd=" ".join(cmd)
-        )
+        msg = "Failed to bump version; is `bump-my-version` installed?"
+        raise RunBumpMyVersionError(msg) from None
     else:
         return True
-    return False
+
+
+class RunBumpMyVersionError(Exception): ...
 
 
 __all__ = ["main"]

pre_commit_hooks/tag_commits/__init__.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Literal
 
 import utilities.click
 from click import command, option
@@ -11,10 +11,12 @@ from utilities.whenever import from_timestamp, get_now_local
 
 from pre_commit_hooks.common import (
     DEFAULT_MODE,
+    GetVersionError,
     Mode,
     get_toml_path,
     get_version,
     mode_option,
+    run_all,
     run_every_option,
     throttled_run,
 )
@@ -48,11 +50,11 @@ def _process(
     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 = [
+    results = (
         _process_commit(c, tagged, repo, min_date_time=min_date_time, mode=mode)
         for c in commits
-    ]  # run all
-    return all(results)
+    )
+    return run_all(results)
 
 
 def _process_commit(
@@ -69,35 +71,45 @@ def _process_commit(
     ):
         return True
     try:
-        _tag_commit(commit, repo, mode=mode)
-    except GitCommandError:
+        return _tag_commit(commit, repo, mode=mode)
+    except TagCommitsError as error:
+        logger.exception("%s", error.args[0])
         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, /, *, mode: Mode = DEFAULT_MODE) -> None:
+def _tag_commit(
+    commit: Commit, repo: Repo, /, *, mode: Mode = DEFAULT_MODE
+) -> Literal[True]:
     sha = commit.hexsha[:7]
     date = _get_date_time(commit)
+    desc = f"{sha!r} ({date})"
     path = get_toml_path(mode)
     try:
         joined = commit.tree.join(str(path))
     except KeyError:
-        logger.exception(f"`{str(path)!r}` not found; failed to tag {sha!r} ({date})")
-        return
+        msg = f"Failed to tag {desc}; {str(path)!r} does not exist"
+        raise TagCommitsError(msg) from None
     text = joined.data_stream.read()
-    version = get_version(text)
+    try:
+        version = get_version(text)
+    except GetVersionError as error:
+        msg = f"Failed to tag {desc}; error getting veresion: {error.args[0]}"
+        raise TagCommitsError(msg) from None
     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}...")
+        msg = f"Failed to tag {desc}; error creating tag: {error.stderr.strip()}"
+        raise TagCommitsError(msg) from None
+    logger.info(f"Tagging {desc} as {str(version)!r}...")
     _ = repo.remotes.origin.push(f"refs/tags/{tag.name}")
+    return True
+
+
+class TagCommitsError(Exception): ...
 
 
 __all__ = ["main"]

dycw_pre_commit_hooks-0.12.9.dist-info/RECORD

@@ -1,19 +0,0 @@
-pre_commit_hooks/__init__.py,sha256=_SME_z9OS6vGtaQHag719-IQtmnJ3bfHioDbLCdRoMo,59
-pre_commit_hooks/common.py,sha256=Ovg0kK5CBSBEalGdVxLKjvRX3gbjpzTFRNRopB8tEiw,4247
-pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pre_commit_hooks/check_submodules/__init__.py,sha256=Q9iuPFQvpCJmuHlPbPDzd5zgua3pS0ZBka0JFpNpbOs,1324
-pre_commit_hooks/check_submodules/__main__.py,sha256=foSVebwCfSkKcAc3cD5YTzkmrWd7Wso9_mR9-zuyG-o,153
-pre_commit_hooks/format_requirements/__init__.py,sha256=dORQ5sNZaOWYY6cw0X1YIic4OHZeTt9EhI21D1uQFyE,3322
-pre_commit_hooks/format_requirements/__main__.py,sha256=15JSp_rhjI_Ddoj4MRkHFShfnYxs6GggUhLRlGtrQ0E,156
-pre_commit_hooks/mirror_files/__init__.py,sha256=XUmUYHz4otEF5wIK8X0ntH0vkYFBmJwJfXkI8Bz3n0I,1682
-pre_commit_hooks/mirror_files/__main__.py,sha256=YzOSNKR2XrVST5dgIVJrpRL28QkcziciOomuKtVX7Jo,149
-pre_commit_hooks/replace_sequence_str/__init__.py,sha256=nDjiKV14th2uWbnte1rSvXckysl7ooaLgWo6IP4HI2s,1618
-pre_commit_hooks/replace_sequence_str/__main__.py,sha256=B1dxOxngV4vUVnDVrXSywiySOs1P_zF30_4ZMRsOSaY,157
-pre_commit_hooks/run_bump_my_version/__init__.py,sha256=OsMY0boz3VTqAtgLCHtC8AvCXx6OYvOXA5H-VAwBFoY,1444
-pre_commit_hooks/run_bump_my_version/__main__.py,sha256=w2V3y61jrSau-zxjl8ciHtWPlJQwXbYxNJ2tGYVyI4s,156
-pre_commit_hooks/tag_commits/__init__.py,sha256=097p0gfZcykpOPUgGYsrLePe8Nar04eKlCMn_mqPepg,2945
-pre_commit_hooks/tag_commits/__main__.py,sha256=qefgYw7LWbvmzZS45-ym6olS4cHqw1Emw2wlqZBXN_o,148
-dycw_pre_commit_hooks-0.12.9.dist-info/METADATA,sha256=4FTUextZ5Ocnpgfdr1papnRJS4QvgpP6lOeg-TSpeEY,1105
-dycw_pre_commit_hooks-0.12.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_pre_commit_hooks-0.12.9.dist-info/entry_points.txt,sha256=0xGzim6HTjeOXJpusYjBk0aEYkXQR2IwrmfzM6KT_r0,368
-dycw_pre_commit_hooks-0.12.9.dist-info/RECORD,,

pre_commit_hooks/check_submodules/__init__.py

@@ -1,57 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-import utilities.click
-from click import argument, command
-from git import Repo, Submodule
-
-from pre_commit_hooks.common import (
-    DEFAULT_MODE,
-    Mode,
-    get_toml_path,
-    get_version,
-    mode_option,
-    run_every_option,
-    throttled_run,
-)
-
-if TYPE_CHECKING:
-    from pathlib import Path
-
-    from whenever import DateTimeDelta
-
-
-@command()
-@argument("paths", nargs=-1, type=utilities.click.Path())
-@run_every_option
-def main(*, paths: tuple[Path, ...], run_every: DateTimeDelta | None = None) -> bool:
-    """CLI for the `check-submodules` hook."""
-    results = [
-        throttled_run("check-submodules", run_every, _process, p) for p in paths
-    ]  # run all
-    return all(results)
-
-
-def _process(path: Path, /) -> bool:
-    repo = Repo(path, search_parent_directories=True)
-    results = [_process_submodule(s) for s in repo.submodules]  # run all
-    return all(results)
-
-
-def _process_submodule(submodule: Submodule, /) -> bool:
-    repo = submodule.module()
-    _ = repo.remotes.origin.fetch()
-    local = repo.commit("master")
-    remote = repo.commit("origin/master")
-    return local.hexsha == remote.hexsha
-
-
-__all__ = [
-    "DEFAULT_MODE",
-    "Mode",
-    "get_toml_path",
-    "get_version",
-    "main",
-    "mode_option",
-]

pre_commit_hooks/check_submodules/__main__.py

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