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

{python_surveyor-0.2.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.2.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.2.0 → python_surveyor-0.3.0}/pyproject.toml

@@ -8,7 +8,7 @@ include = ["python_surveyor"]
 
 [project]
 name = "python-surveyor"
-version = "0.2.0"
+version = "0.3.0"
 description = "Use python introspection to survey source code for final LLM judgement"
 requires-python = ">=3.12"
 license = "MIT"

{python_surveyor-0.2.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
@@ -51,7 +46,7 @@ class Finding:
     line: int
     column: int
     excerpts: tuple[SourceExcerpt, ...]
-    notes: tuple[str, ...]
+    notes: tuple[str, ...] = ()
 
 
 @dataclass(frozen=True)

{python_surveyor-0.2.0 → python_surveyor-0.3.0}/python_surveyor/report.py

@@ -6,7 +6,6 @@ and note lines. Parse errors get their own leading section. Excerpts are
 capped to ``--max-excerpt-lines`` with a truncation note.
 """
 
-from pathlib import Path
 from typing import TextIO
 
 from python_surveyor.checks import CHECKS_BY_ID
@@ -14,25 +13,28 @@ from python_surveyor.scanner import ScanResult
 
 
 def _read_excerpt_lines(
-    path: Path, start: int, end: int, max_lines: int
+    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 ``path``, capping to ``max_lines``.
+    """Read ``[start, end]`` from ``source_lines``, capping to ``max_lines``.
 
     Returns ``(lines, truncation_note)``.
     """
-    try:
-        all_lines = path.read_text(encoding="utf-8").splitlines()
-    except OSError:
+    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 (all_lines[start - 1 : available_end], None)
+        return (list(all_lines[start - 1 : available_end]), None)
     capped_end = start + max_lines - 1
     return (
-        all_lines[start - 1 : capped_end],
+        list(all_lines[start - 1 : capped_end]),
         f"excerpt truncated at {max_lines} lines",
     )
 
@@ -60,17 +62,19 @@ def render_text(
             if spec is not None:
                 stream.write(f"{spec.explanation}\n\n")
         counter += 1
-        prev_path: Path | None = None
+        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(
-                excerpt.path,
+                result.source_lines,
+                path_str,
                 excerpt.start_line,
                 excerpt.end_line,
                 max_excerpt_lines,
             )
             is_continuation = (
-                prev_path == excerpt.path
+                prev_path_str == path_str
                 and prev_end is not None
                 and excerpt.start_line > prev_end + 1
             )
@@ -88,7 +92,7 @@ def render_text(
                 stream.write(f"{line}\n")
             if truncation:
                 stream.write(f"... {truncation}\n")
-            prev_path = excerpt.path
+            prev_path_str = path_str
             prev_end = excerpt.end_line
         for note in finding.notes:
             stream.write(f"  note: {note}\n")

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

@@ -87,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]:
@@ -176,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)
@@ -254,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.2.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.2.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.2.0 → python_surveyor-0.3.0}/tests/test_broad_except.py

@@ -63,6 +63,47 @@ def test_except_specific_not_flagged(make_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"

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

@@ -122,10 +122,21 @@ def test_signature_excerpt_not_full_body(make_source_file, empty_corpus):
     assert excerpt.end_line == 1
 
 
-def test_no_api_note(make_source_file, empty_corpus):
-    source = "def _helper(a=1):\n    pass\n"
+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
-    notes = "\n".join(findings[0].notes)
-    assert "API" not in notes
+    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