python-code-quality 0.1.6__tar.gz → 0.1.7__tar.gz

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: python-code-quality
-Version: 0.1.6
-Summary: Python Code Quality Analysis Tool - feed the results from 11 CQ CQ straight into an LLM.
+Version: 0.1.7
+Summary: Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. Minimal tokens.
 Project-URL: Homepage, https://github.com/rhiza-fr/py-cq
 Project-URL: Repository, https://github.com/rhiza-fr/py-cq
 Author-email: Chris Kilner <chris@rhiza.fr>
@@ -26,20 +26,42 @@ Description-Content-Type: text/markdown
 
 # CQ - Python Code Quality Analysis Tool
 
-Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. The primary workflow is:
+Feed the results from 11+ code quality tools to an LLM. Minimal tokens.
+
+The primary workflow is:
 
 ```bash
-cq check -o llm   # get the single most critical defect as markdown
+# get the single most critical defect as markdown
+cq check . -o llm
 ```
+Outputs the top error from the first priority tool where the score < warning_threshold,. The code context is expanded if available.
+```md
+`data/problems/travelling_salesman/ts_bad.py:21` — **F841**: Local variable `unused_variable` is assigned to but never used
 
-Feed that output to an LLM, apply the fix, repeat until the score is clean.
+18:     min_dist = float("inf")
+19:     nearest_city = None
+20:     for city in cities:
+21:         unused_variable = 67
+22:         dist = calc_dist(current_city, city)
+23:         if dist < min_dist:
+24:             min_dist = dist
+25:             nearest_city = city
+
+Please fix only this issue. After fixing, run `cq check . -o llm` to verify.
+```
+Feed to an LLM with edit tools and repeat until there are no issues, e.g.
+
+```
+cq check . -o llm | claude -p "fix this"
+```
 
 ## Install
 
 ```bash
+# install the `cq` command line tool from PyPi
 uv tool install python-code-quality
 
-# or
+# or, clone it then install 
 git pull https://github.com/rhiza-fr/py-cq.git
 cd py-cq
 uv tool install .
@@ -47,7 +69,7 @@ uv tool install .
 
 ## Tools
 
-CQ runs these tools in *parallel*:
+These tools are run in **parallel**:
 
 | Priority | Tool | Measures |
 |----------|------|----------|
@@ -63,40 +85,40 @@ CQ runs these tools in *parallel*:
 | 10 | vulture | Dead code |
 | 11 | interrogate | Docstring coverage |
 
+Diskcache is used to cache tool output for lightning fast re-runs. Sane defaults: <100 Mb, <5 days, No pickle
+
+
 ## Usage
 
 ```bash
 # LLM workflow: get the top defect as markdown (primary use case)
 cq check -o llm
 
-# Rich table with all metrics (default, also saves .cq.json)
-cq check
+# Rich table with all metrics
+cq check .
 
 # Numeric score only — useful in CI or scripts
-cq check -o score
+cq check . -o score
 
-# Full JSON output
-cq check -o json
+# Full JSON output, including raw test results
+cq check . -o json
 
-# Explicit path (defaults to current directory)
+# Explicit path
 cq check path/to/project/
 cq check path/to/file.py
 
-# Run sequentially (1 worker) instead of in parallel
-cq check --workers 1
+# Run sequentially if you like things slow
+cq check . --workers 1
 
-# Clear cached results before running
-cq check --clear-cache
-
-# Save table output to a custom file
-cq check --out-file custom_results.json
+# Clear cached results before running (rarely needed)
+cq check . --clear-cache
 
 # Show effective tool configuration (thresholds, enabled/disabled status)
 cq config
 cq config path/to/project/
 ```
 
-## Output
+## Table output
 
 ```bash
 > cq check .
@@ -123,6 +145,8 @@ cq config path/to/project/
 │                  │          │                     Score │ 0.965   │          │
 └──────────────────┴──────────┴───────────────────────────┴─────────┴──────────┘
 ```
+
+## Single score output
 ```bash
 > cq check . -o score
 ```
@@ -130,23 +154,36 @@ cq config path/to/project/
 0.9662730667181059 # this is designed to approach but not reach 1.0
 ```
 
+## Json output
 ```bash
-> cq check . -o llm
+> cq check . -o json
 ```
 
