pre-commit-localupdate 0.1.0__tar.gz

pre_commit_localupdate-0.1.0/LICENSE

@@ -0,0 +1 @@
+LICENSES/LGPL-3.0-or-later.txt

pre_commit_localupdate-0.1.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.1
+Name: pre-commit-localupdate
+Version: 0.1.0
+Summary: A CLI tool to automatically update `additional_dependencies` within local Python hooks in `pre-commit-config.yml` files.
+Author: M. Farzalipour Tabriz
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Project-URL: source, https://gitlab.mpcdf.mpg.de/tbz/pre-commit-localupdate.git
+Requires-Python: <3.15,>=3.10
+Requires-Dist: requests>=2.32.5
+Requires-Dist: ruamel-yaml>=0.19.1
+Description-Content-Type: text/markdown
+
+# pre-commit-localupdate
+
+A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python and Node.js hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones.
+
+## Installation
+
+```bash
+pip install pre-commit-localupdate
+```
+
+## Usage
+
+To check and update the `additional_dependencies` in your `.pre-commit-config.yaml` file, simply run:
+
+```bash
+pre-commit-localupdate
+```
+
+By default, the tool looks for `.pre-commit-config.yaml` in the current directory. To specify a custom file path, use the `-c` or `--config` argument:
+
+```bash
+pre-commit-localupdate --config path/to/.pre-commit-config.yaml
+```
+
+## Example
+
+Given a `.pre-commit-config.yaml` with the following content:
+
+```yaml
+# Comments in the file header are preserved
+---
+repos:
+  - repo: local
+    hooks:
+      # Comment about hooks are preserved
+      - id: black
+        name: black
+        description: "Long strings are automatically folded into multilines by ruamel-yaml library!"
+        entry: black
+        language: python
+        minimum_pre_commit_version: 2.9.2
+        require_serial: true
+        types_or: [python, pyi]
+        additional_dependencies:
+          # Loose version definitions will be pinned to an exact version
+          - "black>=25.1.0"
+
+      - id: mypy
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        additional_dependencies:
+          # Double/single quoting style is preserved
+          - 'mypy==1.18.1'
+          # Version is added to packages with no version definition
+          - "types-requests"
+
+      - id: mypy2
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        # Updating packages defined in flow style is also supported
+        additional_dependencies: ['mypy==1.18.1', "types-requests"]
+```
+
+Running `pre-commit-localupdate` will update the file to (hypothetical latest versions):
+
+```yaml
+# Comments in the file header are preserved
+---
+repos:
+  - repo: local
+    hooks:
+      # Comment about hooks are preserved
+      - id: black
+        name: black
+        description: "Long strings are automatically folded into multilines by ruamel-yaml
+          library!"
+        entry: black
+        language: python
+        minimum_pre_commit_version: 2.9.2
+        require_serial: true
+        types_or: [python, pyi]
+        additional_dependencies:
+          # Loose version definitions should be pinned
+          - "black==26.1.0"
+
+      - id: mypy
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        additional_dependencies:
+          # Double/single quoting style is preserved
+          - 'mypy==1.19.1'
+          # Version is added to packages with no version definition
+          - "types-requests==2.32.4.20260107"
+
+      - id: mypy2
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        # Updating packages defined in flow style is also supported
+        additional_dependencies: ['mypy==1.19.1', "types-requests==2.32.4.20260107"]
+```
+
+## Requirements
+
+- ruamel.yaml
+- requests
+
+## License
+
+- Copyright 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics (MPP)
+
+All rights reserved.
+This software may be modified and distributed under the terms of the GNU Lesser General Public License (LGPL). See the `LICENSE` file for details.

pre_commit_localupdate-0.1.0/README.md

