python-surveyor 0.1.0__tar.gz → 0.3.0__tar.gz

{python_surveyor-0.1.0/python_surveyor.egg-info → python_surveyor-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-surveyor
-Version: 0.1.0
+Version: 0.3.0
 Summary: Use python introspection to survey source code for final LLM judgement
 Author: Dave Cunningham
 License-Expression: MIT

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/pyproject.toml

@@ -8,7 +8,7 @@ include = ["python_surveyor"]
 
 [project]
 name = "python-surveyor"
-version = "0.1.0"
+version = "0.3.0"
 description = "Use python introspection to survey source code for final LLM judgement"
 requires-python = ">=3.12"
 license = "MIT"
@@ -82,3 +82,6 @@ disable = [
     "duplicate-code",
     "fixme",
 ]
+enable = [
+    "useless-suppression",
+]

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/python_surveyor/cli.py

@@ -7,7 +7,7 @@ from typing import TextIO
 import click
 
 from python_surveyor.checks import ALL_CHECKS
-from python_surveyor.report import render_json, render_text
+from python_surveyor.report import render_text
 from python_surveyor.scanner import scan
 
 
@@ -30,13 +30,6 @@ def main() -> None:
     multiple=True,
     help="fnmatch pattern to exclude (repeatable, additive to defaults).",
 )