-```md
-`data/problems/travelling_salesman/ts_bad.py:21` — **F841**: Local variable `unused_variable` is assigned to but never used
-
-18:     min_dist = float("inf")
-19:     nearest_city = None
-20:     for city in cities:
-21:         unused_variable = 67
-22:         dist = calc_dist(current_city, city)
-23:         if dist < min_dist:
-24:             min_dist = dist
-25:             nearest_city = city
-
-Please fix only this issue. After fixing, run `cq check . -o llm` to verify.
+```json
+{
+  "metrics": [
+    {
+      "metrics": {
+        "compile": 1.0
+      },
+      "details": {},
+      "raw": {
+        "tool_name": "compile",
+        "command": ".venv\\Scripts\\python.exe -m compileall -r 10 -j 8 . -x .*venv",
+        "stdout": "Compiling './src/project/file.py'...",
+        "stderr": "",
+        "return_code": 0,
+        "timestamp": "2026-02-19 05:03:11"
+      },
+      "duration_s": 0.08294440002646297
+    },
+    {
+      "metrics": {
+        "security": 1.0
+      }
+      // many more lines ...
+    }
+]}
 ```
 
 ## Configuration
@@ -166,14 +203,111 @@ error = 0.7
 
 Tool IDs match the keys in `config/tools.yaml`: `compilation`, `bandit`, `ruff`, `ty`, `pytest`, `coverage`, `complexity`, `maintainability`, `halstead`, `vulture`, `interrogate`.
 
-## LLM workflow
 
-`-o llm` selects the single worst-scoring tool and formats its top defect as
-concise markdown. The LLM fixes it, you re-run `cq check -o llm`, and repeat
-until all tools are green. Priority order ensures the most critical category
-(security, type errors, failing tests) is fixed before cosmetic ones.
+### Default config
+
+```yaml
+tools:
+
+  compilation:
+    name: "compile"
+    command: "{python} -m compileall -r 10 -j 8 {context_path} -x .*venv"
+    parser: "CompileParser"
+    priority: 1
+    warning_threshold: 0.9999
+    error_threshold: 0.9999
+
+  bandit:
+    name: "bandit"
+    command: "{python} -m bandit -r {context_path} -f json -q -s B101 --severity-level medium --exclude {input_path_posix}/.venv,{input_path_posix}/tests"
+    parser: "BanditParser"
+    priority: 2
+    warning_threshold: 0.9999
+    error_threshold: 0.8
+
+  ruff:
+    name: "ruff"
+    command: "{python} -m ruff check --output-format concise --no-cache {context_path}"
+    parser: "RuffParser"
+    priority: 3
+    warning_threshold: 0.9999
+    error_threshold: 0.9
+
+  ty:
+    name: "ty"
+    command: "{python} -m ty check --output-format concise --color never {context_path}"
+    parser: "TyParser"
+    priority: 4
+    warning_threshold: 0.9999
+    error_threshold: 0.8
+    run_in_target_env: true
+    extra_deps:
+      - ty
+
+  pytest:
+    name: "pytest"
+    command: "{python} -m pytest -v {context_path}"
+    parser: "PytestParser"
+    priority: 5
+    warning_threshold: 0.7
+    error_threshold: 0.5
+    run_in_target_env: true
+
+  coverage:
+    name: "coverage"
+    command: "{python} -m coverage run -m pytest {context_path} && {python} -m coverage report"
+    parser: "CoverageParser"
+    priority: 6
+    warning_threshold: 0.9
+    error_threshold: 0.5
+    run_in_target_env: true
+    extra_deps:
+      - coverage
+      - pytest
+
+  complexity:
+    name: "radon cc"
+    command: "{python} -m radon cc --json {context_path}"
+    parser: "ComplexityParser"
+    priority: 7
+    warning_threshold: 0.6
+    error_threshold: 0.4
+
+  maintainability:
+    name: "radon mi"
+    command: "{python} -m radon mi -s --json {context_path}"
+    parser: "MaintainabilityParser"
+    priority: 8
+    warning_threshold: 0.6
+    error_threshold: 0.4
+
+  halstead:
+    name: "radon hal"
+    command: "{python} -m radon hal -f --json {context_path}"
+    parser: "HalsteadParser"
+    priority: 9
+    warning_threshold: 0.5
+    error_threshold: 0.3
+
+  vulture:
+    name: "vulture"
+    command: "{python} -m vulture {context_path} --min-confidence 80 --exclude .venv,dist,.*_cache,docs,.git"
+    parser: "VultureParser"
+    priority: 10
+    warning_threshold: 0.9999
+    error_threshold: 0.8
+
+  interrogate:
+    name: "interrogate"
+    command: "{python} -m interrogate {context_path} -v --fail-under 0"
+    parser: "InterrogateParser"
+    priority: 11
+    warning_threshold: 0.8
+    error_threshold: 0.3
 