@@ -0,0 +1,136 @@
+# pre-commit-localupdate
+
+A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python and Node.js hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones.
+
+## Installation
+
+```bash
+pip install pre-commit-localupdate
+```
+
+## Usage
+
+To check and update the `additional_dependencies` in your `.pre-commit-config.yaml` file, simply run:
+
+```bash
+pre-commit-localupdate
+```
+
+By default, the tool looks for `.pre-commit-config.yaml` in the current directory. To specify a custom file path, use the `-c` or `--config` argument:
+
+```bash
+pre-commit-localupdate --config path/to/.pre-commit-config.yaml
+```
+
+## Example
+
+Given a `.pre-commit-config.yaml` with the following content:
+
+```yaml
+# Comments in the file header are preserved
+---
+repos:
+  - repo: local
+    hooks:
+      # Comment about hooks are preserved
+      - id: black
+        name: black
+        description: "Long strings are automatically folded into multilines by ruamel-yaml library!"
+        entry: black
+        language: python
+        minimum_pre_commit_version: 2.9.2
+        require_serial: true
+        types_or: [python, pyi]
+        additional_dependencies:
+          # Loose version definitions will be pinned to an exact version
+          - "black>=25.1.0"
+
+      - id: mypy
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        additional_dependencies:
+          # Double/single quoting style is preserved
+          - 'mypy==1.18.1'
+          # Version is added to packages with no version definition
+          - "types-requests"
+
+      - id: mypy2
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        # Updating packages defined in flow style is also supported
+        additional_dependencies: ['mypy==1.18.1', "types-requests"]
+```
+
+Running `pre-commit-localupdate` will update the file to (hypothetical latest versions):
+
+```yaml
+# Comments in the file header are preserved
+---
+repos:
+  - repo: local
+    hooks:
+      # Comment about hooks are preserved
+      - id: black
+        name: black
+        description: "Long strings are automatically folded into multilines by ruamel-yaml
+          library!"
+        entry: black
+        language: python
+        minimum_pre_commit_version: 2.9.2
+        require_serial: true
+        types_or: [python, pyi]
+        additional_dependencies:
+          # Loose version definitions should be pinned
+          - "black==26.1.0"
+
+      - id: mypy
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        additional_dependencies:
+          # Double/single quoting style is preserved
+          - 'mypy==1.19.1'
+          # Version is added to packages with no version definition
+          - "types-requests==2.32.4.20260107"
+
+      - id: mypy2
+        name: mypy
+        description: 'Type checking'
+        entry: mypy
+        language: python
+        types_or: [python, pyi]
+        args: ["--strict"]
+        require_serial: true
+        minimum_pre_commit_version: '2.9.2'
+        # Updating packages defined in flow style is also supported
+        additional_dependencies: ['mypy==1.19.1', "types-requests==2.32.4.20260107"]
+```
+
+## Requirements
+
+- ruamel.yaml
+- requests
+
+## License
+
+- Copyright 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics (MPP)
+
+All rights reserved.
+This software may be modified and distributed under the terms of the GNU Lesser General Public License (LGPL). See the `LICENSE` file for details.

pre_commit_localupdate-0.1.0/pre_commit_localupdate/__main__.py

@@ -0,0 +1,34 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+"""Module to update Python additional_dependencies in .pre-commit-config.yaml.
+
+This script reads the .pre-commit-config.yaml file, identifies hooks defined
+under 'repo: local' that use 'language: python', and updates the packages
+listed in 'additional_dependencies' to their latest versions available on PyPI.
+
+It preserves the original file formatting, comments, and structure, only
+modifying the version strings within the dependency lines.
+"""
+
+import logging
+from pathlib import Path
+
+from pre_commit_localupdate.cli import parse_args
+from pre_commit_localupdate.logs import setup_logging
+from pre_commit_localupdate.pre_commit_config import update_additional_dependencies
+
+
+def main() -> None:
+    """Main entry point for the script."""
+    args = parse_args()
+    setup_logging(args.debug)
+
+    if update_additional_dependencies(Path(args.config)):
+        logging.info("Done.")
+    else:
+        logging.info("File content is already up to date.")
+
+
+if __name__ == "__main__":
+    main()

