dycw-pre-commit-hooks 0.12.8__py3-none-any.whl → 0.14.26__py3-none-any.whl

pre_commit_hooks/hooks/add_hooks.py

@@ -0,0 +1,373 @@
+from __future__ import annotations
+
+from functools import partial
+from itertools import chain
+from typing import TYPE_CHECKING
+
+from click import command, option
+from utilities.click import CONTEXT_SETTINGS
+from utilities.os import is_pytest
+
+from pre_commit_hooks.constants import (
+    BUILTIN,
+    DEFAULT_PYTHON_VERSION,
+    DYCW_PRE_COMMIT_HOOKS_URL,
+    PRE_COMMIT_CONFIG_YAML,
+    PYPROJECT_TOML,
+    RUFF_URL,
+    STD_PRE_COMMIT_HOOKS_URL,
+    paths_argument,
+    python_version_option,
+)
+from pre_commit_hooks.utilities import add_pre_commit_config_repo, run_all_maybe_raise
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+@option("--python", is_flag=True, default=False)
+@python_version_option
+def _main(
+    *,
+    paths: tuple[Path, ...],
+    python: bool = False,
+    python_version: str = DEFAULT_PYTHON_VERSION,
+) -> None:
+    if is_pytest():
+        return
+    funcs: list[Callable[[], bool]] = list(
+        chain(
+            (partial(_add_check_versions_consistent, path=p) for p in paths),
+            (partial(_add_format_pre_commit_config, path=p) for p in paths),
+            (partial(_add_run_prek_autoupdate, path=p) for p in paths),
+            (partial(_add_run_version_bump, path=p) for p in paths),
+            (partial(_add_standard_hooks, path=p) for p in paths),
+        )
+    )
+    if python:
+        funcs.extend(partial(_add_add_future_import_annotations, path=p) for p in paths)
+        funcs.extend(partial(_add_format_requirements, path=p) for p in paths)
+        funcs.extend(partial(_add_replace_sequence_str, path=p) for p in paths)
+        funcs.extend(partial(_add_ruff_check, path=p) for p in paths)
+        funcs.extend(partial(_add_ruff_format, path=p) for p in paths)
+        funcs.extend(partial(_add_setup_git, path=p) for p in paths)
+        funcs.extend(
+            partial(_add_setup_pyright, path=p, python_version=python_version)
+            for p in paths
+        )
+        funcs.extend(
+            partial(_add_setup_ruff, path=p, python_version=python_version)
+            for p in paths
+        )
+        funcs.extend(partial(_add_update_requirements, path=p) for p in paths)
+    run_all_maybe_raise(*funcs)
+
+
+def _add_check_versions_consistent(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "check-versions-consistent",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    return len(modifications) == 0
+
+
+def _add_format_pre_commit_config(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "format-pre-commit-config",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    return len(modifications) == 0
+
+
+def _add_run_prek_autoupdate(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "run-prek-autoupdate",
+        path=path,
+        modifications=modifications,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_run_version_bump(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "run-version-bump",
+        path=path,
+        modifications=modifications,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_standard_hooks(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "check-added-large-files",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "check-case-conflict",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "check-executables-have-shebangs",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN, "check-json", path=path, modifications=modifications, type_="linter"
+    )
+    add_pre_commit_config_repo(
+        BUILTIN, "check-json5", path=path, modifications=modifications, type_="linter"
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "check-merge-conflict",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "check-symlinks",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN, "check-toml", path=path, modifications=modifications, type_="linter"
+    )
+    add_pre_commit_config_repo(
+        BUILTIN, "check-xml", path=path, modifications=modifications, type_="linter"
+    )
+    add_pre_commit_config_repo(
+        BUILTIN, "check-yaml", path=path, modifications=modifications, type_="linter"
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "detect-private-key",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "end-of-file-fixer",
+        path=path,
+        modifications=modifications,
+        type_="formatter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "fix-byte-order-marker",
+        path=path,
+        modifications=modifications,
+        type_="formatter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "mixed-line-ending",
+        path=path,
+        modifications=modifications,
+        args=("add", ["--fix=lf"]),
+        type_="formatter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "no-commit-to-branch",
+        path=path,
+        modifications=modifications,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        BUILTIN,
+        "trailing-whitespace",
+        path=path,
+        modifications=modifications,
+        type_="formatter",
+    )
+    add_pre_commit_config_repo(
+        STD_PRE_COMMIT_HOOKS_URL,
+        "check-illegal-windows-names",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        STD_PRE_COMMIT_HOOKS_URL,
+        "destroyed-symlinks",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="linter",
+    )
+    add_pre_commit_config_repo(
+        STD_PRE_COMMIT_HOOKS_URL,
+        "pretty-format-json",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        args=("add", ["--autofix"]),
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_add_future_import_annotations(
+    *, path: PathLike = PRE_COMMIT_CONFIG_YAML
+) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "add-future-import-annotations",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_format_requirements(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "format-requirements",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_replace_sequence_str(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "replace-sequence-str",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_ruff_check(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        RUFF_URL,
+        "ruff-check",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        args=("exact", ["--fix"]),
+        type_="linter",
+    )
+    return len(modifications) == 0
+
+
+def _add_ruff_format(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        RUFF_URL,
+        "ruff-format",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_setup_git(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "setup-git",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_setup_pyright(
+    *,
+    path: PathLike = PRE_COMMIT_CONFIG_YAML,
+    python_version: str = DEFAULT_PYTHON_VERSION,
+) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "setup-pyright",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        args=("exact", [f"--python-version={python_version}"]),
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_setup_ruff(
+    *,
+    path: PathLike = PRE_COMMIT_CONFIG_YAML,
+    python_version: str = DEFAULT_PYTHON_VERSION,
+) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "setup-ruff",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        args=("exact", [f"--python-version={python_version}"]),
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+def _add_update_requirements(*, path: PathLike = PYPROJECT_TOML) -> bool:
+    modifications: set[Path] = set()
+    add_pre_commit_config_repo(
+        DYCW_PRE_COMMIT_HOOKS_URL,
+        "update-requirements",
+        path=path,
+        modifications=modifications,
+        rev=True,
+        type_="formatter",
+    )
+    return len(modifications) == 0
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/check_versions_consistent.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+from functools import partial
+from subprocess import CalledProcessError
+from typing import TYPE_CHECKING
+
+from click import command
+from utilities.click import CONTEXT_SETTINGS
+from utilities.os import is_pytest
+
+from pre_commit_hooks.constants import BUMPVERSION_TOML, paths_argument
+from pre_commit_hooks.utilities import (
+    get_version_from_path,
+    run_all_maybe_raise,
+    run_bump_my_version,
+)
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+def _main(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    run_all_maybe_raise(*(partial(_run, path=p) for p in paths))
+
+
+def _run(*, path: PathLike = BUMPVERSION_TOML) -> bool:
+    version = get_version_from_path(path=path)
+    try:
+        run_bump_my_version(version, path=path)
+    except CalledProcessError:
+        return False
+    return True
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/format_pre_commit_config.py

@@ -0,0 +1,70 @@
+from __future__ import annotations
+
+from contextlib import suppress
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click import command
+from utilities.click import CONTEXT_SETTINGS
+from utilities.os import is_pytest
+from utilities.types import PathLike
+
+from pre_commit_hooks.constants import (
+    PRE_COMMIT_CONFIG_HOOK_KEYS,
+    PRE_COMMIT_CONFIG_REPO_KEYS,
+    PRE_COMMIT_CONFIG_YAML,
+    PRE_COMMIT_HOOKS_HOOK_KEYS,
+    paths_argument,
+)
+from pre_commit_hooks.utilities import (
+    get_list_dicts,
+    run_all_maybe_raise,
+    yield_yaml_dict,
+)
+
+if TYPE_CHECKING:
+    from utilities.types import PathLike, StrDict, StrMapping
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+def _main(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    run_all_maybe_raise(*(partial(_run, path=p) for p in paths))
+
+
+def _run(*, path: PathLike = PRE_COMMIT_CONFIG_YAML) -> bool:
+    path = Path(path)
+    current = path.read_text()
+    with yield_yaml_dict(path, sort_keys=False) as dict_:
+        repos_list = get_list_dicts(dict_, "repos")
+        repos_list.sort(key=_sort_key)
+        for repo_dict in repos_list:
+            _re_insert(repo_dict, PRE_COMMIT_CONFIG_REPO_KEYS)
+            hooks_list = get_list_dicts(repo_dict, "hooks")
+            hooks_list.sort(key=lambda x: x["id"])
+            if repo_dict["repo"] == "local":
+                keys = PRE_COMMIT_HOOKS_HOOK_KEYS
+            else:
+                keys = PRE_COMMIT_CONFIG_HOOK_KEYS
+            for hook_dict in hooks_list:
+                _re_insert(hook_dict, keys)
+    return path.read_text() == current
+
+
+def _re_insert(dict_: StrDict, keys: list[str], /) -> None:
+    copy = dict_.copy()
+    dict_.clear()
+    for key in keys:
+        with suppress(KeyError):
+            dict_[key] = copy[key]
+
+
+def _sort_key(mapping: StrMapping, /) -> tuple[str, str]:
+    return mapping["repo"], mapping.get("rev", "")
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/format_requirements.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click import command
+from tomlkit import string
+from tomlkit.items import Array
+from utilities.click import CONTEXT_SETTINGS
+from utilities.functions import ensure_str
+from utilities.os import is_pytest
+from utilities.packaging import Requirement
+from utilities.types import PathLike
+
+from pre_commit_hooks.constants import PYPROJECT_TOML, paths_argument
+from pre_commit_hooks.utilities import (
+    get_pyproject_dependencies,
+    run_all_maybe_raise,
+    yield_toml_doc,
+)
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from tomlkit.items import Array
+    from utilities.types import PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+def _main(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    run_all_maybe_raise(*(partial(_run, path=p) for p in paths))
+
+
+def _run(*, path: PathLike = PYPROJECT_TOML) -> bool:
+    modifications: set[Path] = set()
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        get_pyproject_dependencies(doc).map_array(_transform)
+    return len(modifications) == 0
+
+
+def _transform(array: Array, /) -> None:
+    new: list[str] = []
+    for curr_i in array:
+        req = Requirement(ensure_str(curr_i))
+        new.append(str(req))
+    array.clear()
+    for new_i in sorted(new):
+        array.append(string(new_i))
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/{replace_sequence_str/__init__.py → hooks/replace_sequence_str.py}

@@ -1,38 +1,43 @@
 from __future__ import annotations
 
+from functools import partial
 from typing import TYPE_CHECKING, override
 
-import utilities.click
-from click import argument, command
-from libcst import CSTTransformer, Name, Subscript, parse_module
+from click import command
+from libcst import CSTTransformer, Name, Subscript
 from libcst.matchers import Index as MIndex
 from libcst.matchers import Name as MName
 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 CONTEXT_SETTINGS
+from utilities.os import is_pytest
+
+from pre_commit_hooks.constants import paths_argument
+from pre_commit_hooks.utilities import run_all_maybe_raise, yield_python_file
 
 if TYPE_CHECKING:
     from pathlib import Path
 
+    from utilities.types import PathLike
+
 
-@command()
-@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)
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+def _main(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    run_all_maybe_raise(*(partial(_run, p) for p in paths))
 
 
-def _process(path: Path, /) -> bool:
-    existing = path.read_text()
-    wrapper = MetadataWrapper(parse_module(existing))
-    transformed = wrapper.module.visit(SequenceToListTransformer())
-    new = transformed.code
-    if existing == new:
-        return True
-    _ = path.write_text(new)
-    return False
+def _run(path: PathLike, /) -> bool:
+    modifications: set[Path] = set()
+    with yield_python_file(path, modifications=modifications) as context:
+        context.output = MetadataWrapper(context.input).module.visit(
+            SequenceToListTransformer()
+        )
+    return len(modifications) == 0
 
 
 class SequenceToListTransformer(CSTTransformer):
@@ -52,4 +57,5 @@ class SequenceToListTransformer(CSTTransformer):
         return updated_node
 
 
-__all__ = ["main"]
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/run_prek_autoupdate.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click import command
+from utilities.click import CONTEXT_SETTINGS
+from utilities.os import is_pytest
+from utilities.subprocess import run
+from utilities.throttle import throttle
+
+from pre_commit_hooks.constants import (
+    PRE_COMMIT_CONFIG_YAML,
+    THROTTLE_DURATION,
+    paths_argument,
+    throttle_option,
+)
+from pre_commit_hooks.utilities import path_throttle_cache, run_all_maybe_raise
+
+if TYPE_CHECKING:
+    from collections.abc import MutableSet
+    from pathlib import Path
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+@throttle_option
+def _main(*, paths: tuple[Path, ...], throttle: bool = True) -> None:
+    if is_pytest():
+        return
+    if len(paths) >= 1:
+        run_all_maybe_raise(partial(_run, throttle=throttle))
+
+
+def _run(*, throttle: bool = False) -> bool:
+    modifications: set[Path] = set()
+    func = _run_throttled if throttle else _run_unthrottled
+    func(modifications=modifications)
+    return len(modifications) == 0
+
+
+def _run_unthrottled(*, modifications: MutableSet[Path] | None = None) -> None:
+    current = PRE_COMMIT_CONFIG_YAML.read_text()
+    run("prek", "autoupdate")
+    if (modifications is not None) and (PRE_COMMIT_CONFIG_YAML.read_text() != current):
+        modifications.add(PRE_COMMIT_CONFIG_YAML)
+
+
+_run_throttled = throttle(
+    duration=THROTTLE_DURATION, path=path_throttle_cache("run-prek-autoupdate")
+)(_run_unthrottled)
+
+
+if __name__ == "__main__":
+    _main()