dycw-pre-commit-hooks 0.12.4__py3-none-any.whl → 0.12.5__py3-none-any.whl

{dycw_pre_commit_hooks-0.12.4.dist-info → dycw_pre_commit_hooks-0.12.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-pre-commit-hooks
-Version: 0.12.4
+Version: 0.12.5
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Python: >=3.12
 Requires-Dist: click<8.3,>=8.2.1
@@ -31,6 +31,7 @@ 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: replace-sequence-str
          - id: run-bump-my-version

dycw_pre_commit_hooks-0.12.5.dist-info/RECORD

@@ -0,0 +1,17 @@
+pre_commit_hooks/__init__.py,sha256=F3qvvaYWO9UbSdbCiBLQFrc_LvSR0D1M5LVTfyR9LV8,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=8aJ6sbDclOML5uahK4TNf80Sxf6gCx1kIOYwkv37g9s,1092
+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/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.5.dist-info/METADATA,sha256=d0hMyN0LUeu1JKiAOrSzd91hc-iWSAqD5KnUKrdi1Xk,1061
+dycw_pre_commit_hooks-0.12.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_pre_commit_hooks-0.12.5.dist-info/entry_points.txt,sha256=LqAiEwyqmkYt_sdzcFYgmDZ1Y6exFIwoVWWl8a0vVjU,318
+dycw_pre_commit_hooks-0.12.5.dist-info/RECORD,,

{dycw_pre_commit_hooks-0.12.4.dist-info → dycw_pre_commit_hooks-0.12.5.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+check-submodules = pre_commit_hooks.check_submodules:main
 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

pre_commit_hooks/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.12.4"
+__version__ = "0.12.5"

pre_commit_hooks/check_submodules/__init__.py

@@ -0,0 +1,50 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from click import 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 whenever import DateTimeDelta
+
+
+@command()
+@run_every_option
+def main(*, run_every: DateTimeDelta | None = None) -> bool:
+    """CLI for the `check-submodules` hook."""
+    return throttled_run("check-submodules", run_every, _process)
+
+
+def _process() -> bool:
+    repo = Repo(".", 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

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

pre_commit_hooks/common.py

@@ -1,14 +1,25 @@
 from __future__ import annotations
 
 from pathlib import Path
-from typing import Literal, assert_never
+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.hashlib import md5_hash
+from utilities.pathlib import get_repo_root
 from utilities.typing import get_literal_elements
 from utilities.version import Version, parse_version
+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 whenever import DateTimeDelta
 
 type Mode = Literal["pyproject", "bumpversion"]
 DEFAULT_MODE: Mode = "pyproject"
@@ -18,6 +29,9 @@ mode_option = option(
     default=DEFAULT_MODE,
     show_default=True,
 )
+run_every_option = option(
+    "--run-every", type=utilities.click.DateTimeDelta(), default=None, show_default=True
+)
 
 
 def get_version(source: Mode | Path | str | bytes | TOMLDocument, /) -> Version:
@@ -64,6 +78,7 @@ def get_version(source: Mode | Path | str | bytes | TOMLDocument, /) -> Version:
 
 
 def get_toml_path(mode: Mode = DEFAULT_MODE, /) -> Path:
+    """Get the path of the TOML file with the version."""
     match mode:
         case "pyproject":
             return Path("pyproject.toml")
@@ -73,4 +88,44 @@ def get_toml_path(mode: Mode = DEFAULT_MODE, /) -> Path:
             assert_never(never)
 
 
-__all__ = ["DEFAULT_MODE", "Mode", "get_toml_path", "get_version", "mode_option"]
+def throttled_run[**P](
+    name: str,
+    run_every: DateTimeDelta | None,
+    func: Callable[P, bool],
+    /,
+    *args: P.args,
+    **kwargs: P.kwargs,
+) -> bool:
+    """Throttled run."""
+    hash_ = md5_hash(get_repo_root())
+    path = xdg_cache_home().joinpath(name, hash_)
+    if run_every is not None:
+        min_date_time = get_now_local() - run_every
+        try:
+            text = path.read_text()
+        except FileNotFoundError:
+            pass
+        else:
+            try:
+                last_run = to_zoned_date_time(text.strip("\n"))
+            except ValueError:
+                pass
+            else:
+                if min_date_time <= last_run:
+                    return True
+    try:
+        return func(*args, **kwargs)
+    finally:
+        with writer(path, overwrite=True) as temp:
+            _ = temp.write_text(str(get_now_local()))
+
+
+__all__ = [
+    "DEFAULT_MODE",
+    "Mode",
+    "get_toml_path",
+    "get_version",
+    "mode_option",
+    "run_every_option",
+    "throttled_run",
+]

pre_commit_hooks/format_requirements/__init__.py

@@ -25,7 +25,7 @@ if TYPE_CHECKING:
 @command()
 @argument("paths", nargs=-1, type=utilities.click.Path())
 def main(*, paths: tuple[Path, ...]) -> bool:
-    """CLI for the `format_requirements` hook."""
+    """CLI for the `format-requirements` hook."""
     results = list(map(_process, paths))  # run all
     return all(results)
 

pre_commit_hooks/replace_sequence_str/__init__.py

@@ -19,7 +19,7 @@ if TYPE_CHECKING:
 @command()
 @argument("paths", nargs=-1, type=utilities.click.Path())
 def main(*, paths: tuple[Path, ...]) -> bool:
-    """CLI for the `replace_sequence_str` hook."""
+    """CLI for the `replace-sequence-str` hook."""
     results = list(map(_process, paths))  # run all
     return all(results)
 

pre_commit_hooks/run_bump_my_version/__init__.py

@@ -17,7 +17,7 @@ from pre_commit_hooks.common import (
 @command()
 @mode_option
 def main(*, mode: Mode = DEFAULT_MODE) -> bool:
-    """CLI for the `run_bump_my_version` hook."""
+    """CLI for the `run-bump-my-version` hook."""
     return _process(mode=mode)
 
 

pre_commit_hooks/tag_commits/__init__.py

@@ -6,12 +6,8 @@ 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 (
     DEFAULT_MODE,
@@ -19,67 +15,33 @@ from pre_commit_hooks.common import (
     get_toml_path,
     get_version,
     mode_option,
+    run_every_option,
+    throttled_run,
 )
 
 if TYPE_CHECKING:
     from collections.abc import Set as AbstractSet
 
-_RUN_EVERY: DateTimeDelta | None = None
-_MAX_AGE: DateTimeDelta | None = None
+    from whenever import DateTimeDelta, ZonedDateTime
 
 
 @command()
+@run_every_option
 @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,
+    "--max-age", type=utilities.click.DateTimeDelta(), default=None, show_default=True
 )
 @mode_option
 def main(
     *,
-    run_every: DateTimeDelta | None = _RUN_EVERY,
-    max_age: DateTimeDelta | None = _MAX_AGE,
+    run_every: DateTimeDelta | None = None,
+    max_age: DateTimeDelta | None = None,
     mode: Mode = DEFAULT_MODE,
 ) -> bool:
-    """CLI for the `tag_commits` hook."""
-    return _process(run_every=run_every, max_age=max_age, mode=mode)
+    """CLI for the `tag-commits` hook."""
+    return throttled_run("tag-commits", run_every, _process, max_age=max_age, mode=mode)
 
 
 def _process(
-    *,
-    run_every: DateTimeDelta | None = _RUN_EVERY,
-    max_age: DateTimeDelta | None = _MAX_AGE,
-    mode: Mode = DEFAULT_MODE,
-) -> 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, mode=mode)
-
-
-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, mode: Mode = DEFAULT_MODE
 ) -> bool:
     repo = Repo(".", search_parent_directories=True)

dycw_pre_commit_hooks-0.12.4.dist-info/RECORD

@@ -1,15 +0,0 @@
-pre_commit_hooks/__init__.py,sha256=Ul915aXNCIEUqkW77kaJBYxPvo2kTfIB8Fya_1sVCTM,59
-pre_commit_hooks/common.py,sha256=LW6OatA5KzfhqnITJq9s1MzNw5t-0zFPqoPW-2VyRm8,2764
-pre_commit_hooks/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pre_commit_hooks/format_requirements/__init__.py,sha256=zcvOH839MHGxVNvbBt4KZKDW2MXdtnu6OuxP6P0IqL4,3322
-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=alaQx34H_pUfJypv9f0UmXIb3Ht3YS29pxcfodVtaTM,1444
-pre_commit_hooks/run_bump_my_version/__main__.py,sha256=w2V3y61jrSau-zxjl8ciHtWPlJQwXbYxNJ2tGYVyI4s,156
-pre_commit_hooks/tag_commits/__init__.py,sha256=E9aOurHbD_K3zr8YgBQkiIJo05d2BMUZdecqzz92iJo,3982
-pre_commit_hooks/tag_commits/__main__.py,sha256=qefgYw7LWbvmzZS45-ym6olS4cHqw1Emw2wlqZBXN_o,148
-dycw_pre_commit_hooks-0.12.4.dist-info/METADATA,sha256=u20WYX8Q-rs4RXZ1JugnG7rfxYovjpfRpGhn4nhPCAs,1029
-dycw_pre_commit_hooks-0.12.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_pre_commit_hooks-0.12.4.dist-info/entry_points.txt,sha256=r1tnPzaGvOrSdX-ZRriidf8AhZgUtXfjdTpwpkTBA8U,260
-dycw_pre_commit_hooks-0.12.4.dist-info/RECORD,,