-## Tools
+```
+
+## Respect
 
 Many thanks to all the wonderful maintainers of :
 
@@ -186,3 +320,5 @@ Many thanks to all the wonderful maintainers of :
 - [radon](https://github.com/rubik/radon)
 - [vulture](https://github.com/jendrikseipp/vulture)
 - [interrogate](https://github.com/econchick/interrogate)
+- [diskcache](https://github.com/grantjenks/python-diskcache)
+- [typer](https://github.com/fastapi/typer)

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/README.md

@@ -1,19 +1,41 @@
 # CQ - Python Code Quality Analysis Tool
 
-Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. The primary workflow is:
+Feed the results from 11+ code quality tools to an LLM. Minimal tokens.
+
+The primary workflow is:
 
 ```bash
-cq check -o llm   # get the single most critical defect as markdown
+# get the single most critical defect as markdown
+cq check . -o llm
 ```
+Outputs the top error from the first priority tool where the score < warning_threshold,. The code context is expanded if available.
+```md
+`data/problems/travelling_salesman/ts_bad.py:21` — **F841**: Local variable `unused_variable` is assigned to but never used
 
-Feed that output to an LLM, apply the fix, repeat until the score is clean.
+18:     min_dist = float("inf")
+19:     nearest_city = None
+20:     for city in cities:
+21:         unused_variable = 67
+22:         dist = calc_dist(current_city, city)
+23:         if dist < min_dist:
+24:             min_dist = dist
+25:             nearest_city = city
+
+Please fix only this issue. After fixing, run `cq check . -o llm` to verify.
+```
+Feed to an LLM with edit tools and repeat until there are no issues, e.g.
+
+```
+cq check . -o llm | claude -p "fix this"
+```
 
 ## Install
 
 ```bash
+# install the `cq` command line tool from PyPi
 uv tool install python-code-quality
 
-# or
+# or, clone it then install 
 git pull https://github.com/rhiza-fr/py-cq.git
 cd py-cq
 uv tool install .
@@ -21,7 +43,7 @@ uv tool install .
 
 ## Tools
 
-CQ runs these tools in *parallel*:
+These tools are run in **parallel**:
 
 | Priority | Tool | Measures |
 |----------|------|----------|
@@ -37,40 +59,40 @@ CQ runs these tools in *parallel*:
 | 10 | vulture | Dead code |
 | 11 | interrogate | Docstring coverage |
 
+Diskcache is used to cache tool output for lightning fast re-runs. Sane defaults: <100 Mb, <5 days, No pickle
+
+
 ## Usage
 
 ```bash
 # LLM workflow: get the top defect as markdown (primary use case)
 cq check -o llm
 
-# Rich table with all metrics (default, also saves .cq.json)
-cq check
+# Rich table with all metrics
+cq check .
 
 # Numeric score only — useful in CI or scripts
-cq check -o score
+cq check . -o score
 
-# Full JSON output
-cq check -o json
+# Full JSON output, including raw test results
+cq check . -o json
 
-# Explicit path (defaults to current directory)
+# Explicit path
 cq check path/to/project/
 cq check path/to/file.py
 
-# Run sequentially (1 worker) instead of in parallel
-cq check --workers 1
+# Run sequentially if you like things slow
+cq check . --workers 1
 
-# Clear cached results before running
-cq check --clear-cache
-
-# Save table output to a custom file
-cq check --out-file custom_results.json
+# Clear cached results before running (rarely needed)
+cq check . --clear-cache
 
 # Show effective tool configuration (thresholds, enabled/disabled status)
 cq config
 cq config path/to/project/
 ```
 
-## Output
+## Table output
 
 ```bash
 > cq check .
@@ -97,6 +119,8 @@ cq config path/to/project/
 │                  │          │                     Score │ 0.965   │          │
 └──────────────────┴──────────┴───────────────────────────┴─────────┴──────────┘
 ```
+
+## Single score output
 ```bash
 > cq check . -o score
 ```
@@ -104,23 +128,36 @@ cq config path/to/project/
 0.9662730667181059 # this is designed to approach but not reach 1.0
 ```
 
+## Json output
 ```bash