pre_commit_localupdate-0.1.0/pre_commit_localupdate/cli.py

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import argparse
+
+
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments."""
+    parser = argparse.ArgumentParser(
+        description="Update Python and Node.js additional_dependencies in .pre-commit-config.yaml"
+    )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="Enable debug logging",
+    )
+    parser.add_argument(
+        "-c",
+        "--config",
+        type=str,
+        help="pre-commit config file path",
+        default=".pre-commit-config.yaml",
+    )
+
+    return parser.parse_args()

pre_commit_localupdate-0.1.0/pre_commit_localupdate/logs.py

@@ -0,0 +1,15 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import logging
+import sys
+
+
+def setup_logging(debug: bool = False) -> None:
+    """Configure logging based on the debug flag."""
+    level = logging.DEBUG if debug else logging.INFO
+    logging.basicConfig(
+        level=level,
+        format="%(asctime)s - %(levelname)s - %(message)s",
+        stream=sys.stdout,
+    )

pre_commit_localupdate-0.1.0/pre_commit_localupdate/node.py

@@ -0,0 +1,98 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import logging
+import re
+from dataclasses import dataclass
+from typing import cast
+
+import requests
+
+from pre_commit_localupdate.package import PackageBase
+
+NPM_API_URL = "https://registry.npmjs.org/{package_name}"
+REQUEST_TIMEOUT = 10
+
+
+@dataclass
+class NodePackage(PackageBase):
+    """Represents a Node.js package."""
+
+    @classmethod
+    def from_specification(package, spec: str) -> "NodePackage" | None:
+        """Parse a package specification string into a NodePackage object.
+
+        Handles formats like 'react@4.17.21', 'react@>=18.0.0', '@scope/name@^1.2.3', or just 'react'.
+
+        Args:
+            spec: The package specification string.
+
+        Returns:
+            A NodePackage instance if parsing succeeds, otherwise None.
+
+        """
+        clean_spec = spec.strip().strip('"').strip("'")
+
+        if not clean_spec:
+            return None
+
+        parts = clean_spec.split("@")
+
+        name = clean_spec
+        raw_spec = None
+
+        # Look for version from the end (handles scoped packages correctly).
+        for i in range(len(parts) - 1, 0, -1):
+            if re.match(r"^(\d+|[<>=~^])", parts[i]):
+                name = "@".join(parts[:i])
+                raw_spec = "@" + "@".join(parts[i:])
+                break
+
+        latest_version = package._get_latest_version(name)
+
+        return package(
+            name=name,
+            raw_spec=raw_spec,
+            latest_version=latest_version,
+        )
+
+    @staticmethod
+    def _get_latest_version(package_name: str) -> str | None:
+        """Fetch the latest version of a package from the npm registry.
+
+        Returns:
+            The latest version string if found, otherwise None.
+
+        """
+        try:
+            url = NPM_API_URL.format(package_name=package_name)
+            response = requests.get(url, timeout=REQUEST_TIMEOUT)
+            response.raise_for_status()
+            data = response.json()
+
+            version = data.get("dist-tags", {}).get("latest")
+
+            if version and isinstance(version, str):
+                return cast("str", version)
+
+            return None
+        except requests.exceptions.RequestException as exc:
+            logging.warning(
+                "Could not fetch latest version for %s: %s", package_name, exc
+            )
+            return None
+        except (KeyError, ValueError) as exc:
+            logging.warning("Could not parse response for %s: %s", package_name, exc)
+            return None
+
+    def latest_version_specification(package) -> str | None:
+        """Version specification of package pinned to the latest version.
+
+        Returns:
+            The latest version specification string if found, otherwise None.
+
+        """
+        if not package.latest_version:
+            return None
+
+        return f"{package.name}@{package.latest_version}"

pre_commit_localupdate-0.1.0/pre_commit_localupdate/package.py

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+
+
+@dataclass
+class PackageBase(ABC):
+    """Abstract base class defining the interface for all package types.
+
+    Attributes:
+        name: The name of the package (e.g., 'requests').
+        raw_spec: The original version specifier string (e.g., '==2.25.1', '^4.17.21', '>=1.0.0', '@1.2.3').
+        latest_version: Latest version number without operators (e.g., '2.25.1').
+
+    """
+
+    name: str
+    raw_spec: str | None
+    latest_version: str | None
+
+    @classmethod
+    @abstractmethod
+    def from_specification(package, spec_string: str) -> "PackageBase" | None:
+        """Parse a package specification string into a Package object."""
+
+    @abstractmethod
+    def latest_version_specification(package) -> str | None:
+        """Version specification of package pinned to the latest version."""
+
+    def version_specification(package) -> str | None:
+        """Version specification of package as originally defined.
+
+        Returns:
+            The version specification string.
+
+        """
+        if package.raw_spec:
+            return f"{package.name}{package.raw_spec}"
+        return f"{package.name}[unspecified version]"

pre_commit_localupdate-0.1.0/pre_commit_localupdate/pre_commit_config.py

@@ -0,0 +1,158 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import io
+import logging
+from pathlib import Path
+
+import ruamel.yaml
+
+from pre_commit_localupdate.node import NodePackage
+from pre_commit_localupdate.package import PackageBase
+from pre_commit_localupdate.python import PyPackage
+
+LANGUAGE_PACKAGE_MAP: dict[str, type[PackageBase]] = {
+    "python": PyPackage,
+    "node": NodePackage,
+}
+
+
+def update_additional_dependencies(file_path: Path) -> bool:
+    """Reads the configuration file, identifies outdated Python packages in
+    local hooks, and updates them directly in the file.
+
+    Preserves structure, quote styles, the document start marker (---),
+    and comments preceding it.
+
+    Args:
+        file_path: Path to the YAML configuration file.
+
+    Returns:
+        True if the file was modified and successfully written, False otherwise.
+
+    """
+    logging.debug("Reading configuration file: %s", file_path)
+
+    raw_lines = []
+    header_lines = []
+    yaml_start_index = 0
+
+    try:
+        with file_path.open("r", encoding="utf-8") as f:
+            raw_lines = f.readlines()
+    except FileNotFoundError:
+        logging.exception("File not found: %s", file_path)
+        return False
+    except OSError as exc:
+        logging.exception("IOError while reading file %s: %s", file_path, exc)
+        return False
+
+    logging.debug("Parsing document header...")
+    yaml_start_index = 0
+    for i, line in enumerate(raw_lines):
+        stripped = line.strip()
+        if stripped == "---":
+            logging.debug("YAML marker found.")
+            yaml_start_index = i + 1
+            break
+        if stripped and not stripped.startswith("#"):
+            yaml_start_index = i
+            break
+
+    header_lines = raw_lines[:yaml_start_index]
+
+    logging.debug("Parsing YAML content...")
+    yaml_content = "".join(raw_lines[yaml_start_index:])
+
+    yaml = ruamel.yaml.YAML()
+    yaml.preserve_quotes = True
+    yaml.indent(mapping=2, sequence=4, offset=2)
+    yaml.default_flow_style = False
+    yaml.width = None
+    yaml.explicit_start = False
+    yaml.allow_unicode = True
+
+    try:
+        config = yaml.load(yaml_content)
+    except Exception as exc:
+        logging.exception("Failed to parse YAML content from %s: %s", file_path, exc)
+        return False
+
+    if config is None:
+        logging.warning("Configuration file is empty or could not be parsed.")
+        return False
+
+    file_modified = False
+
+    if "repos" in config:
+        logging.debug("Scanning repositories for local hooks")
+        for repo in config.get("repos", []):
+            if repo.get("repo") != "local":
+                continue
+
+            hooks = repo.get("hooks", [])
+            for hook in hooks:
+                hook_id = hook.get("id")
+                logging.debug("Processing hook with ID: %s", hook_id)
+
+                if hook.get("language") not in LANGUAGE_PACKAGE_MAP:
+                    continue
+
+                PackageClass = LANGUAGE_PACKAGE_MAP[hook.get("language")]
+
+                if "additional_dependencies" not in hook:
+                    continue
+
+                deps_list = list(hook["additional_dependencies"])
+
+                for i, dep_spec in enumerate(deps_list):
+                    dep_str = str(dep_spec)
+
+                    logging.debug("Checking dependency: %s", dep_str)
+                    package: PackageBase | None = PackageClass.from_specification(
+                        dep_str
+                    )
+                    if not package:
+                        continue
+
+                    if not package.latest_version_specification():
+                        continue
+
+                    if (
+                        package.latest_version_specification()
+                        != package.version_specification()
+                    ):
+                        logging.info(
+                            "Updating %s to %s",
+                            package.version_specification(),
+                            package.latest_version_specification(),
+                        )
+                        hook["additional_dependencies"][
+                            i
+                        ] = package.latest_version_specification()
+
+                        file_modified = True
+                    else:
+                        logging.debug(
+                            "%s is already correctly defined and up to date (%s).",
+                            package.name,
+                            package.version_specification(),
+                        )
+
+    if file_modified:
+        logging.debug("Writing modified content to disk")
+        try:
+            stream = io.StringIO()
+            yaml.dump(config, stream)
+            modified_body = stream.getvalue()
+            final_content = "".join(header_lines) + modified_body
+
+            with file_path.open("w", encoding="utf-8") as f:
+                f.write(final_content)
+            logging.info("Successfully updated %s", file_path)
+            return True
+        except OSError as exc:
+            logging.exception("IOError while writing to file %s: %s", file_path, exc)
+            return False
+
+    return False

pre_commit_localupdate-0.1.0/pre_commit_localupdate/python.py

@@ -0,0 +1,86 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import logging
+import re
+from typing import cast
+
+import requests
+
+from pre_commit_localupdate.package import PackageBase
+
+PYPI_API_URL = "https://pypi.org/pypi/{package_name}/json"
+REQUEST_TIMEOUT = 10
+
+
+class PyPackage(PackageBase):
+    """Represents a Python package."""
+
+    @classmethod
+    def from_specification(package, spec: str) -> "PyPackage" | None:
+        """Parse a package specification string into a Package object.
+
+        Handles formats like 'ansible==13.3.0', 'ansible>=1.0', or just 'ansible'.
+
+        Args:
+            spec: The package specification string.
+
+        Returns:
+            A Package instance if parsing succeeds, otherwise None.
+
+        """
+        clean_spec = spec.strip().strip('"').strip("'")
+        match = re.match(r"^([a-zA-Z0-9._-]+)([=<>!~]+.*)?$", clean_spec)
+        if not match:
+            logging.warning("Could not parse the package specification: %s", clean_spec)
+            return None
+
+        name = match.group(1)
+        raw_spec = match.group(2)
+        latest_version = package._get_latest_version(name)
+
+        return package(
+            name=name,
+            raw_spec=raw_spec,
+            latest_version=latest_version,
+        )
+
+    @staticmethod
+    def _get_latest_version(package_name: str) -> str | None:
+        """Fetch the latest version of a package from PyPI.
+
+        Returns:
+            The latest version string if found, otherwise None.
+
+        """
+        logging.debug("Fetching latest version for %s", package_name)
+        try:
+            url = PYPI_API_URL.format(package_name=package_name)
+            response = requests.get(url, timeout=REQUEST_TIMEOUT)
+            response.raise_for_status()
+            data = response.json()
+            version = data.get("info", {}).get("version")
+            if version and isinstance(version, str):
+                return cast("str", version)
+
+            return None
+        except requests.exceptions.RequestException as exc:
+            logging.warning(
+                "Could not fetch latest version for %s: %s", package_name, exc
+            )
+            return None
+        except (KeyError, ValueError) as exc:
+            logging.warning("Could not parse response for %s: %s", package_name, exc)
+            return None
+
+    def latest_version_specification(package) -> str | None:
+        """Version specification of package pinned to the latest version.
+
+        Returns:
+            The latest version specification string if found, otherwise None.
+
+        """
+        if not package.latest_version:
+            return None
+
+        return f"{package.name}=={package.latest_version}"

pre_commit_localupdate-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+build-backend = "pdm.backend"
+requires = [
+    "pdm-backend",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.2",
+]
+
+[project]
+authors = [
+    { name = "M. Farzalipour Tabriz" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+]
+dependencies = [
+    "requests>=2.32.5",
+    "ruamel-yaml>=0.19.1",
+]
+description = "A CLI tool to automatically update `additional_dependencies` within local Python hooks in `pre-commit-config.yml` files."
+name = "pre-commit-localupdate"
+readme = "README.md"
+requires-python = "<3.15,>=3.10"
+version = "0.1.0"
+
+[project.scripts]
+pre-commit-localupdate = "pre_commit_localupdate.__main__:main"
+
+[project.urls]
+source = "https://gitlab.mpcdf.mpg.de/tbz/pre-commit-localupdate.git"
+
+[tool.tomlsort]
+sort_table_keys = true
+trailing_comma_inline_array = true