pre-commit-localupdate 0.4.0__tar.gz → 0.5.0__tar.gz

{pre_commit_localupdate-0.4.0 → pre_commit_localupdate-0.5.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: pre-commit-localupdate
-Version: 0.4.0
-Summary: A CLI tool to automatically update additional dependencies within local Python, Julia, Rust, Go, and Node.js hooks in pre-commit config files.
+Version: 0.5.0
+Summary: A CLI tool to automatically update additional dependencies within local hooks in pre-commit config files.
 Author: M. Farzalipour Tabriz
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
@@ -11,11 +11,12 @@ Project-URL: source, https://gitlab.mpcdf.mpg.de/tbz/pre-commit-localupdate.git
 Requires-Python: <3.15,>=3.11
 Requires-Dist: requests>=2.32.5
 Requires-Dist: ruamel-yaml>=0.19.1
+Requires-Dist: packaging>=26.0
 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, Julia, Rust, Go, 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. You can also pin a specific package to an older version by adding a `# freeze` comment.
+A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones. You can also pin a specific package to an older version by adding a `# freeze` comment.
 
 ## Installation
 
@@ -31,22 +32,27 @@ To check and update the `additional_dependencies` in your `.pre-commit-config.ya
 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:
-
-```shell
-pre-commit-localupdate --config path/to/.pre-commit-config.yaml
-```
-
-To check the dependencies without updating, use the `--dry-run` flag. The command will exit with a non-zero status code if any package needs updating:
-
-```shell
-pre-commit-localupdate --dry-run
-```
-
-To get debug output use `--debug` flag:
-
-```shell
-pre-commit-localupdate --debug
+All options:
+
+```text
+usage: pre-commit-localupdate [-h] [--debug] [--dry-run] [-c PRE-COMMIT-CONFIG] [--timeout TIMEOUT]
+                              [--indent-mapping INDENT_MAPPING] [--indent-sequence INDENT_SEQUENCE]
+                              [--indent-offset INDENT_OFFSET] [--line-width LINE_WIDTH] [--version]
+
+Automatically update additional dependencies within local hooks in a pre-commit config file.
+
+options:
+  -h, --help                         show this help message and exit
+  --debug                            enable debug logging (default: False)
+  --dry-run                          dry run mode. Do not update the file and exit with a non-zero code if the
+                                     configuration file require an update. (default: False)
+  -c, --config PRE-COMMIT-CONFIG     pre-commit config file path (default: .pre-commit-config.yaml)
+  --timeout TIMEOUT                  connection timeout in seconds (default: 10)
+  --indent-mapping INDENT_MAPPING    YAML indentation for mappings (default: 2)
+  --indent-sequence INDENT_SEQUENCE  YAML indentation for sequences (default: 4)
+  --indent-offset INDENT_OFFSET      YAML indentation offset (default: 2)
+  --line-width LINE_WIDTH            maximum line width (default: 80)
+  --version                          show program's version number and exit
 ```
 
 ## Example
@@ -69,7 +75,7 @@ repos:
       # All comment are preserved
       - id: black
         name: black
-        description: "Long strings are automatically folded into multilines by ruamel-yaml library!"
+        description: "Length of strings is automatically adjusted based on the value of --line-width"
         entry: black
         language: python
         minimum_pre_commit_version: 2.9.2
@@ -83,7 +89,7 @@ repos:
 
       - id: julia-format
         name: format julia code
-        description: Run `JuliaFormatter.jl` against Julia source files
+        description: Unicodeテキストは保持されます。
         language: julia
         types: [julia]
         entry: tools/formatter.jl
@@ -119,8 +125,8 @@ repos:
       # All comment are preserved
       - id: black
         name: black
-        description: "Long strings are automatically folded into multilines by ruamel-yaml
-          library!"
+        description: "Length of strings is automatically adjusted based on the value
+          of --line-width"
         entry: black
         language: python
         minimum_pre_commit_version: 2.9.2
@@ -134,7 +140,7 @@ repos:
 
       - id: julia-format
         name: format julia code
-        description: Run `JuliaFormatter.jl` against Julia source files
+        description: Unicodeテキストは保持されます。
         language: julia
         types: [julia]
         entry: tools/formatter.jl
@@ -152,14 +158,25 @@ repos:
         additional_dependencies: ["cli:mdbook-lint:0.14.2"]
 ```
 
+## Supported Languages
+
+Following local hook languages are currently supported:
+
+- Go (golang)
+- Julia
+- Node.js (node)
+- Python
+- Rust
+
 ## Formatting
 
-A considerable amount of effort has been put into making `pre-commit-localupdate` respect the original style and preserve the comments in the pre-commit configuration files. Although it is currently folding long strings (for example, in description lines) and enforcing block indentation for better readability.
+Significant effort has been made to ensure `pre-commit-localupdate` maintains the original style and preserves comments in pre-commit configuration files. However, since the current version of the underlying library does not perfectly preserve the original YAML file format after processing, `pre-commit-localupdate` automatically folds long string values (like descriptions) and enforces block indentation by default when updating files to enhance readability. Both behaviors can be adjusted using command-line parameters.
 
 ## Requirements
 
-- ruamel.yaml
-- requests
+- `packaging`
+- `requests`
+- `ruamel.yaml`
 
 ## License
 

{pre_commit_localupdate-0.4.0 → pre_commit_localupdate-0.5.0}/README.md

@@ -1,6 +1,6 @@
 # pre-commit-localupdate
 
-A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local Python, Julia, Rust, Go, 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. You can also pin a specific package to an older version by adding a `# freeze` comment.
+A CLI tool to automatically update dependencies in `pre-commit-config.yml` files. It specifically targets `additional_dependencies` within local hooks to ensure your tooling stays up-to-date. It also adds version to unversioned packages and pins exact version of loosely defined ones. You can also pin a specific package to an older version by adding a `# freeze` comment.
 
 ## Installation
 
@@ -16,22 +16,27 @@ To check and update the `additional_dependencies` in your `.pre-commit-config.ya
 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:
-
-```shell
-pre-commit-localupdate --config path/to/.pre-commit-config.yaml
-```
-
-To check the dependencies without updating, use the `--dry-run` flag. The command will exit with a non-zero status code if any package needs updating:
-
-```shell
-pre-commit-localupdate --dry-run
-```
-
-To get debug output use `--debug` flag:
-
-```shell
-pre-commit-localupdate --debug
+All options:
+
+```text
+usage: pre-commit-localupdate [-h] [--debug] [--dry-run] [-c PRE-COMMIT-CONFIG] [--timeout TIMEOUT]
+                              [--indent-mapping INDENT_MAPPING] [--indent-sequence INDENT_SEQUENCE]
+                              [--indent-offset INDENT_OFFSET] [--line-width LINE_WIDTH] [--version]
+
+Automatically update additional dependencies within local hooks in a pre-commit config file.
+
+options:
+  -h, --help                         show this help message and exit
+  --debug                            enable debug logging (default: False)
+  --dry-run                          dry run mode. Do not update the file and exit with a non-zero code if the
+                                     configuration file require an update. (default: False)
+  -c, --config PRE-COMMIT-CONFIG     pre-commit config file path (default: .pre-commit-config.yaml)
+  --timeout TIMEOUT                  connection timeout in seconds (default: 10)
+  --indent-mapping INDENT_MAPPING    YAML indentation for mappings (default: 2)
+  --indent-sequence INDENT_SEQUENCE  YAML indentation for sequences (default: 4)
+  --indent-offset INDENT_OFFSET      YAML indentation offset (default: 2)
+  --line-width LINE_WIDTH            maximum line width (default: 80)
+  --version                          show program's version number and exit
 ```
 
 ## Example
@@ -54,7 +59,7 @@ repos:
       # All comment are preserved
       - id: black
         name: black
-        description: "Long strings are automatically folded into multilines by ruamel-yaml library!"
+        description: "Length of strings is automatically adjusted based on the value of --line-width"
         entry: black
         language: python
         minimum_pre_commit_version: 2.9.2
@@ -68,7 +73,7 @@ repos:
 
       - id: julia-format
         name: format julia code
-        description: Run `JuliaFormatter.jl` against Julia source files
+        description: Unicodeテキストは保持されます。
         language: julia
         types: [julia]
         entry: tools/formatter.jl
@@ -104,8 +109,8 @@ repos:
       # All comment are preserved
       - id: black
         name: black
-        description: "Long strings are automatically folded into multilines by ruamel-yaml
-          library!"
+        description: "Length of strings is automatically adjusted based on the value
+          of --line-width"
         entry: black
         language: python
         minimum_pre_commit_version: 2.9.2
@@ -119,7 +124,7 @@ repos:
 
       - id: julia-format
         name: format julia code
-        description: Run `JuliaFormatter.jl` against Julia source files
+        description: Unicodeテキストは保持されます。
         language: julia
         types: [julia]
         entry: tools/formatter.jl
@@ -137,14 +142,25 @@ repos:
         additional_dependencies: ["cli:mdbook-lint:0.14.2"]
 ```
 
+## Supported Languages
+
+Following local hook languages are currently supported:
+
+- Go (golang)
+- Julia
+- Node.js (node)
+- Python
+- Rust
+
 ## Formatting
 
-A considerable amount of effort has been put into making `pre-commit-localupdate` respect the original style and preserve the comments in the pre-commit configuration files. Although it is currently folding long strings (for example, in description lines) and enforcing block indentation for better readability.
+Significant effort has been made to ensure `pre-commit-localupdate` maintains the original style and preserves comments in pre-commit configuration files. However, since the current version of the underlying library does not perfectly preserve the original YAML file format after processing, `pre-commit-localupdate` automatically folds long string values (like descriptions) and enforces block indentation by default when updating files to enhance readability. Both behaviors can be adjusted using command-line parameters.
 
 ## Requirements
 
-- ruamel.yaml
-- requests
+- `packaging`
+- `requests`
+- `ruamel.yaml`
 
 ## License
 

pre_commit_localupdate-0.5.0/pre_commit_localupdate/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.5.0'

{pre_commit_localupdate-0.4.0 → pre_commit_localupdate-0.5.0}/pre_commit_localupdate/__main__.py

@@ -11,10 +11,10 @@ to their latest versions.
 
 import logging
 import sys
-from pathlib import Path
 
 from pre_commit_localupdate.cli import parse_args
 from pre_commit_localupdate.error import PreCommitLocalUpdateError
+from pre_commit_localupdate.io import YAMLFormat
 from pre_commit_localupdate.logs import setup_logging
 from pre_commit_localupdate.pre_commit_config import update_additional_dependencies
 
@@ -23,10 +23,18 @@ def main() -> None:
     """Main entry point for the script."""
     args = parse_args()
     setup_logging(debug=args.debug)
-
+    yaml_format = YAMLFormat(
+        indent_mapping=args.indent_mapping,
+        indent_sequence=args.indent_sequence,
+        indent_offset=args.indent_offset,
+        line_width=args.line_width,
+    )
     try:
-        if update_additional_dependencies(Path(args.config), dry_run=args.dry_run):
+        if update_additional_dependencies(
+            args.config, args.timeout, yaml_format, dry_run=args.dry_run
+        ):
             if args.dry_run:
+                logging.info("Additional dependencies require updating!")
                 sys.exit(1)
             logging.info("Done.")
         else:

pre_commit_localupdate-0.5.0/pre_commit_localupdate/cli.py

@@ -0,0 +1,75 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import argparse
+from pathlib import Path
+
+from pre_commit_localupdate import __version__
+
+
+def parse_args() -> argparse.Namespace:
+    """Parse command line arguments.
+
+    Returns:
+        argparse.Namespace: Parsed arguments.
+    """
+    parser = argparse.ArgumentParser(
+        description="Automatically update additional dependencies within local hooks in a pre-commit config file.",
+        formatter_class=lambda prog: argparse.ArgumentDefaultsHelpFormatter(
+            prog, max_help_position=40, width=120
+        ),
+    )
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        help="enable debug logging",
+    )
+    parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="dry run mode. Do not update the file and exit with a non-zero code if the configuration file require an update.",
+    )
+    parser.add_argument(
+        "-c",
+        "--config",
+        type=Path,
+        help="pre-commit config file path",
+        default=".pre-commit-config.yaml",
+        metavar="PRE-COMMIT-CONFIG",
+    )
+    parser.add_argument(
+        "--timeout",
+        type=int,
+        help="connection timeout in seconds",
+        default=10,
+    )
+    parser.add_argument(
+        "--indent-mapping",
+        type=int,
+        help="YAML indentation for mappings",
+        default=2,
+    )
+    parser.add_argument(
+        "--indent-sequence",
+        type=int,
+        help="YAML indentation for sequences",
+        default=4,
+    )
+    parser.add_argument(
+        "--indent-offset",
+        type=int,
+        help="YAML indentation offset",
+        default=2,
+    )
+    parser.add_argument(
+        "--line-width",
+        type=int,
+        help="maximum line width",
+        default=80,
+    )
+    parser.add_argument(
+        "--version",
+        action="version",
+        version=f"pre-commit-localupdate {__version__}",
+    )
+    return parser.parse_args()

pre_commit_localupdate-0.5.0/pre_commit_localupdate/io.py

@@ -0,0 +1,121 @@
+# SPDX-FileCopyrightText: 2026 M. Farzalipour Tabriz, Max Planck Institute for Physics
+# SPDX-License-Identifier: LGPL-3.0-or-later
+
+import io
+import logging
+import os
+import tempfile
+from dataclasses import dataclass
+from pathlib import Path
+
+from ruamel.yaml import YAML
+from ruamel.yaml.comments import CommentedMap
+
+from pre_commit_localupdate.error import PreCommitLocalUpdateError
+
+
+@dataclass(frozen=True)
+class YAMLFormat:
+    """Configuration for YAML file formatting parameters.
+
+    Attributes:
+        indent_mapping (int): YAML indentation for mappings
+        indent_sequence (int): YAML indentation for sequences
+        indent_offset (int): YAML indentation offset
+        line_width (int): maximum line width
+
+    """
+
+    indent_mapping: int
+    indent_sequence: int
+    indent_offset: int
+    line_width: int
+
+
+def load_config_file(file_path: Path) -> tuple[list[str], str]:
+    """Reads pre-commit configuration file and returns its header lines and content.
+
+    Args:
+        file_path (Path): Path to config file
+
+    Returns:
+        tuple[list[str], str]: Header lines, config file content
+
+    Raises:
+        PreCommitLocalUpdateError: Error in reading config file
+    """
+    logging.debug("Reading configuration file: %s", file_path)
+
+    try:
+        file_content = file_path.read_text(encoding="utf-8")
+    except FileNotFoundError as exc:
+        raise PreCommitLocalUpdateError(f"File not found: {file_path}") from exc
+    except OSError as exc:
+        raise PreCommitLocalUpdateError(
+            f"IOError while reading file {file_path}"
+        ) from exc
+
+    raw_lines = file_content.splitlines(keepends=True)
+
+    content_start_index = 0
+    for i, line in enumerate(raw_lines):
+        stripped = line.strip()
+        if stripped == "---":
+            logging.debug("YAML marker found.")
+            content_start_index = i + 1
+            break
+        if stripped and not stripped.startswith("#"):
+            content_start_index = i
+            break
+
+    header_lines = raw_lines[:content_start_index]
+    content = "".join(raw_lines[content_start_index:])
+
+    return header_lines, content
+
+
+def save_config_file(
+    file_path: Path,
+    config: CommentedMap,
+    header_lines: list[str],
+    yaml_dumper: YAML,
+) -> None:
+    """Writes pre-commit configuration file.
+
+    Args:
+        file_path (Path): Path to config file
+        config (CommentedMap): Config file content
+        header_lines (list[str]): File header lines
+        yaml_dumper (YAML): YAML dumper
+
+    Raises:
+        PreCommitLocalUpdateError: Error in writing config file
+    """
+
+    logging.debug("Writing modifications to disk...")
+    stream = io.StringIO()
+    yaml_dumper.dump(config, stream)
+    modified_body = stream.getvalue()
+    final_content = "".join(header_lines) + modified_body
+
+    temp_file_path = None
+    try:
+        with tempfile.NamedTemporaryFile(
+            mode="w",
+            encoding="utf-8",
+            dir=file_path.parent,
+            delete=False,
+        ) as temp_file:
+            temp_file.write(final_content)
+            os.fsync(temp_file.fileno())
+            temp_file_path = temp_file.name
+
+        os.replace(temp_file_path, file_path)
+        logging.info("Successfully updated %s", file_path)
+
+    except OSError as exc:
+        if temp_file_path and os.path.exists(temp_file_path):
+            os.unlink(temp_file_path)
+        raise PreCommitLocalUpdateError(
+            f"IOError while writing to file {file_path}"
+        ) from exc

{pre_commit_localupdate-0.4.0 → pre_commit_localupdate-0.5.0}/pre_commit_localupdate/logs.py

@@ -6,7 +6,11 @@ import sys
 
 
 def setup_logging(*, debug: bool = False) -> None:
-    """Configure logging based on the debug flag."""
+    """Configure logging based on the debug flag.
+
+    Args:
+        debug (bool): activate debug logs
+    """
     level = logging.DEBUG if debug else logging.INFO
     logging.basicConfig(
         level=level,

{pre_commit_localupdate-0.4.0 → pre_commit_localupdate-0.5.0}/pre_commit_localupdate/packages/golang.py

@@ -11,50 +11,40 @@ from .package import PackageBase
 # Go Proxy API endpoints
 GO_PKG_LATEST_VERSION_API_URL = "https://proxy.golang.org/{package_path}/@latest"
 
-REQUEST_TIMEOUT = 10
-
 
 class GoPackage(PackageBase):
     """Represents a Go module."""
 
     @classmethod
-    def from_specification(package, spec: str) -> "GoPackage" | None:
+    def from_specification(cls, spec: str) -> "GoPackage" | None:
         """Parse a Go module specification string into a Package object.
 
-        Handles formats like:
-        - 'mvdan.cc/sh' (Module path only)
-        - 'mvdan.cc/sh@v1.3.0' (Module path with specific version)
-        - 'mvdan.cc/sh/v3' (Module path with major version suffix)
-        - 'mvdan.cc/sh/v3@v3.10.0' (Major suffix with version)
-        - 'mvdan.cc/sh/v3/cmd/shfmt' (Submodule)
-        - 'mvdan.cc/sh/v3/cmd/shfmt@v3.10.0' (Submodule with version)
+        Supported formats:
+        - `mvdan.cc/sh` (Module path only)
+        - `mvdan.cc/sh@v1.3.0` (Module path with specific version)
+        - `mvdan.cc/sh/v3` (Module path with major version suffix)
+        - `mvdan.cc/sh/v3@v3.10.0` (Major suffix with version)
+        - `mvdan.cc/sh/v3/cmd/shfmt` (Submodule)
+        - `mvdan.cc/sh/v3/cmd/shfmt@v3.10.0` (Submodule with version)
 
         Args:
-            package: The package specification string.
+            spec (str): The package specification string (without quotations).
 
         Returns:
-            A Package instance if parsing succeeds, otherwise None.
+            "GoPackage" | None: A Package instance if parsing succeeds, otherwise None.
         """
-        clean_spec = spec.strip().strip('"').strip("'")
 
-        match = re.match(r"^([a-zA-Z0-9._/-]+)(@.+)?$", clean_spec)
+        match = re.match(r"^([a-zA-Z0-9._/-]+)(@.+)?$", spec)
 
         if not match:
-            logging.warning(
-                "Could not parse the Go package specification: %s", clean_spec
-            )
             return None
 
         name = match.group(1)
         raw_spec = match.group(2)
 
-        module_path = package._resolve_module_path(name)
-        latest_version = package._fetch_latest_version(module_path)
-
-        return package(
+        return cls(
             name=name,
             raw_spec=raw_spec,
-            latest_version=latest_version,
         )
 
     @staticmethod
@@ -66,10 +56,10 @@ class GoPackage(PackageBase):
         additional path segments, it trims the path at the suffix.
 
         Args:
-            package_path: The full submodule path.
+            package_path (str): The full submodule path.
 
         Returns:
-            The resolved module path.
+            str: The resolved module path.
         """
 
         match = re.search(r"/v([2-9]|[1-9][0-9]+)(?=/)", package_path)
@@ -79,44 +69,38 @@ class GoPackage(PackageBase):
 
         return package_path
 
-    @staticmethod
-    def _fetch_latest_version(package_path: str) -> str | None:
+    def fetch_latest_version(self, connection_timeout: int) -> None:
         """Fetch the latest version of a Go module from proxy.golang.org.
 
         Args:
-            package_path: The module path (e.g., mvdan.cc/sh/v3).
-
-        Returns:
-            The latest version string (e.g., v3.10.0) if found, otherwise None.
+            connection_timeout (int): Connection timeout in seconds.
         """
+        package_path = self._resolve_module_path(self.name)
         logging.debug("Fetching latest version for %s", package_path)
         try:
             url = GO_PKG_LATEST_VERSION_API_URL.format(package_path=package_path)
 
-            response = requests.get(url, timeout=REQUEST_TIMEOUT)
+            response = requests.get(url, timeout=connection_timeout)
             response.raise_for_status()
 
             data = response.json()
-            version = data.get("Version")
+            latest_version = data.get("Version")
 
-            if isinstance(version, str):
-                return version
+            if isinstance(latest_version, str):
+                self.latest_version = latest_version
 
-            return None
         except requests.exceptions.RequestException as exc:
             logging.warning(
                 "Could not fetch latest version for %s: %s", package_path, exc
             )
-            return None
         except (KeyError, ValueError) as exc:
             logging.warning("Could not parse response for %s: %s", package_path, exc)
-            return None
 
     def latest_version_specification(self) -> str | None:
         """Version specification of package pinned to the latest version.
 
         Returns:
-            The latest version specification string if found, otherwise None.
+            str | None: The latest version specification string if found, otherwise None.
         """
         if not self.latest_version:
             return None