-> cq check . -o llm
+> cq check . -o json
 ```
 
-```md
-`data/problems/travelling_salesman/ts_bad.py:21` — **F841**: Local variable `unused_variable` is assigned to but never used
-
-18:     min_dist = float("inf")
-19:     nearest_city = None
-20:     for city in cities:
-21:         unused_variable = 67
-22:         dist = calc_dist(current_city, city)
-23:         if dist < min_dist:
-24:             min_dist = dist
-25:             nearest_city = city
-
-Please fix only this issue. After fixing, run `cq check . -o llm` to verify.
+```json
+{
+  "metrics": [
+    {
+      "metrics": {
+        "compile": 1.0
+      },
+      "details": {},
+      "raw": {
+        "tool_name": "compile",
+        "command": ".venv\\Scripts\\python.exe -m compileall -r 10 -j 8 . -x .*venv",
+        "stdout": "Compiling './src/project/file.py'...",
+        "stderr": "",
+        "return_code": 0,
+        "timestamp": "2026-02-19 05:03:11"
+      },
+      "duration_s": 0.08294440002646297
+    },
+    {
+      "metrics": {
+        "security": 1.0
+      }
+      // many more lines ...
+    }
+]}
 ```
 
 ## Configuration
@@ -140,14 +177,111 @@ error = 0.7
 
 Tool IDs match the keys in `config/tools.yaml`: `compilation`, `bandit`, `ruff`, `ty`, `pytest`, `coverage`, `complexity`, `maintainability`, `halstead`, `vulture`, `interrogate`.
 
-## LLM workflow
 
-`-o llm` selects the single worst-scoring tool and formats its top defect as
-concise markdown. The LLM fixes it, you re-run `cq check -o llm`, and repeat
-until all tools are green. Priority order ensures the most critical category
-(security, type errors, failing tests) is fixed before cosmetic ones.
+### Default config
+
+```yaml
+tools:
+
+  compilation:
+    name: "compile"
+    command: "{python} -m compileall -r 10 -j 8 {context_path} -x .*venv"
+    parser: "CompileParser"
+    priority: 1
+    warning_threshold: 0.9999
+    error_threshold: 0.9999
+
+  bandit:
+    name: "bandit"
+    command: "{python} -m bandit -r {context_path} -f json -q -s B101 --severity-level medium --exclude {input_path_posix}/.venv,{input_path_posix}/tests"
+    parser: "BanditParser"
+    priority: 2
+    warning_threshold: 0.9999
+    error_threshold: 0.8
+
+  ruff:
+    name: "ruff"
+    command: "{python} -m ruff check --output-format concise --no-cache {context_path}"
+    parser: "RuffParser"
+    priority: 3
+    warning_threshold: 0.9999
+    error_threshold: 0.9
+
+  ty:
+    name: "ty"
+    command: "{python} -m ty check --output-format concise --color never {context_path}"
+    parser: "TyParser"
+    priority: 4
+    warning_threshold: 0.9999
+    error_threshold: 0.8
+    run_in_target_env: true
+    extra_deps:
+      - ty
+
+  pytest:
+    name: "pytest"
+    command: "{python} -m pytest -v {context_path}"
+    parser: "PytestParser"
+    priority: 5
+    warning_threshold: 0.7
+    error_threshold: 0.5
+    run_in_target_env: true
+
+  coverage:
+    name: "coverage"
+    command: "{python} -m coverage run -m pytest {context_path} && {python} -m coverage report"
+    parser: "CoverageParser"
+    priority: 6
+    warning_threshold: 0.9
+    error_threshold: 0.5
+    run_in_target_env: true
+    extra_deps:
+      - coverage
+      - pytest
+
+  complexity:
+    name: "radon cc"
+    command: "{python} -m radon cc --json {context_path}"
+    parser: "ComplexityParser"
+    priority: 7
+    warning_threshold: 0.6
+    error_threshold: 0.4
+
+  maintainability:
+    name: "radon mi"
+    command: "{python} -m radon mi -s --json {context_path}"
+    parser: "MaintainabilityParser"
+    priority: 8
+    warning_threshold: 0.6
+    error_threshold: 0.4
+
+  halstead:
+    name: "radon hal"
+    command: "{python} -m radon hal -f --json {context_path}"
+    parser: "HalsteadParser"
+    priority: 9
+    warning_threshold: 0.5
+    error_threshold: 0.3
+
+  vulture:
+    name: "vulture"
+    command: "{python} -m vulture {context_path} --min-confidence 80 --exclude .venv,dist,.*_cache,docs,.git"
+    parser: "VultureParser"
+    priority: 10
+    warning_threshold: 0.9999
+    error_threshold: 0.8
+
+  interrogate:
+    name: "interrogate"
+    command: "{python} -m interrogate {context_path} -v --fail-under 0"
+    parser: "InterrogateParser"
+    priority: 11
+    warning_threshold: 0.8
+    error_threshold: 0.3
 
-## Tools
+```
+
+## Respect
 
 Many thanks to all the wonderful maintainers of :
 
