auto-code-fixer 0.3.6__tar.gz → 0.4.0__tar.gz

{auto_code_fixer-0.3.6 → auto_code_fixer-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: auto-code-fixer
-Version: 0.3.6
+Version: 0.4.0
 Summary: Automatically fix Python code using ChatGPT
 Author-email: Arif Shah <ashah7775@gmail.com>
 License: MIT
@@ -87,6 +87,18 @@ pip install requests
 Before overwriting any file, it creates a backup:
 - `file.py.bak` (or `.bak1`, `.bak2`, ...)
 
+### Approval mode (diff review)
+```bash
+auto-code-fixer path/to/main.py --project-root . --approve
+```
+In patch-protocol mode, approvals are **file-by-file** (apply/skip).
+
+### Diff / size guards
+To prevent huge edits from being applied accidentally:
+- `--max-diff-lines` limits unified-diff size per file
+- `--max-file-bytes` limits the proposed new content size per file
+- `--max-total-bytes` limits total proposed new content across all files
+
 ### Dry run
 ```bash
 auto-code-fixer path/to/main.py --project-root . --dry-run
@@ -96,6 +108,15 @@ auto-code-fixer path/to/main.py --project-root . --dry-run
 
 ## Advanced options
 
+### Fixpack mode (folder/package runner)
+Fixpack runs a command (default: `pytest -q`) against a **full-project sandbox**, then iteratively fixes the failing file(s) until green or you hit `--max-retries`.
+
+```bash
+auto-code-fixer path/to/package --project-root . --fixpack --no-ask
+# equivalent explicit command:
+auto-code-fixer path/to/package --project-root . --fixpack --run "pytest -q" --no-ask
+```
+
 ### Run a custom command (pytest, etc.)
 Instead of `python main.py`, run tests:
 
@@ -103,6 +124,16 @@ Instead of `python main.py`, run tests:
 auto-code-fixer . --project-root . --run "pytest -q" --no-ask
 ```
 
+When you use `--run`, the tool (by default) also performs a **post-apply check**:
+after copying fixes back to your project, it re-runs the same command against the real project files
+(using the sandbox venv for dependencies).
+
+You can disable that extra check with:
+
+```bash
+auto-code-fixer . --project-root . --run "pytest -q" --no-post-apply-check
+```
+
 ### Model selection
 ```bash
 export AUTO_CODE_FIXER_MODEL=gpt-4.1-mini
@@ -121,13 +152,25 @@ auto-code-fixer main.py --ai-plan
 ```
 This enables a helper that can suggest which local file to edit. It is best-effort.
 
-### Optional structured patch protocol (JSON + sha256)
+### Structured patch protocol (JSON + sha256) (default)
+By default, Auto Code Fixer uses a structured **patch protocol** where the model returns strict JSON:
+
+`{ "files": [ {"path": "...", "new_content": "...", "sha256": "..."}, ... ] }`
+
+The tool verifies the SHA-256 hash of `new_content` before applying edits.
+
+To disable this and use legacy full-text mode only:
+
 ```bash
-auto-code-fixer main.py --patch-protocol
+auto-code-fixer main.py --legacy-mode
+```
+
+### Ruff-first mode (best-effort)
+Before calling the LLM, you can try Ruff auto-fixes (including import sorting) and Ruff formatting:
+
+```bash
+auto-code-fixer path/to/package --project-root . --fixpack --ruff-first
 ```
-When enabled, the model is asked to return strict JSON with `{files:[{path,new_content,sha256}]}`.
-The tool verifies the SHA-256 hash of `new_content` before applying edits, and falls back to the
-legacy full-text mode if parsing/validation fails.
 
 ### Optional formatting / linting (best-effort)
 ```bash
@@ -136,6 +179,15 @@ auto-code-fixer main.py --lint ruff --fix
 ```
 These run inside the sandbox venv and are skipped if the tools are not installed.
 
+### JSON report (explain)
+Write a machine-readable report with attempts, files touched, and unified diffs:
+
+```bash
+auto-code-fixer main.py --explain
+# or
+auto-code-fixer main.py --report /tmp/report.json
+```
+
 ---
 
 ## Environment variables

{auto_code_fixer-0.3.6 → auto_code_fixer-0.4.0}/README.md

@@ -66,6 +66,18 @@ pip install requests
 Before overwriting any file, it creates a backup:
 - `file.py.bak` (or `.bak1`, `.bak2`, ...)
 
+### Approval mode (diff review)
+```bash
+auto-code-fixer path/to/main.py --project-root . --approve
+```
+In patch-protocol mode, approvals are **file-by-file** (apply/skip).
+
+### Diff / size guards
+To prevent huge edits from being applied accidentally:
+- `--max-diff-lines` limits unified-diff size per file
+- `--max-file-bytes` limits the proposed new content size per file
+- `--max-total-bytes` limits total proposed new content across all files
+
 ### Dry run
 ```bash
 auto-code-fixer path/to/main.py --project-root . --dry-run
@@ -75,6 +87,15 @@ auto-code-fixer path/to/main.py --project-root . --dry-run
 
 ## Advanced options
 
+### Fixpack mode (folder/package runner)
+Fixpack runs a command (default: `pytest -q`) against a **full-project sandbox**, then iteratively fixes the failing file(s) until green or you hit `--max-retries`.
+
+```bash
+auto-code-fixer path/to/package --project-root . --fixpack --no-ask
+# equivalent explicit command:
+auto-code-fixer path/to/package --project-root . --fixpack --run "pytest -q" --no-ask
+```
+
 ### Run a custom command (pytest, etc.)
 Instead of `python main.py`, run tests:
 
@@ -82,6 +103,16 @@ Instead of `python main.py`, run tests:
 auto-code-fixer . --project-root . --run "pytest -q" --no-ask
 ```
 
+When you use `--run`, the tool (by default) also performs a **post-apply check**:
+after copying fixes back to your project, it re-runs the same command against the real project files
+(using the sandbox venv for dependencies).
+
+You can disable that extra check with:
+
+```bash
+auto-code-fixer . --project-root . --run "pytest -q" --no-post-apply-check
+```
+
 ### Model selection
 ```bash
 export AUTO_CODE_FIXER_MODEL=gpt-4.1-mini
@@ -100,13 +131,25 @@ auto-code-fixer main.py --ai-plan
 ```
 This enables a helper that can suggest which local file to edit. It is best-effort.
 
-### Optional structured patch protocol (JSON + sha256)
+### Structured patch protocol (JSON + sha256) (default)
+By default, Auto Code Fixer uses a structured **patch protocol** where the model returns strict JSON:
+
+`{ "files": [ {"path": "...", "new_content": "...", "sha256": "..."}, ... ] }`
+
+The tool verifies the SHA-256 hash of `new_content` before applying edits.
+
+To disable this and use legacy full-text mode only:
+
 ```bash
-auto-code-fixer main.py --patch-protocol
+auto-code-fixer main.py --legacy-mode
+```
+
+### Ruff-first mode (best-effort)
+Before calling the LLM, you can try Ruff auto-fixes (including import sorting) and Ruff formatting:
+
+```bash
+auto-code-fixer path/to/package --project-root . --fixpack --ruff-first
 ```
-When enabled, the model is asked to return strict JSON with `{files:[{path,new_content,sha256}]}`.
-The tool verifies the SHA-256 hash of `new_content` before applying edits, and falls back to the
-legacy full-text mode if parsing/validation fails.
 
 ### Optional formatting / linting (best-effort)
 ```bash
@@ -115,6 +158,15 @@ auto-code-fixer main.py --lint ruff --fix
 ```
 These run inside the sandbox venv and are skipped if the tools are not installed.
 
+### JSON report (explain)
+Write a machine-readable report with attempts, files touched, and unified diffs:
+
+```bash
+auto-code-fixer main.py --explain
+# or
+auto-code-fixer main.py --report /tmp/report.json
+```
+
 ---
 
 ## Environment variables

auto_code_fixer-0.4.0/auto_code_fixer/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"

auto_code_fixer-0.4.0/auto_code_fixer/approval.py

@@ -0,0 +1,114 @@
+import difflib
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class PlannedChange:
+    abs_path: str
+    rel_path: str
+    old_content: str
+    new_content: str
+
+
+class UserAbort(Exception):
+    pass
+
+
+def unified_diff_text(rel_path: str, old: str, new: str) -> str:
+    return "".join(
+        difflib.unified_diff(
+            (old or "").splitlines(keepends=True),
+            (new or "").splitlines(keepends=True),
+            fromfile=rel_path + " (before)",
+            tofile=rel_path + " (after)",
+        )
+    )
+
+
+def guard_planned_changes(
+    planned: list[PlannedChange],
+    *,
+    max_file_bytes: int,
+    max_total_bytes: int,
+    max_diff_lines: int,
+) -> None:
+    """Safety guards against huge edits.
+
+    Raises ValueError when limits are exceeded.
+    """
+
+    if max_file_bytes <= 0 or max_total_bytes <= 0 or max_diff_lines <= 0:
+        raise ValueError("Guard limits must be positive")
+
+    total = 0
+
+    for ch in planned:
+        b = len((ch.new_content or "").encode("utf-8"))
+        total += b
+        if b > max_file_bytes:
+            raise ValueError(
+                f"Proposed content for {ch.rel_path} is {b} bytes, exceeding --max-file-bytes={max_file_bytes}"
+            )
+
+        diff = unified_diff_text(ch.rel_path, ch.old_content, ch.new_content)
+        diff_lines = len(diff.splitlines())
+        if diff_lines > max_diff_lines:
+            raise ValueError(
+                f"Diff for {ch.rel_path} is {diff_lines} lines, exceeding --max-diff-lines={max_diff_lines}"
+            )
+
+    if total > max_total_bytes:
+        raise ValueError(
+            f"Total proposed content is {total} bytes, exceeding --max-total-bytes={max_total_bytes}"
+        )
+
+
+def prompt_approve_file_by_file(
+    planned: list[PlannedChange],
+    *,
+    input_fn=input,
+    print_fn=print,
+) -> list[PlannedChange]:
+    """Interactive approval per file.
+
+    Commands:
+      y = apply this change
+      n = skip this change
+      a = apply this and all remaining
+      q = abort
+    """
+
+    if not planned:
+        return []
+
+    out: list[PlannedChange] = []
+    apply_all = False
+
+    for ch in planned:
+        diff = unified_diff_text(ch.rel_path, ch.old_content, ch.new_content)
+        print_fn("\nPROPOSED CHANGE:")
+        print_fn(diff)
+
+        if apply_all:
+            out.append(ch)
+            continue
+
+        ans = (
+            input_fn(f"Apply change for {ch.rel_path}? (y/n/a/q): ")
+            .strip()
+            .lower()
+        )
+        if ans == "y":
+            out.append(ch)
+        elif ans == "n":
+            continue
+        elif ans == "a":
+            out.append(ch)
+            apply_all = True
+        elif ans == "q":
+            raise UserAbort("User aborted approvals")
+        else:
+            # default: be safe
+            continue
+
+    return out