lange-python 0.3.13__tar.gz → 0.3.15__tar.gz

{lange_python-0.3.13 → lange_python-0.3.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lange-python
-Version: 0.3.13
+Version: 0.3.15
 Summary: A bundeld set of tools, clients for the lange-suite of tools and more.
 Author: contact@robertlange.me
 Requires-Python: >=3.10

{lange_python-0.3.13 → lange_python-0.3.15}/lange/cli/code/__init__.py

@@ -1,7 +1,9 @@
 import click
 
+from .audit import code_audit
 from ._stats import code_stats
 
+
 @click.group()
 def code_group() -> None:
     """
@@ -10,4 +12,5 @@ def code_group() -> None:
     :returns: ``None``.
     """
 
-code_group.add_command(code_stats,"stats")
+code_group.add_command(code_stats, "stats")
+code_group.add_command(code_audit, "audit")

lange_python-0.3.15/lange/cli/code/audit/__init__.py

@@ -0,0 +1,5 @@
+"""Audit command exports for ``lange code``."""
+
+from ._command import code_audit
+
+__all__ = ["code_audit"]

lange_python-0.3.15/lange/cli/code/audit/_command.py

@@ -0,0 +1,64 @@
+"""CLI command orchestration for ``lange code audit``."""
+
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+
+import click
+
+from ._discovery import (
+    detect_available_audit_tools,
+    list_auditable_folders,
+    resolve_audit_folder,
+)
+from ._runner import run_audit_command
+
+
+@click.command("audit")
+@click.argument("folder_name", required=False)
+def code_audit(folder_name: str | None) -> None:
+    """
+    Run dependency audits for one folder or all auditable top-level folders.
+
+    :param folder_name: Optional folder name to audit.
+    :returns: ``None``.
+    """
+    if folder_name:
+        target_folder = resolve_audit_folder(folder_name=folder_name, root=Path.cwd())
+        run_audits_for_folder(folder=target_folder)
+        return
+
+    target_folders = list_auditable_folders(Path.cwd())
+    if not target_folders:
+        raise click.ClickException(
+            "No auditable services were found in the current directory."
+        )
+
+    for target_folder in target_folders:
+        run_audits_for_folder(folder=target_folder)
+
+
+def run_audits_for_folder(folder: Path) -> None:
+    """
+    Detect and execute all supported audit commands for one folder.
+
+    :param folder: Folder that should be audited.
+    :returns: ``None``.
+    """
+    audit_tools = detect_available_audit_tools(folder)
+    if not audit_tools:
+        raise click.ClickException(
+            "Could not detect a supported audit tool. "
+            "Expected pnpm-lock, pnpm-lock.yaml and/or uv.lock."
+        )
+
+    try:
+        for audit_tool in audit_tools:
+            run_audit_command(folder=folder, audit_tool=audit_tool)
+    except subprocess.CalledProcessError as error:
+        raise click.ClickException(
+            f"Audit command failed with exit code {error.returncode}."
+        ) from error
+    except OSError as error:
+        raise click.ClickException(str(error)) from error

lange_python-0.3.15/lange/cli/code/audit/_discovery.py

@@ -0,0 +1,70 @@
+"""Folder and audit-tool discovery helpers for ``lange code audit``."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import click
+
+from ._types import AuditTool, PNPM_AUDIT_TOOL, UV_AUDIT_TOOL
+
+PNPM_LOCK_FILES: tuple[str, ...] = ("pnpm-lock", "pnpm-lock.yaml")
+UV_LOCK_FILE = "uv.lock"
+
+
+def list_candidate_folders(root: Path) -> list[Path]:
+    """
+    List top-level non-hidden directories.
+
+    :param root: Directory that should be scanned.
+    :returns: Sorted non-hidden child directories.
+    """
+    candidates = [
+        path
+        for path in root.iterdir()
+        if path.is_dir() and not path.name.startswith(".")
+    ]
+    return sorted(candidates, key=lambda item: item.name.lower())
+
+
+def resolve_audit_folder(folder_name: str, root: Path) -> Path:
+    """
+    Resolve an explicitly requested audit folder.
+
+    :param folder_name: Folder argument passed via CLI.
+    :param root: Current working directory.
+    :returns: Resolved target folder path.
+    """
+    folder = (root / folder_name).resolve()
+    if not folder.exists() or not folder.is_dir():
+        raise click.ClickException(
+            f"Folder '{folder_name}' was not found or is not a directory."
+        )
+    return folder
+
+
+def list_auditable_folders(root: Path) -> list[Path]:
+    """
+    List top-level folders that contain at least one supported audit lock file.
+
+    :param root: Directory that should be scanned.
+    :returns: Sorted list of auditable folders.
+    """
+    return [
+        folder for folder in list_candidate_folders(root) if detect_available_audit_tools(folder)
+    ]
+
+
+def detect_available_audit_tools(folder: Path) -> list[AuditTool]:
+    """
+    Detect supported audit tools available in the given folder.
+
+    :param folder: Folder that should be inspected.
+    :returns: Ordered list of detected audit tools.
+    """
+    available: list[AuditTool] = []
+    if any((folder / lock_file).is_file() for lock_file in PNPM_LOCK_FILES):
+        available.append(PNPM_AUDIT_TOOL)
+    if (folder / UV_LOCK_FILE).is_file():
+        available.append(UV_AUDIT_TOOL)
+    return available

lange_python-0.3.15/lange/cli/code/audit/_runner.py

@@ -0,0 +1,31 @@
+"""Command execution helpers for ``lange code audit``."""
+
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+
+from ._types import AuditTool, PNPM_AUDIT_TOOL, UV_AUDIT_TOOL
+
+
+def build_audit_command(audit_tool: AuditTool) -> list[str]:
+    """
+    Build the subprocess command for one supported audit tool.
+
+    :param audit_tool: Tool that should be executed.
+    :returns: Command arguments for ``subprocess.run``.
+    """
+    if audit_tool == PNPM_AUDIT_TOOL:
+        return ["pnpm", "audit"]
+    return ["uv", "audit"]
+
+
+def run_audit_command(folder: Path, audit_tool: AuditTool) -> None:
+    """
+    Execute one audit command in the given folder.
+
+    :param folder: Working directory for the audit command.
+    :param audit_tool: Tool that should be executed.
+    :returns: ``None``.
+    """
+    subprocess.run(build_audit_command(audit_tool), check=True, cwd=folder)

lange_python-0.3.15/lange/cli/code/audit/_types.py

@@ -0,0 +1,10 @@
+"""Shared audit tool type definitions."""
+
+from __future__ import annotations
+
+from typing import Literal
+
+AuditTool = Literal["pnpm", "uv"]
+
+PNPM_AUDIT_TOOL: AuditTool = "pnpm"
+UV_AUDIT_TOOL: AuditTool = "uv"

{lange_python-0.3.13 → lange_python-0.3.15}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lange-python"
-version = "0.3.13"
+version = "0.3.15"
 description = "A bundeld set of tools, clients for the lange-suite of tools and more."
 authors = [
     {name = "contact@robertlange.me"}