@@ -160,3 +294,5 @@ Many thanks to all the wonderful maintainers of :
 - [radon](https://github.com/rubik/radon)
 - [vulture](https://github.com/jendrikseipp/vulture)
 - [interrogate](https://github.com/econchick/interrogate)
+- [diskcache](https://github.com/grantjenks/python-diskcache)
+- [typer](https://github.com/fastapi/typer)

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "python-code-quality"
-version = "0.1.6"
-description = "Python Code Quality Analysis Tool - feed the results from 11 CQ CQ straight into an LLM."
+version = "0.1.7"
+description = "Python Code Quality Analysis Tool - feed the results from 11 CQ tools straight into an LLM. Minimal tokens."
 readme = "README.md"
 requires-python = ">=3.12"
 license = "MIT"

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/cli.py

@@ -23,12 +23,11 @@ from rich.console import Console
 from rich.logging import RichHandler
 from rich.table import Table
 
-from py_cq.config import DEFAULT_STORAGE_FILE, load_user_config
+from py_cq.config import load_user_config
 from py_cq.execution_engine import _cache as tool_cache
 from py_cq.execution_engine import run_tools
 from py_cq.localtypes import CombinedToolResults, ToolConfig
 from py_cq.metric_aggregator import aggregate_metrics
-from py_cq.storage import save_result
 from py_cq.tool_registry import tool_registry
 
 logging.basicConfig(
@@ -44,6 +43,7 @@ app = typer.Typer(
         "  cq check .          # full table with all metrics (default)\n\n"
         "  cq check . -o llm   # top defect as markdown (primary LLM workflow)\n\n"
         "  cq check . -o score # numeric score only\n\n"
+        "  cq check . -o json  # full raw json of all tools"
         "  cq config .         # show effective tool configuration"
     ),
 )
@@ -78,7 +78,7 @@ class OutputMode(str, Enum):
 
 @app.callback()
 def callback():
-    """CQ - Code Quality Analysis Tool."""
+    """Feed the results from 11+ code quality tools to an LLM. Try: cq check . -o llm"""
 console = Console()
 
 
@@ -93,11 +93,6 @@ def check(
         "--log-level",
         help="Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
     ),
-    out_file: str = typer.Option(
-        DEFAULT_STORAGE_FILE,
-        "--out-file",
-        help="File path to save results in table mode",
-    ),
     clear_cache: bool = typer.Option(
         False, "--clear-cache", help="Clear cached tool results before running"
     ),
@@ -105,7 +100,7 @@ def check(
         0, "--workers", help="Max parallel workers (default: one per tool, use 1 for sequential)"
     ),
 ):
-    """Run static analysis on a Python file or project directory."""
+    """Feed the results from 11+ code quality tools to an LLM. Try: cq check . -o llm""" # --help
     path_obj = Path(path)
     if not path_obj.exists():
         raise typer.BadParameter(f"Path does not exist: {path}")
@@ -132,7 +127,6 @@ def check(
         from py_cq.llm_formatter import format_for_llm
         console.print(format_for_llm(effective_registry, combined_metrics))
     else:
-        save_result(combined_tool_results=combined_metrics, file_name=out_file)
         console.print(format_as_table(combined_metrics, effective_registry))
 
 

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/config/__init__.py

@@ -1,10 +1,8 @@
-"""Default storage path and user config loader."""
+"""User config loader."""
 
 import tomllib
 from pathlib import Path
 
-DEFAULT_STORAGE_FILE = ".cq.json"
-
 
 def load_user_config(project_path: Path) -> dict:
     """Read [tool.cq] from pyproject.toml at project_path, if present.

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/config/tools.yaml

@@ -10,7 +10,7 @@ tools:
 
   bandit:
     name: "bandit"
-    command: "{python} -m bandit -r {context_path} -f json -q -s B101 --severity-level medium --exclude {context_dir}/.venv,{context_dir}/tests"
+    command: "{python} -m bandit -r {context_path} -f json -q -s B101 --severity-level medium --exclude {input_path_posix}/.venv,{input_path_posix}/tests"
     parser: "BanditParser"
     priority: 2
     warning_threshold: 0.9999

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/execution_engine.py

@@ -20,16 +20,16 @@ import time
 from collections.abc import Collection
 from concurrent.futures import ThreadPoolExecutor, as_completed
 from pathlib import Path
-from typing import cast
+from typing import Any, cast
 
-import diskcache
+from diskcache import Cache, JSONDisk
 
 from py_cq.context_hash import get_context_hash
 from py_cq.localtypes import RawResult, ToolConfig, ToolResult
 
 log = logging.getLogger("cq")
 
-_cache = diskcache.Cache(Path.home() / ".cache" / "cq")
+_cache = Cache(Path.home() / ".cache" / "cq", size_limit=100 * 1024 * 1024, disk=JSONDisk)
 
 
 def _find_project_root(path: Path) -> Path | None:
@@ -75,12 +75,12 @@ def run_tool(tool_config: ToolConfig, context_path: str) -> RawResult:
             with_flags = " ".join(f"--with {dep}" for dep in tool_config.extra_deps)
             python = f'"{uv}" run --directory "{abs_dir}" {with_flags}'.rstrip()
     abs_context_path = str(Path(context_path).resolve())
-    context_dir = Path(context_path).as_posix().rstrip("/")
-    command = tool_config.command.format(context_path=path, abs_context_path=abs_context_path, context_dir=context_dir, python=python)
+    input_path_posix = Path(context_path).as_posix().rstrip("/")
+    command = tool_config.command.format(context_path=path, abs_context_path=abs_context_path, input_path_posix=input_path_posix, python=python)
     cache_key = f"{command}:{get_context_hash(context_path)}"
     if cache_key in _cache:
         log.info(f"Cache hit: {command}")
-        return cast(RawResult, _cache[cache_key])
+        return RawResult(**cast(dict[str, Any], _cache[cache_key]))
     log.info(f"Running: {command}")
     result = subprocess.run(command, capture_output=True, text=True, shell=True) # nosec
     timestamp = time.strftime("%Y-%m-%d %H:%M:%S")
@@ -92,7 +92,7 @@ def run_tool(tool_config: ToolConfig, context_path: str) -> RawResult:
         return_code=result.returncode,
         timestamp=timestamp,
     )
-    _cache[cache_key] = raw_result
+    _cache.set(cache_key, raw_result.to_dict(), expire=5 * 24 * 60 * 60)
     return raw_result
 
 

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/parsers/banditparser.py

@@ -9,7 +9,7 @@ logistic-variant score stored under the ``security`` metric key.
 import json
 
 from py_cq.localtypes import AbstractParser, RawResult, ToolResult
-from py_cq.parsers.common import score_logistic_variant
+from py_cq.parsers.common import format_source_context, score_logistic_variant
 
 _SEVERITY_WEIGHT = {"HIGH": 5, "MEDIUM": 2, "LOW": 1}
 
@@ -51,4 +51,4 @@ class BanditParser(AbstractParser):
         code = issue.get("code", "")
         severity = issue.get("severity", "")
         message = issue.get("message", "")
-        return f"`{file}:{line}` — **{code}** [{severity}]: {message}"
+        return f"`{file}:{line}` — **{code}** [{severity}]: {message}{format_source_context(file, line)}"

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/parsers/common.py

@@ -25,6 +25,18 @@ def read_source_lines(file_path: str, line: int, count: int = 5) -> str:
         return ""
 
 
+def format_source_context(file: str, line: int | str, context: int = 3, count: int = 8) -> str:
+    """Return a fenced python code block for the source around `line`, or '' if unavailable."""
+    if not isinstance(line, int):
+        return ""
+    context_start = max(1, line - context)
+    raw_lines = read_source_lines(file, context_start, count=count).splitlines()
+    if not raw_lines:
+        return ""
+    src = "\n".join(f"{context_start + i}: {rline}" for i, rline in enumerate(raw_lines))
+    return f"\n```python\n{src}\n```"
+
+
 def inv_normalize(value: float, max_value: float) -> float:
     """Returns the inverse normalized value of `value` relative to `max_value`."""
     return (max_value - min(value, max_value)) / max_value

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/parsers/compileparser.py

@@ -6,7 +6,7 @@ compile score, and providing concise help messages for any failures."""
 import logging
 
 from py_cq.localtypes import AbstractParser, RawResult, ToolResult
-from py_cq.parsers.common import read_source_lines, score_logistic_variant
+from py_cq.parsers.common import format_source_context, score_logistic_variant
 
 log = logging.getLogger("cq")
 
@@ -124,11 +124,5 @@ class CompileParser(AbstractParser):
         line = info.get("line", "?")
         typ = info.get("type", "Error")
         help_msg = info.get("help", "")
-        if isinstance(line, int):
-            context_start = max(1, line - 3)
-            raw_lines = read_source_lines(file, context_start, count=8).splitlines()
-            src = "\n".join(f"{context_start + i}: {rline}" for i, rline in enumerate(raw_lines)) if raw_lines else info.get("src", "")
-        else:
-            src = info.get("src", "")
-        code_block = f"\n```python\n{src}\n```" if src else ""
+        code_block = format_source_context(file, line) or (f"\n```python\n{info['src']}\n```" if info.get("src") else "")
         return f"`{file}:{line}` — **{typ}**: {help_msg}{code_block}"

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/parsers/ruffparser.py

@@ -13,7 +13,7 @@ followed by a summary line ``Found N error.`` or ``All checks passed!``."""
 import re
 
 from py_cq.localtypes import AbstractParser, RawResult, ToolResult
-from py_cq.parsers.common import read_source_lines, score_logistic_variant
+from py_cq.parsers.common import format_source_context, score_logistic_variant
 
 _DIAG_RE = re.compile(r"^(.+):(\d+):(\d+): ([A-Z]\d+) (.+)$")
 
@@ -54,8 +54,4 @@ class RuffParser(AbstractParser):
         line = issue.get("line", "?")
         code = issue.get("code", "")
         message = issue.get("message", "")
-        context_start = max(1, line - 3) if isinstance(line, int) else line
-        raw_lines = read_source_lines(file, context_start, count=8).splitlines() if isinstance(line, int) else []
-        src = "\n".join(f"{context_start + i}: {rline}" for i, rline in enumerate(raw_lines)) if raw_lines else ""
-        code_block = f"\n```python\n{src}\n```" if src else ""
-        return f"`{file}:{line}` — **{code}**: {message}{code_block}"
+        return f"`{file}:{line}` — **{code}**: {message}{format_source_context(file, line)}"

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/parsers/typarser.py

@@ -14,7 +14,7 @@ Errors count more heavily than warnings toward the score."""
 import re
 
 from py_cq.localtypes import AbstractParser, RawResult, ToolResult
-from py_cq.parsers.common import read_source_lines, score_logistic_variant
+from py_cq.parsers.common import format_source_context, score_logistic_variant
 
 _DIAG_RE = re.compile(r"^(.+):(\d+):\d+:\s+(error|warning)\[([^\]]+)\] (.+)$")
 
@@ -58,8 +58,4 @@ class TyParser(AbstractParser):
         line = issue.get("line", "?")
         code = issue.get("code", "")
         message = issue.get("message", "")
-        context_start = max(1, line - 3) if isinstance(line, int) else line
-        raw_lines = read_source_lines(file, context_start, count=8).splitlines() if isinstance(line, int) else []
-        src = "\n".join(f"{context_start + i}: {rline}" for i, rline in enumerate(raw_lines)) if raw_lines else ""
-        code_block = f"\n```python\n{src}\n```" if src else ""
-        return f"`{file}:{line}` — **{code}**: {message}{code_block}"
+        return f"`{file}:{line}` — **{code}**: {message}{format_source_context(file, line)}"

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/src/py_cq/parsers/vultureparser.py

@@ -12,7 +12,7 @@ score stored under the ``dead_code`` metric key.
 import re
 
 from py_cq.localtypes import AbstractParser, RawResult, ToolResult
-from py_cq.parsers.common import score_logistic_variant
+from py_cq.parsers.common import format_source_context, score_logistic_variant
 
 _LINE_RE = re.compile(r"^(.+):(\d+): (unused \S+) '(.+)' \((\d+)% confidence\)$")
 
@@ -45,4 +45,4 @@ class VultureParser(AbstractParser):
         kind = issue.get("type", "unused")
         name = issue.get("name", "")
         confidence = issue.get("confidence", "?")
-        return f"`{file}:{line}` — **{kind}** `{name}` ({confidence}% confidence)"
+        return f"`{file}:{line}` — **{kind}** `{name}` ({confidence}% confidence){format_source_context(file, line)}"

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/tests/test_execution_engine.py

@@ -96,7 +96,9 @@ def test_run_tool_cache_miss_calls_subprocess(tmp_path):
     mock_result.stderr = ""
     mock_result.returncode = 0
 
-    with patch("py_cq.execution_engine._cache", {}):
+    mock_cache = MagicMock()
+    mock_cache.__contains__ = MagicMock(return_value=False)
+    with patch("py_cq.execution_engine._cache", mock_cache):
         with patch("py_cq.execution_engine.subprocess.run", return_value=mock_result) as mock_sub:
             result = run_tool(cfg, str(tmp_path))
     mock_sub.assert_called_once()
@@ -114,11 +116,13 @@ def test_run_tool_cache_hit_skips_subprocess(tmp_path):
     cached = RawResult(tool_name="echo", stdout="cached!")
     # Build the cache key the same way run_tool does
     import sys
+    from pathlib import Path
 
     from py_cq.context_hash import get_context_hash
-    command = cfg.command.format(context_path=str(tmp_path), python=sys.executable)
+    input_path_posix = Path(str(tmp_path)).as_posix().rstrip("/")
+    command = cfg.command.format(context_path=str(tmp_path), abs_context_path=str(tmp_path), input_path_posix=input_path_posix, python=sys.executable)
     cache_key = f"{command}:{get_context_hash(str(tmp_path))}"
-    fake_cache = {cache_key: cached}
+    fake_cache = {cache_key: cached.to_dict()}
 
     with patch("py_cq.execution_engine._cache", fake_cache):
         with patch("py_cq.execution_engine.subprocess.run") as mock_sub:

{python_code_quality-0.1.6 → python_code_quality-0.1.7}/uv.lock

@@ -300,7 +300,7 @@ wheels = [
 
 [[package]]
 name = "python-code-quality"
-version = "0.1.4"
+version = "0.1.6"
 source = { editable = "." }
 dependencies = [
     { name = "bandit" },

python_code_quality-0.1.6/src/py_cq/storage.py

@@ -1,27 +0,0 @@
-"""Utilities for persisting combined tool results.
-
-This module provides a single helper function, :func:`save_result`, which
-serializes a :class:`CombinedToolResults` instance to a JSON file. The
-function ensures that the target directory exists, writes a readable
-representation of the results, and returns the absolute path of the created
-file.
-
-Example
--------
->>> from your_package import CombinedToolResults, save_result
->>> results = CombinedToolResults(...)
->>> output_path = save_result(results, "output.json")
->>> print(output_path)"""
-
-import json
-
-from py_cq.localtypes import CombinedToolResults
-
-
-def save_result(combined_tool_results: CombinedToolResults, file_name: str):
-    """Saves combined tool results to a JSON file named by `file_name`."""
-    if not file_name:
-        return
-    data = combined_tool_results.to_dict()
-    with open(file_name, "w") as f:
-        json.dump(data, f, indent=4)

python_code_quality-0.1.6/tests/test_storage.py

@@ -1,41 +0,0 @@
-"""Tests for storage.save_result."""
-
-import json
-
-from py_cq.localtypes import CombinedToolResults, RawResult, ToolResult
-from py_cq.storage import save_result
-
-
-def _combined(path="test.py", tool_results=None):
-    return CombinedToolResults(path=path, tool_results=tool_results or [])
-
-
-def test_save_result_writes_json(tmp_path):
-    out = tmp_path / "results.json"
-    save_result(_combined(), str(out))
-    data = json.loads(out.read_text())
-    assert "score" in data
-    assert "path" in data
-
-
-def test_save_result_empty_filename_is_noop():
-    save_result(_combined(), "")  # must not raise
-
-
-def test_save_result_content_path_and_score(tmp_path):
-    out = tmp_path / "out.json"
-    save_result(_combined(path="myproject/"), str(out))
-    data = json.loads(out.read_text())
-    assert data["path"] == "myproject/"
-
-
-def test_save_result_includes_tool_metrics(tmp_path):
-    out = tmp_path / "out.json"
-    combined = CombinedToolResults(
-        path=".",
-        tool_results=[ToolResult(metrics={"lint": 0.9}, raw=RawResult(tool_name="ruff"))],
-    )
-    save_result(combined, str(out))
-    data = json.loads(out.read_text())
-    assert len(data["metrics"]) == 1
-    assert data["metrics"][0]["metrics"]["lint"] == 0.9