-@click.option(
-    "--format",
-    "fmt",
-    type=click.Choice(["text", "json"]),
-    default="text",
-    help="Output format. Default: text.",
-)
 @click.option(
     "--output",
     "output",
@@ -55,14 +48,13 @@ def main() -> None:
     "--max-call-sites",
     "max_call_sites",
     type=int,
-    default=5,
-    help="Cap call-site samples in notes (default 5).",
+    default=10,
+    help="Cap call-site samples in notes (default 10).",
 )
 def scan_cmd(
     paths: tuple[str, ...],
     check_ids: tuple[str, ...],
     excludes: tuple[str, ...],
-    fmt: str,
     output: "Path | None",
     max_excerpt_lines: int,
     max_call_sites: int,
@@ -81,10 +73,7 @@ def scan_cmd(
     else:
         stream = sys.stdout
     try:
-        if fmt == "json":
-            render_json(result, max_excerpt_lines, stream)
-        else:
-            render_text(result, max_excerpt_lines, stream)
+        render_text(result, max_excerpt_lines, stream)
     finally:
         if output is not None:
             stream.close()

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/python_surveyor/model.py

@@ -1,9 +1,4 @@
-"""Frozen dataclasses shared by scanner, checks, and report renderers.
-
-All construction uses required positional fields; there are no
-default-valued fields on ``Finding``/``SourceExcerpt``, consistent with the
-"no optional params on internal APIs" rule this tool itself checks for.
-"""
+"""Frozen dataclasses shared by scanner, checks, and report renderers."""
 
 from dataclasses import dataclass
 from pathlib import Path
@@ -37,7 +32,6 @@ class CallSite:
 class SourceExcerpt:
     """A literal slice of source worth showing verbatim."""
 
-    label: str
     path: Path
     start_line: int
     end_line: int
@@ -51,9 +45,8 @@ class Finding:
     path: Path
     line: int
     column: int
-    message: str
     excerpts: tuple[SourceExcerpt, ...]
-    notes: tuple[str, ...]
+    notes: tuple[str, ...] = ()
 
 
 @dataclass(frozen=True)

python_surveyor-0.3.0/python_surveyor/report.py

@@ -0,0 +1,101 @@
+"""Render a ``ScanResult`` as text.
+
+Text output groups findings by ``check_id``; each finding is shown as
+``path:line:col`` followed by excerpts (with the line range in the header)
+and note lines. Parse errors get their own leading section. Excerpts are
+capped to ``--max-excerpt-lines`` with a truncation note.
+"""
+
+from typing import TextIO
+
+from python_surveyor.checks import CHECKS_BY_ID
+from python_surveyor.scanner import ScanResult
+
+
+def _read_excerpt_lines(
+    source_lines: "dict[str, tuple[str, ...]]",
+    path_str: str,
+    start: int,
+    end: int,
+    max_lines: int,
+) -> "tuple[list[str], str | None]":
+    """Read ``[start, end]`` from ``source_lines``, capping to ``max_lines``.
+
+    Returns ``(lines, truncation_note)``.
+    """
+    all_lines = source_lines.get(path_str)
+    if all_lines is None:
+        return ([], None)
+    available_end = min(end, len(all_lines))
+    if available_end < start:
+        return ([], None)
+    span = available_end - start + 1
+    if span <= max_lines:
+        return (list(all_lines[start - 1 : available_end]), None)
+    capped_end = start + max_lines - 1
+    return (
+        list(all_lines[start - 1 : capped_end]),
+        f"excerpt truncated at {max_lines} lines",
+    )
+
+
+def render_text(
+    result: ScanResult,
+    max_excerpt_lines: int,
+    stream: TextIO,
+) -> None:
+    """Render ``result`` as human-readable text to ``stream``."""
+    stream.write(f"# scan: {result.files_scanned} file(s) scanned\n\n")
+    if result.parse_errors:
+        stream.write("## parse errors\n\n")
+        for err in result.parse_errors:
+            stream.write(f"{err.path}:{err.line} -- {err.message}\n")
+        stream.write("\n")
+    current_check: str | None = None
+    counter = 0
+    for finding in result.findings:
+        if finding.check_id != current_check:
+            current_check = finding.check_id
+            counter = 0
+            stream.write(f"## {current_check}\n\n")
+            spec = CHECKS_BY_ID.get(current_check)
+            if spec is not None:
+                stream.write(f"{spec.explanation}\n\n")
+        counter += 1
+        prev_path_str: str | None = None
+        prev_end: int | None = None
+        for excerpt in finding.excerpts:
+            path_str = str(excerpt.path)
+            lines, truncation = _read_excerpt_lines(
+                result.source_lines,
+                path_str,
+                excerpt.start_line,
+                excerpt.end_line,
+                max_excerpt_lines,
+            )
+            is_continuation = (
+                prev_path_str == path_str
+                and prev_end is not None
+                and excerpt.start_line > prev_end + 1
+            )
+            if is_continuation:
+                stream.write(
+                    f"... (redacted until lines "
+                    f"{excerpt.start_line}-{excerpt.end_line}) ...\n"
+                )
+            else:
+                stream.write(
+                    f"({counter}) {excerpt.path}:"
+                    f"{excerpt.start_line}-{excerpt.end_line}\n"
+                )
+            for line in lines:
+                stream.write(f"{line}\n")
+            if truncation:
+                stream.write(f"... {truncation}\n")
+            prev_path_str = path_str
+            prev_end = excerpt.end_line
+        for note in finding.notes:
+            stream.write(f"  note: {note}\n")
+        stream.write("\n")
+    if not result.findings:
+        stream.write("no findings.\n")

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/python_surveyor/scanner.py

@@ -24,7 +24,7 @@ from collections.abc import Iterator
 from dataclasses import dataclass
 from pathlib import Path
 
-from python_surveyor.checks import ALL_CHECKS, CheckSpec
+from python_surveyor.checks import ALL_CHECKS, COVERED_PYLINT_IDS, CheckSpec
 from python_surveyor.model import CallSite, Finding, Location, ParseError
 
 DEFAULT_PRUNED_DIRS: tuple[str, ...] = (
@@ -77,6 +77,7 @@ class Corpus:
     call_sites: dict[str, tuple[CallSite, ...]]
     param_locations: dict[str, tuple[tuple[Location, str], ...]]
     max_call_sites: int
+    covered_pylint_ids: frozenset[str]
 
 
 @dataclass(frozen=True)
@@ -86,6 +87,7 @@ class ScanResult:
     findings: tuple[Finding, ...]
     parse_errors: tuple[ParseError, ...]
     files_scanned: int
+    source_lines: "dict[str, tuple[str, ...]]"
 
 
 def _discover(root_paths: tuple[str, ...], excludes: tuple[str, ...]) -> Iterator[Path]:
@@ -175,6 +177,9 @@ def _collect_params(
     args = func_node.args
     skip_names = {"self", "cls"}
     names: list[str] = []
+    for arg in args.posonlyargs:
+        if arg.arg not in skip_names:
+            names.append(arg.arg)
     for arg in args.args:
         if arg.arg not in skip_names:
             names.append(arg.arg)
@@ -186,7 +191,11 @@ def _collect_params(
         )
 
 
-def _build_corpus(source_files: list[SourceFile], max_call_sites: int) -> Corpus:
+def _build_corpus(
+    source_files: list[SourceFile],
+    max_call_sites: int,
+    covered_pylint_ids: frozenset[str],
+) -> Corpus:
     call_sites: dict[str, list[CallSite]] = {}
     param_locations: dict[str, list[tuple[Location, str]]] = {}
     for source_file in source_files:
@@ -209,6 +218,7 @@ def _build_corpus(source_files: list[SourceFile], max_call_sites: int) -> Corpus
         call_sites={k: tuple(v) for k, v in call_sites.items()},
         param_locations={k: tuple(v) for k, v in param_locations.items()},
         max_call_sites=max_call_sites,
+        covered_pylint_ids=covered_pylint_ids,
     )
 
 
@@ -238,7 +248,7 @@ def scan(
             continue
         assert parsed is not None
         source_files.append(parsed)
-    corpus = _build_corpus(source_files, max_call_sites)
+    corpus = _build_corpus(source_files, max_call_sites, COVERED_PYLINT_IDS)
     findings: list[Finding] = []
     for source_file in source_files:
         for check_spec in enabled_checks:
@@ -248,4 +258,5 @@ def scan(
         findings=tuple(findings),
         parse_errors=tuple(parse_errors),
         files_scanned=len(source_files),
+        source_lines={str(f.path): f.lines for f in source_files},
     )

{python_surveyor-0.1.0 → python_surveyor-0.3.0/python_surveyor.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-surveyor
-Version: 0.1.0
+Version: 0.3.0
 Summary: Use python introspection to survey source code for final LLM judgement
 Author: Dave Cunningham
 License-Expression: MIT

python_surveyor-0.3.0/tests/test_broad_except.py

@@ -0,0 +1,219 @@
+"""Tests for the ``broad-except`` check."""
+
+from python_surveyor.checks.broad_except import run
+
+
+def test_except_exception(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except Exception:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    assert findings[0].check_id == "broad-except"
+
+
+def test_except_bare(make_source_file, empty_corpus):
+    source = "def f():\n" "    try:\n" "        pass\n" "    except:\n" "        pass\n"
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+
+
+def test_except_baseexception(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except BaseException:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+
+
+def test_except_tuple_with_exception(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except (Exception, ValueError):\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+
+
+def test_except_specific_not_flagged(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except ValueError:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert findings == []
+
+
+def test_bare_reraise_not_flagged(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except Exception:\n"
+        "        raise\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert findings == []
+
+
+def test_logger_exception_not_flagged(make_source_file, empty_corpus):
+    source = (
+        "import logging\n"
+        "logger = logging.getLogger(__name__)\n"
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except Exception:\n"
+        "        logger.exception('failed')\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert findings == []
+
+
+def test_reraise_with_value_still_flagged(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except Exception as e:\n"
+        "        raise RuntimeError('bad') from e\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+
+
+def test_except_star_exception(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except* Exception:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    assert findings[0].check_id == "broad-except"
+
+
+def test_except_body_excerpt(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        pass\n"
+        "    except Exception:\n"
+        "        log_error()\n"
+        "        cleanup()\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpts = findings[0].excerpts
+    assert len(excerpts) == 1
+    assert excerpts[0].start_line == 4
+    assert excerpts[0].end_line == 6
+
+
+def test_except_long_try_body_split_excerpts(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        + "        pass\n" * 20
+        + "    except Exception:\n"
+        + "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpts = findings[0].excerpts
+    assert len(excerpts) == 1
+    handler_line = 2 + 20 + 1
+    assert excerpts[0].start_line == handler_line
+    assert excerpts[0].end_line == handler_line + 1
+
+
+def test_except_with_justifying_comment(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "# We catch Exception here because the subprocess\n"
+        "# may already be dead during shutdown.\n"
+        "    try:\n"
+        "        pass\n"
+        "    except Exception:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpts = findings[0].excerpts
+    assert len(excerpts) == 2
+    assert excerpts[0].start_line == 2
+    assert excerpts[0].end_line == 4
+    assert excerpts[1].start_line == 6
+    assert excerpts[1].end_line == 7
+
+
+def test_try_with_comments_after(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        # This is a comment about the try\n"
+        "        # And another line\n"
+        "        actual_code()\n"
+        "        more_code()\n"
+        "    except Exception:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpts = findings[0].excerpts
+    assert len(excerpts) == 2
+    first = excerpts[0]
+    second = excerpts[1]
+    assert first.start_line == 2
+    assert first.end_line == 4
+    assert second.start_line == 7
+    assert second.end_line == 8
+
+
+def test_try_with_comments_after_merged(make_source_file, empty_corpus):
+    source = (
+        "def f():\n"
+        "    try:\n"
+        "        # comment about try\n"
+        "        pass\n"
+        "    except Exception:\n"
+        "        pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpts = findings[0].excerpts
+    assert len(excerpts) == 2
+    assert excerpts[0].start_line == 2
+    assert excerpts[0].end_line == 3
+    assert excerpts[1].start_line == 5
+    assert excerpts[1].end_line == 6

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/tests/test_cli.py

@@ -1,7 +1,5 @@
 """End-to-end CLI tests using click's ``CliRunner``."""
 
-import json
-
 from click.testing import CliRunner
 
 from python_surveyor.cli import main
@@ -27,20 +25,6 @@ def test_scan_text(tmp_path):
     assert "file(s) scanned" in result.output
 
 
-def test_scan_json(tmp_path):
-    (tmp_path / "a.py").write_text(
-        "from __future__ import annotations\n", encoding="utf-8"
-    )
-    runner = CliRunner()
-    result = runner.invoke(main, ["scan", str(tmp_path), "--format", "json"])
-    assert result.exit_code == 0
-    payload = json.loads(result.output)
-    assert payload["files_scanned"] == 1
-    assert any(
-        f["check_id"] == "future-annotations-import" for f in payload["findings"]
-    )
-
-
 def test_scan_no_findings(tmp_path):
     (tmp_path / "clean.py").write_text("CONST = 1\n", encoding="utf-8")
     runner = CliRunner()

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/tests/test_fixture_naming.py

@@ -1,5 +1,6 @@
 """Tests for the ``fixture-naming`` check."""
 
+from python_surveyor.checks import COVERED_PYLINT_IDS
 from python_surveyor.checks.fixture_naming import run
 from python_surveyor.scanner import _build_corpus
 
@@ -10,8 +11,9 @@ def test_plain_fixture_flagged(make_source_file, empty_corpus):
     findings = run(source_file, empty_corpus)
     assert len(findings) == 1
     assert findings[0].check_id == "fixture-naming"
-    assert "no `name=` kwarg" in findings[0].message
-    assert "lacks `fixture_` prefix" in findings[0].message
+    notes = "\n".join(findings[0].notes)
+    assert "no `name=` kwarg" in notes
+    assert "lacks `fixture_` prefix" in notes
 
 
 def test_fixture_with_name_and_prefix_not_flagged(make_source_file, empty_corpus):
@@ -31,7 +33,8 @@ def test_fixture_prefix_without_name_flagged(make_source_file, empty_corpus):
     source_file = make_source_file("a.py", source)
     findings = run(source_file, empty_corpus)
     assert len(findings) == 1
-    assert "no `name=` kwarg" in findings[0].message
+    notes = "\n".join(findings[0].notes)
+    assert "no `name=` kwarg" in notes
 
 
 def test_name_without_prefix_flagged(make_source_file, empty_corpus):
@@ -39,7 +42,8 @@ def test_name_without_prefix_flagged(make_source_file, empty_corpus):
     source_file = make_source_file("a.py", source)
     findings = run(source_file, empty_corpus)
     assert len(findings) == 1
-    assert "lacks `fixture_` prefix" in findings[0].message
+    notes = "\n".join(findings[0].notes)
+    assert "lacks `fixture_` prefix" in notes
 
 
 def test_bare_fixture_decorator(make_source_file, empty_corpus):
@@ -66,9 +70,28 @@ def test_collision_note(make_source_file):
         "    pass\n"
     )
     source_file = make_source_file("a.py", source)
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 10, COVERED_PYLINT_IDS)
     findings = run(source_file, corpus)
     assert findings
     note = findings[0].notes[0]
     assert "registered as `db`" in note
     assert "1 other function" in note
+
+
+def test_autouse_fixture_not_flagged(make_source_file, empty_corpus):
+    source = (
+        "import pytest\n"
+        "@pytest.fixture(autouse=True)\n"
+        "def short_permission_ttl():\n"
+        "    pass\n"
+    )
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert findings == []
+
+
+def test_conftest_not_flagged(make_source_file, empty_corpus):
+    source = "import pytest\n" "@pytest.fixture\n" "def db():\n" "    pass\n"
+    source_file = make_source_file("conftest.py", source)
+    findings = run(source_file, empty_corpus)
+    assert findings == []

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/tests/test_optional_params.py

@@ -1,5 +1,6 @@
 """Tests for the ``optional-param-default`` check."""
 
+from python_surveyor.checks import COVERED_PYLINT_IDS
 from python_surveyor.checks.optional_params import run
 from python_surveyor.scanner import _build_corpus
 
@@ -10,7 +11,8 @@ def test_defaulted_positional_param(make_source_file, empty_corpus):
     findings = run(source_file, empty_corpus)
     assert len(findings) == 1
     assert findings[0].check_id == "optional-param-default"
-    assert "`f`" in findings[0].message
+    notes = "\n".join(findings[0].notes)
+    assert "`f`" in notes
 
 
 def test_mixed_defaulted_positional(make_source_file, empty_corpus):
@@ -44,31 +46,29 @@ def test_args_kwargs_not_flagged(make_source_file, empty_corpus):
 def test_call_site_note_with_corpus(make_source_file):
     source = "def helper(a=1):\n" "    pass\n" "def caller():\n" "    helper()\n"
     source_file = make_source_file("a.py", source)
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 10, COVERED_PYLINT_IDS)
     findings = run(source_file, corpus)
     assert findings
     notes = "\n".join(findings[0].notes)
-    assert "using default" in notes
-    assert "explicit value" in notes
+    assert "using defaults" in notes
 
 
 def test_call_site_note_not_called(make_source_file):
-    source = "def helper(a=1):\n    pass\n"
+    source = "def helper(a=1):\n" "    pass\n"
     source_file = make_source_file("a.py", source)
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 10, COVERED_PYLINT_IDS)
     findings = run(source_file, corpus)
     assert findings
-    assert "not called from anywhere" in findings[0].notes[0]
+    assert "not called from anywhere" in findings[0].notes[1]
 
 
 def test_call_site_note_override(make_source_file):
     source = "def helper(a=1):\n" "    pass\n" "def caller():\n" "    helper(2)\n"
     source_file = make_source_file("a.py", source)
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 10, COVERED_PYLINT_IDS)
     findings = run(source_file, corpus)
     notes = "\n".join(findings[0].notes)
-    assert "explicit value" in notes
-    assert "using default" in notes
+    assert "override every defaulted parameter" in notes
 
 
 def test_call_site_note_mixed(make_source_file):
@@ -81,18 +81,62 @@ def test_call_site_note_mixed(make_source_file):
         "    helper(2)\n"
     )
     source_file = make_source_file("a.py", source)
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 10, COVERED_PYLINT_IDS)
+    findings = run(source_file, corpus)
+    notes = "\n".join(findings[0].notes)
+    assert "using defaults" in notes
+    assert "1 of 2" in notes
+
+
+def test_call_site_note_truncation(make_source_file):
+    source = "def helper(a=1):\n    pass\n"
+    for i in range(15):
+        source += f"def c{i}():\n    helper()\n"
+    source_file = make_source_file("a.py", source)
+    corpus = _build_corpus([source_file], 10, COVERED_PYLINT_IDS)
     findings = run(source_file, corpus)
     notes = "\n".join(findings[0].notes)
-    assert "explicit value" in notes
-    assert "using default" in notes
+    assert "and 5 other(s)" in notes
 
 
-def test_message_names_defaulted_params(make_source_file, empty_corpus):
+def test_defaulted_param_names_in_notes(make_source_file, empty_corpus):
     source = "def f(a, b=2, *, c=3):\n    pass\n"
     source_file = make_source_file("a.py", source)
     findings = run(source_file, empty_corpus)
     assert len(findings) == 1
-    assert "b" in findings[0].message
-    assert "c" in findings[0].message
-    assert "a" not in findings[0].message.split(":")[-1]
+    notes = "\n".join(findings[0].notes)
+    assert "b" in notes
+    assert "c" in notes
+    # "a" should not appear in the defaulted-params note (it has no default)
+    defaulted_note = [n for n in findings[0].notes if "Defaulted params" in n][0]
+    assert "a" not in defaulted_note.split(":")[-1]
+
+
+def test_signature_excerpt_not_full_body(make_source_file, empty_corpus):
+    source = "def f(a=1):\n" + "    x = 1\n" * 30 + "    return x\n"
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpt = findings[0].excerpts[0]
+    assert excerpt.start_line == 1
+    assert excerpt.end_line == 1
+
+
+def test_signature_elides_non_defaulted_params(make_source_file, empty_corpus):
+    source = "def f(a, b, c=3):\n    pass\n"
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpt = findings[0].excerpts[0]
+    assert excerpt.start_line == 1
+    assert excerpt.end_line == 1
+
+
+def test_signature_elides_with_multiline_def(make_source_file, empty_corpus):
+    source = "def f(\n    a,\n    b,\n    c=3,\n):\n    pass\n"
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+    excerpt = findings[0].excerpts[0]
+    assert excerpt.start_line == 4
+    assert excerpt.end_line == 5

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/tests/test_scanner.py

@@ -5,6 +5,7 @@ import dataclasses
 
 import pytest
 
+from python_surveyor.checks import COVERED_PYLINT_IDS
 from python_surveyor.scanner import (
     Corpus,
     ScanResult,
@@ -122,7 +123,7 @@ def test_build_corpus_call_sites(tmp_path):
         tree=tree,
         tokens=(),
     )
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 5, COVERED_PYLINT_IDS)
     assert "helper" in corpus.call_sites
     assert "method" in corpus.call_sites
     assert corpus.call_sites["helper"][0].positional_count == 0
@@ -142,7 +143,7 @@ def test_build_corpus_call_args(tmp_path):
         tree=tree,
         tokens=(),
     )
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 5, COVERED_PYLINT_IDS)
     sites = corpus.call_sites["f"]
     assert len(sites) == 3
     assert sites[0].positional_count == 1
@@ -165,7 +166,7 @@ def test_build_corpus_param_locations(tmp_path):
         tree=tree,
         tokens=(),
     )
-    corpus = _build_corpus([source_file], max_call_sites=5)
+    corpus = _build_corpus([source_file], 5, COVERED_PYLINT_IDS)
     assert "db" in corpus.param_locations
     assert len(corpus.param_locations["db"]) == 2
 
@@ -188,7 +189,12 @@ def test_scan_result_is_sorted(tmp_path):
 
 
 def test_corpus_is_immutable():
-    corpus = Corpus(call_sites={}, param_locations={}, max_call_sites=5)
+    corpus = Corpus(
+        call_sites={},
+        param_locations={},
+        max_call_sites=5,
+        covered_pylint_ids=COVERED_PYLINT_IDS,
+    )
     with pytest.raises(dataclasses.FrozenInstanceError):
         corpus.max_call_sites = 10  # type: ignore[misc]
 

{python_surveyor-0.1.0 → python_surveyor-0.3.0}/tests/test_suppressions.py

@@ -11,7 +11,8 @@ def test_pylint_disable_without_preceding_comment(make_source_file, empty_corpus
     finding = findings[0]
     assert finding.check_id == "suppression-comment"
     assert finding.notes == ()
-    assert not any(e.label == "justifying comment" for e in finding.excerpts)
+    assert len(finding.excerpts) == 1
+    assert finding.excerpts[0].start_line == 1
 
 
 def test_pyright_ignore_without_preceding_comment(make_source_file, empty_corpus):
@@ -20,7 +21,8 @@ def test_pyright_ignore_without_preceding_comment(make_source_file, empty_corpus
     findings = run(source_file, empty_corpus)
     assert len(findings) == 1
     assert findings[0].notes == ()
-    assert not any(e.label == "justifying comment" for e in findings[0].excerpts)
+    assert len(findings[0].excerpts) == 1
+    assert findings[0].excerpts[0].start_line == 1
 
 
 def test_pylint_disable_next_line(make_source_file, empty_corpus):
@@ -42,7 +44,6 @@ def test_suppression_with_preceding_comment(make_source_file, empty_corpus):
     assert len(findings) == 1
     assert findings[0].notes == ()
     excerpt = findings[0].excerpts[0]
-    assert excerpt.label == "source"
     assert excerpt.start_line == 1
     assert excerpt.end_line == 3
 
@@ -113,10 +114,17 @@ def test_broad_exception_caught_not_flagged(make_source_file, empty_corpus):
     assert findings == []
 
 
-def test_broad_exception_caught_in_list_not_flagged(make_source_file, empty_corpus):
+def test_broad_exception_caught_mixed_list_flagged(make_source_file, empty_corpus):
     source = "x = 1  # pylint: disable=broad-exception-caught,missing-docstring\n"
     source_file = make_source_file("a.py", source)
     findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+
+
+def test_all_covered_in_list_not_flagged(make_source_file, empty_corpus):
+    source = "x = 1  # pylint: disable=broad-exception-caught,import-outside-toplevel\n"
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
     assert findings == []
 
 
@@ -127,8 +135,15 @@ def test_redefined_outer_name_not_flagged(make_source_file, empty_corpus):
     assert findings == []
 
 
-def test_redefined_outer_name_in_list_not_flagged(make_source_file, empty_corpus):
+def test_redefined_outer_name_mixed_list_flagged(make_source_file, empty_corpus):
     source = "x = 1  # pylint: disable=redefined-outer-name,missing-docstring\n"
     source_file = make_source_file("a.py", source)
     findings = run(source_file, empty_corpus)
+    assert len(findings) == 1
+
+
+def test_import_outside_toplevel_not_flagged(make_source_file, empty_corpus):
+    source = "x = 1  # pylint: disable=import-outside-toplevel\n"
+    source_file = make_source_file("a.py", source)
+    findings = run(source_file, empty_corpus)
     assert findings == []

python_surveyor-0.1.0/python_surveyor/report.py

@@ -1,137 +0,0 @@
-"""Render a ``ScanResult`` as text or JSON.
-
-Text output groups findings by ``check_id``; each finding is shown as
-``path:line:col -- message`` followed by labeled excerpts (with the line
-range in the header) and note lines. Parse errors get their own leading
-section. Excerpts are capped to ``--max-excerpt-lines`` with a truncation
-note.
-
-JSON output is a flat list of the same fields for programmatic use (excerpt
-text is not included — only the line range, so consumers can lazy-load).
-"""
-
-import json
-from pathlib import Path
-from typing import TextIO
-
-from python_surveyor.checks import CHECKS_BY_ID
-from python_surveyor.scanner import ScanResult
-
-
-def _read_excerpt_lines(
-    path: Path, start: int, end: int, max_lines: int
-) -> "tuple[list[str], str | None]":
-    """Read ``[start, end]`` from ``path``, capping to ``max_lines``.
-
-    Returns ``(lines, truncation_note)``.
-    """
-    try:
-        all_lines = path.read_text(encoding="utf-8").splitlines()
-    except OSError:
-        return ([], None)
-    available_end = min(end, len(all_lines))
-    if available_end < start:
-        return ([], None)
-    span = available_end - start + 1
-    if span <= max_lines:
-        return (all_lines[start - 1 : available_end], None)
-    capped_end = start + max_lines - 1
-    return (
-        all_lines[start - 1 : capped_end],
-        f"excerpt truncated at {max_lines} lines",
-    )
-
-
-def render_text(
-    result: ScanResult,
-    max_excerpt_lines: int,
-    stream: TextIO,
-) -> None:
-    """Render ``result`` as human-readable text to ``stream``."""
-    stream.write(f"# scan: {result.files_scanned} file(s) scanned\n\n")
-    if result.parse_errors:
-        stream.write("## parse errors\n\n")
-        for err in result.parse_errors:
-            stream.write(f"{err.path}:{err.line} -- {err.message}\n")
-        stream.write("\n")
-    current_check: str | None = None
-    counter = 0
-    for finding in result.findings:
-        if finding.check_id != current_check:
-            current_check = finding.check_id
-            counter = 0
-            stream.write(f"## {current_check}\n\n")
-            spec = CHECKS_BY_ID.get(current_check)
-            if spec is not None:
-                stream.write(f"{spec.explanation}\n\n")
-        counter += 1
-        for excerpt in finding.excerpts:
-            lines, truncation = _read_excerpt_lines(
-                excerpt.path,
-                excerpt.start_line,
-                excerpt.end_line,
-                max_excerpt_lines,
-            )
-            stream.write(
-                f"({counter}) {excerpt.path}:"
-                f"{excerpt.start_line}-{excerpt.end_line}\n"
-            )
-            for line in lines:
-                stream.write(f"{line}\n")
-            if truncation:
-                stream.write(f"... {truncation}\n")
-        for note in finding.notes:
-            stream.write(f"  note: {note}\n")
-        stream.write("\n")
-    if not result.findings:
-        stream.write("no findings.\n")
-
-
-def render_json(
-    result: ScanResult,
-    max_excerpt_lines: int,
-    stream: TextIO,
-) -> None:
-    """Render ``result`` as JSON to ``stream``.
-
-    ``max_excerpt_lines`` is accepted for API symmetry with
-    :func:`render_text`; JSON emits ranges only, not source text.
-    """
-    del max_excerpt_lines
-    findings_payload = []
-    for finding in result.findings:
-        excerpts_payload = [
-            {
-                "label": excerpt.label,
-                "path": str(excerpt.path),
-                "start_line": excerpt.start_line,
-                "end_line": excerpt.end_line,
-            }
-            for excerpt in finding.excerpts
-        ]
-        findings_payload.append(
-            {
-                "check_id": finding.check_id,
-                "path": str(finding.path),
-                "line": finding.line,
-                "column": finding.column,
-                "message": finding.message,
-                "excerpts": excerpts_payload,
-                "notes": list(finding.notes),
-            }
-        )
-    parse_errors_payload = [
-        {
-            "path": str(err.path),
-            "line": err.line,
-            "message": err.message,
-        }
-        for err in result.parse_errors
-    ]
-    payload = {
-        "files_scanned": result.files_scanned,
-        "findings": findings_payload,
-        "parse_errors": parse_errors_payload,
-    }
-    json.dump(payload, stream, indent=2)
-    stream.write("\n")

python_surveyor-0.1.0/tests/test_broad_except.py

@@ -1,93 +0,0 @@
-"""Tests for the ``broad-except`` check."""
-
-from python_surveyor.checks.broad_except import run
-
-
-def test_except_exception(make_source_file, empty_corpus):
-    source = (
-        "def f():\n"
-        "    try:\n"
-        "        pass\n"
-        "    except Exception:\n"
-        "        pass\n"
-    )
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert len(findings) == 1
-    assert findings[0].check_id == "broad-except"
-    assert "Exception" in findings[0].message
-
-
-def test_except_bare(make_source_file, empty_corpus):
-    source = "def f():\n" "    try:\n" "        pass\n" "    except:\n" "        pass\n"
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert len(findings) == 1
-    assert "bare" in findings[0].message
-
-
-def test_except_baseexception(make_source_file, empty_corpus):
-    source = (
-        "def f():\n"
-        "    try:\n"
-        "        pass\n"
-        "    except BaseException:\n"
-        "        pass\n"
-    )
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert len(findings) == 1
-
-
-def test_except_tuple_with_exception(make_source_file, empty_corpus):
-    source = (
-        "def f():\n"
-        "    try:\n"
-        "        pass\n"
-        "    except (Exception, ValueError):\n"
-        "        pass\n"
-    )
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert len(findings) == 1
-
-
-def test_except_specific_not_flagged(make_source_file, empty_corpus):
-    source = (
-        "def f():\n"
-        "    try:\n"
-        "        pass\n"
-        "    except ValueError:\n"
-        "        pass\n"
-    )
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert findings == []
-
-
-def test_except_star_exception(make_source_file, empty_corpus):
-    source = (
-        "def f():\n"
-        "    try:\n"
-        "        pass\n"
-        "    except* Exception:\n"
-        "        pass\n"
-    )
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert len(findings) == 1
-    assert "except*" in findings[0].message
-
-
-def test_except_body_excerpt(make_source_file, empty_corpus):
-    source = (
-        "def f():\n"
-        "    try:\n"
-        "        pass\n"
-        "    except Exception:\n"
-        "        log_error()\n"
-        "        cleanup()\n"
-    )
-    source_file = make_source_file("a.py", source)
-    findings = run(source_file, empty_corpus)
-    assert findings[0].excerpts[0].label == "source"