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

pre_commit_hooks/hooks/setup_coverage.py

@@ -0,0 +1,58 @@
+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.types import PathLike
+
+from pre_commit_hooks.constants import COVERAGERC_TOML, paths_argument
+from pre_commit_hooks.utilities import (
+    ensure_contains,
+    get_set_array,
+    get_set_table,
+    run_all_maybe_raise,
+    yield_toml_doc,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+def _main(*, paths: tuple[Path, ...]) -> None:
+    if is_pytest():
+        return
+    funcs: list[Callable[[], bool]] = [
+        partial(_run, path=p.parent / COVERAGERC_TOML) for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
+
+
+def _run(*, path: PathLike = COVERAGERC_TOML) -> bool:
+    modifications: set[Path] = set()
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        html = get_set_table(doc, "html")
+        html["directory"] = ".coverage/html"
+        report = get_set_table(doc, "report")
+        exclude_also = get_set_array(report, "exclude_also")
+        ensure_contains(exclude_also, "@overload", "if TYPE_CHECKING:")
+        report["fail_under"] = 100.0
+        report["skip_covered"] = True
+        report["skip_empty"] = True
+        run = get_set_table(doc, "run")
+        run["branch"] = True
+        run["data_file"] = ".coverage/data"
+        run["parallel"] = True
+    return len(modifications) == 0
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/setup_direnv.py

@@ -0,0 +1,144 @@
+from __future__ import annotations
+
+from functools import partial
+from pathlib import Path
+from re import MULTILINE, escape, search
+from typing import TYPE_CHECKING
+
+from click import command
+from utilities.click import CONTEXT_SETTINGS
+from utilities.iterables import always_iterable
+from utilities.os import is_pytest
+from utilities.text import strip_and_dedent
+from utilities.types import PathLike
+
+from pre_commit_hooks.constants import (
+    DEFAULT_PYTHON_VERSION,
+    ENVRC,
+    paths_argument,
+    python_option,
+    python_uv_index_option,
+    python_uv_native_tls_option,
+    python_version_option,
+)
+from pre_commit_hooks.utilities import run_all_maybe_raise, yield_text_file
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, MutableSet
+    from pathlib import Path
+
+    from utilities.types import MaybeSequenceStr, PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+@python_option
+@python_uv_index_option
+@python_uv_native_tls_option
+@python_version_option
+def _main(
+    *,
+    paths: tuple[Path, ...],
+    python: bool = False,
+    python_uv_index: MaybeSequenceStr | None = None,
+    python_uv_native_tls: bool = False,
+    python_version: str = DEFAULT_PYTHON_VERSION,
+) -> None:
+    if is_pytest():
+        return
+    funcs: list[Callable[[], bool]] = [
+        partial(
+            _run,
+            path=p.parent / ENVRC,
+            python=python,
+            python_uv_index=python_uv_index,
+            python_uv_native_tls=python_uv_native_tls,
+            python_version=python_version,
+        )
+        for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
+
+
+def _run(
+    *,
+    path: PathLike = ENVRC,
+    python: bool = False,
+    python_uv_index: MaybeSequenceStr | None = None,
+    python_uv_native_tls: bool = False,
+    python_version: str = DEFAULT_PYTHON_VERSION,
+) -> bool:
+    modifications: set[Path] = set()
+    with yield_text_file(path, modifications=modifications) as context:
+        text = strip_and_dedent("""
+            #!/usr/bin/env sh
+            # shellcheck source=/dev/null
+
+            # echo
+            echo_date() { echo "[$(date +'%Y-%m-%d %H:%M:%S')] $*" >&2; }
+        """)
+        if search(escape(text), context.output, flags=MULTILINE) is None:
+            context.output += f"\n\n{text}"
+    if python:
+        _add_python(
+            path=path,
+            modifications=modifications,
+            uv_index=python_uv_index,
+            uv_native_tls=python_uv_native_tls,
+            version=python_version,
+        )
+    return len(modifications) == 0
+
+
+def _add_python(
+    *,
+    path: PathLike = ENVRC,
+    modifications: MutableSet[Path] | None = None,
+    uv_index: MaybeSequenceStr | None = None,
+    uv_native_tls: bool = False,
+    version: str = DEFAULT_PYTHON_VERSION,
+) -> None:
+    with yield_text_file(path, modifications=modifications) as context:
+        text = _get_text(
+            uv_index=uv_index, uv_native_tls=uv_native_tls, version=version
+        )
+        if search(escape(text), context.output, flags=MULTILINE) is None:
+            context.output += f"\n\n{text}"
+
+
+def _get_text(
+    *,
+    uv_index: MaybeSequenceStr | None = None,
+    uv_native_tls: bool = False,
+    version: str = DEFAULT_PYTHON_VERSION,
+) -> str:
+    lines: list[str] = ["# uv", "export UV_MANAGED_PYTHON='true'"]
+    if uv_index is not None:
+        lines.append(f"export UV_INDEX='{','.join(always_iterable(uv_index))}'")
+    if uv_native_tls:
+        lines.append("export UV_NATIVE_TLS='true'")
+    lines.extend([
+        "export UV_PRERELEASE='disallow'",
+        f"export UV_PYTHON='{version}'",
+        "export UV_RESOLUTION='highest'",
+        "export UV_VENV_CLEAR=1",
+        strip_and_dedent("""\
+            if ! command -v uv >/dev/null 2>&1; then
+            \techo_date "ERROR: 'uv' not found" && exit 1
+            fi
+        """),
+        "activate='.venv/bin/activate'",
+        strip_and_dedent("""\
+            if [ -f $activate ]; then
+            \t. $activate
+            else
+            \tuv venv
+            fi
+        """),
+        "uv sync --all-extras --all-groups --active --locked",
+    ])
+    return "\n".join(lines) + "\n"
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/setup_pyproject.py

@@ -0,0 +1,179 @@
+from __future__ import annotations
+
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click import command
+from tomlkit import table
+from utilities.click import CONTEXT_SETTINGS
+from utilities.iterables import always_iterable
+from utilities.os import is_pytest
+from utilities.text import kebab_case, snake_case
+
+from pre_commit_hooks.constants import (
+    DEFAULT_PYTHON_VERSION,
+    PYPROJECT_TOML,
+    README_MD,
+    description_option,
+    paths_argument,
+    python_package_name_external_option,
+    python_package_name_internal_option,
+    python_uv_index_option,
+    python_version_option,
+)
+from pre_commit_hooks.utilities import (
+    ensure_contains,
+    ensure_contains_partial_str,
+    get_set_aot,
+    get_set_array,
+    get_set_table,
+    get_table,
+    run_all_maybe_raise,
+    yield_toml_doc,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, MutableSet
+
+    from tomlkit import TOMLDocument
+    from tomlkit.items import Table
+    from utilities.types import MaybeSequenceStr, PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+@python_version_option
+@description_option
+@python_package_name_external_option
+@python_package_name_internal_option
+@python_uv_index_option
+def _main(
+    *,
+    paths: tuple[Path, ...],
+    python_version: str = DEFAULT_PYTHON_VERSION,
+    description: str | None = None,
+    python_package_name_external: str | None = None,
+    python_package_name_internal: str | None = None,
+    python_uv_index: MaybeSequenceStr | None = None,
+) -> None:
+    if is_pytest():
+        return
+    funcs: list[Callable[[], bool]] = [
+        partial(
+            _run,
+            path=p.parent / PYPROJECT_TOML,
+            python_version=python_version,
+            description=description,
+            python_package_name_external=python_package_name_external,
+            python_package_name_internal=python_package_name_internal,
+            python_uv_index=python_uv_index,
+        )
+        for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
+
+
+def _run(
+    *,
+    path: PathLike = PYPROJECT_TOML,
+    python_version: str = DEFAULT_PYTHON_VERSION,
+    description: str | None = None,
+    python_package_name_external: str | None = None,
+    python_package_name_internal: str | None = None,
+    python_uv_index: MaybeSequenceStr | None = None,
+) -> bool:
+    path = Path(path)
+    modifications: set[Path] = set()
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        build_system = get_set_table(doc, "build-system")
+        build_system["build-backend"] = "uv_build"
+        build_system["requires"] = ["uv_build"]
+        project = get_set_table(doc, "project")
+        project["readme"] = str(path.parent / README_MD)
+        project["requires-python"] = f">= {python_version}"
+        project.setdefault("version", "0.1.0")
+        dependency_groups = get_set_table(doc, "dependency-groups")
+        dev = get_set_array(dependency_groups, "dev")
+        _ = ensure_contains_partial_str(dev, "dycw-utilities[test]")
+        _ = ensure_contains_partial_str(dev, "pyright")
+        _ = ensure_contains_partial_str(dev, "rich")
+    if description is not None:
+        _add_description(description, path=path, modifications=modifications)
+    if python_package_name_external is not None:
+        _add_external_name(
+            python_package_name_external, path=path, modifications=modifications
+        )
+    if python_package_name_internal is not None:
+        _add_internal_name(
+            python_package_name_internal, path=path, modifications=modifications
+        )
+    if python_uv_index is not None:
+        for name_and_url in always_iterable(python_uv_index):
+            _add_index(name_and_url, path=path, modifications=modifications)
+    return len(modifications) == 0
+
+
+def _add_description(
+    description: str,
+    /,
+    *,
+    path: PathLike = PYPROJECT_TOML,
+    modifications: MutableSet[Path] | None = None,
+) -> None:
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        project = get_table(doc, "project")
+        project["description"] = description
+
+
+def _add_external_name(
+    name: str,
+    /,
+    *,
+    path: PathLike = PYPROJECT_TOML,
+    modifications: MutableSet[Path] | None = None,
+) -> None:
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        project = get_table(doc, "project")
+        project["name"] = kebab_case(name)
+
+
+def _add_internal_name(
+    name: str,
+    /,
+    *,
+    path: PathLike = PYPROJECT_TOML,
+    modifications: MutableSet[Path] | None = None,
+) -> None:
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        uv = _get_tool_uv(doc)
+        build_backend = get_set_table(uv, "build-backend")
+        build_backend["module-name"] = snake_case(name)
+        build_backend["module-root"] = "src"
+
+
+def _add_index(
+    name_and_url: str,
+    /,
+    *,
+    path: PathLike = PYPROJECT_TOML,
+    modifications: MutableSet[Path] | None = None,
+) -> None:
+    with yield_toml_doc(path, modifications=modifications) as doc:
+        uv = _get_tool_uv(doc)
+        indexes = get_set_aot(uv, "index")
+        tab = table()
+        tab["explicit"] = True
+        name, url = name_and_url
+        tab["name"] = name
+        tab["url"] = url
+        ensure_contains(indexes, tab)
+
+
+def _get_tool_uv(doc: TOMLDocument, /) -> Table:
+    tool = get_set_table(doc, "tool")
+    return get_set_table(tool, "uv")
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/setup_pyright.py

@@ -21,6 +21,7 @@ from pre_commit_hooks.utilities import (
 )
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
     from pathlib import Path
 
     from utilities.types import PathLike
@@ -34,14 +35,11 @@ def _main(
 ) -> None:
     if is_pytest():
         return
-    run_all_maybe_raise(
-        *(
-            partial(
-                _run, path=p.parent / PYRIGHTCONFIG_JSON, python_version=python_version
-            )
-            for p in paths
-        )
-    )
+    funcs: list[Callable[[], bool]] = [
+        partial(_run, path=p.parent / PYRIGHTCONFIG_JSON, python_version=python_version)
+        for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
 
 
 def _run(

pre_commit_hooks/hooks/setup_readme.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from functools import partial
+from re import MULTILINE, escape, search
+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 (
+    README_MD,
+    description_option,
+    paths_argument,
+    repo_name_option,
+)
+from pre_commit_hooks.utilities import run_all_maybe_raise, yield_text_file
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, MutableSet
+    from pathlib import Path
+
+    from utilities.types import PathLike
+
+
+@command(**CONTEXT_SETTINGS)
+@paths_argument
+@repo_name_option
+@description_option
+def _main(
+    *,
+    paths: tuple[Path, ...],
+    repo_name: str | None = None,
+    description: str | None = None,
+) -> None:
+    if is_pytest():
+        return
+    funcs: list[Callable[[], bool]] = [
+        partial(
+            _run,
+            path=p.parent / README_MD,
+            repo_name=repo_name,
+            description=description,
+        )
+        for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
+
+
+def _run(
+    *,
+    path: PathLike = README_MD,
+    repo_name: str | None = None,
+    description: str | None = None,
+) -> bool:
+    modifications: set[Path] = set()
+    if (repo_name is not None) and (description is not None):
+        _add_header(repo_name, description, path=path, modifications=modifications)
+    return len(modifications) == 0
+
+
+def _add_header(
+    repo_name: str,
+    description: str,
+    path: PathLike = README_MD,
+    modifications: MutableSet[Path] | None = None,
+) -> None:
+    with yield_text_file(path, modifications=modifications) as context:
+        lines = [f"# `{repo_name}`", description]
+        text = "\n\n".join(lines)
+        if search(escape(text), context.output, flags=MULTILINE) is None:
+            context.output += f"\n\n{text}"
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/setup_ruff.py

@@ -23,6 +23,7 @@ from pre_commit_hooks.utilities import (
 )
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
     from pathlib import Path
 
     from utilities.types import PathLike
@@ -36,12 +37,11 @@ def _main(
 ) -> None:
     if is_pytest():
         return
-    run_all_maybe_raise(
-        *(
-            partial(_run, path=p.parent / RUFF_TOML, python_version=python_version)
-            for p in paths
-        )
-    )
+    funcs: list[Callable[[], bool]] = [
+        partial(_run, path=p.parent / RUFF_TOML, python_version=python_version)
+        for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
 
 
 def _run(

pre_commit_hooks/hooks/update_ci_action_versions.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from functools import partial
+from re import MULTILINE, sub
+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 paths_argument
+from pre_commit_hooks.utilities import run_all_maybe_raise, yield_text_file
+
+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, p) for p in paths))
+
+
+def _run(path: PathLike, /) -> bool:
+    modifications: set[Path] = set()
+    versions = {
+        "actions/checkout": "v6",
+        "actions/setup-python": "v6",
+        "astral-sh/ruff-action": "v3",
+        "astral-sh/setup-uv": "v7",
+    }
+    with yield_text_file(path, modifications=modifications) as context:
+        text = context.input
+        for action, version in versions.items():
+            text = sub(
+                rf"^(\s*- uses: {action})@.+$", rf"\1@{version}", text, flags=MULTILINE
+            )
+        context.output = text
+    return len(modifications) == 0
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/update_ci_extensions.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+from click import command
+from utilities.atomicwrites import move
+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
+
+if TYPE_CHECKING:
+    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, p) for p in paths))
+
+
+def _run(path: PathLike, /) -> bool:
+    new = Path(path).with_suffix(".yaml")
+    move(path, new)
+    return False
+
+
+if __name__ == "__main__":
+    _main()

pre_commit_hooks/hooks/update_requirements.py

@@ -19,6 +19,7 @@ from pre_commit_hooks.utilities import (
 )
 
 if TYPE_CHECKING:
+    from collections.abc import Callable
     from pathlib import Path
 
     from utilities.packaging import Requirement
@@ -39,12 +40,11 @@ def _main(
     if is_pytest():
         return
     versions = _get_versions(index=index, native_tls=native_tls)
-    run_all_maybe_raise(
-        *(
-            partial(_run, path=p, versions=versions, index=index, native_tls=native_tls)
-            for p in paths
-        )
-    )
+    funcs: list[Callable[[], bool]] = [
+        partial(_run, path=p, versions=versions, index=index, native_tls=native_tls)
+        for p in paths
+    ]
+    run_all_maybe_raise(*funcs)
 
 
 def _get_versions(