codehound 1.8.0__tar.gz → 1.9.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. {codehound-1.8.0 → codehound-1.9.0}/PKG-INFO +20 -9
  2. {codehound-1.8.0 → codehound-1.9.0}/README.md +19 -8
  3. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/__init__.py +3 -3
  4. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/__init__.py +4 -0
  5. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/loop_closure_capture.py +86 -0
  6. codehound-1.9.0/src/codehound/checks/nondeterministic_default.py +99 -0
  7. codehound-1.9.0/src/codehound/checks/strip_multichar.py +88 -0
  8. {codehound-1.8.0 → codehound-1.9.0}/tests/test_checks.py +166 -0
  9. {codehound-1.8.0 → codehound-1.9.0}/.gitignore +0 -0
  10. {codehound-1.8.0 → codehound-1.9.0}/LICENSE +0 -0
  11. {codehound-1.8.0 → codehound-1.9.0}/pyproject.toml +0 -0
  12. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/async_property.py +0 -0
  13. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/asyncio_coroutine_decorator.py +0 -0
  14. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/asyncio_run_in_loop.py +0 -0
  15. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/bare_except.py +0 -0
  16. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/blocking_async.py +0 -0
  17. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/collections_abc_import.py +0 -0
  18. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/datetime_utcnow.py +0 -0
  19. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/discarded_future.py +0 -0
  20. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/finally_swallows_exception.py +0 -0
  21. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/floating_process.py +0 -0
  22. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/floating_task.py +0 -0
  23. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/floating_thread.py +0 -0
  24. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/floating_timer.py +0 -0
  25. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/get_event_loop.py +0 -0
  26. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/is_literal_comparison.py +0 -0
  27. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/lru_cache_on_async_function.py +0 -0
  28. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/lru_cache_on_method.py +0 -0
  29. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/mutable_class_attribute.py +0 -0
  30. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/mutable_defaults.py +0 -0
  31. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/removed_asyncio_task_methods.py +0 -0
  32. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/removed_getargspec.py +0 -0
  33. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/removed_stdlib_attribute.py +0 -0
  34. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/removed_stdlib_module.py +0 -0
  35. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/resource_leak.py +0 -0
  36. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/unawaited_coroutine.py +0 -0
  37. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/unclosed_pool.py +0 -0
  38. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/unclosed_socket.py +0 -0
  39. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/unittest_deprecated_alias.py +0 -0
  40. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/unprotected_lock.py +0 -0
  41. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/checks/unwaited_subprocess.py +0 -0
  42. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/cli.py +0 -0
  43. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/config.py +0 -0
  44. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/core.py +0 -0
  45. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/fixes.py +0 -0
  46. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/sarif.py +0 -0
  47. {codehound-1.8.0 → codehound-1.9.0}/src/codehound/terminal.py +0 -0
  48. {codehound-1.8.0 → codehound-1.9.0}/tests/test_config.py +0 -0
  49. {codehound-1.8.0 → codehound-1.9.0}/tests/test_fixes.py +0 -0
  50. {codehound-1.8.0 → codehound-1.9.0}/tests/test_noqa.py +0 -0
  51. {codehound-1.8.0 → codehound-1.9.0}/tests/test_output_formats.py +0 -0
  52. {codehound-1.8.0 → codehound-1.9.0}/tests/test_parallel_scan.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.5
2
2
  Name: codehound
3
- Version: 1.8.0
3
+ Version: 1.9.0
4
4
  Summary: An AST-based static analyzer that hunts real correctness and async-safety bugs in Python code.
5
5
  Project-URL: Homepage, https://github.com/kratos0718/codehound
6
6
  Project-URL: Issues, https://github.com/kratos0718/codehound/issues
@@ -25,7 +25,7 @@ Description-Content-Type: text/markdown
25
25
 
26
26
  <h1 align="center">codehound</h1>
27
27
 
28
- **An AST-based static analyzer that hunts *real* bugs in large Python codebases — thirty-one checks, eight backed by a bug that was actually found and merged (or opened as a PR) into a major open-source AI framework, the rest hardening rules verified against real false positives across a ~29-framework validation corpus instead of just reasoned about.**
28
+ **An AST-based static analyzer that hunts *real* bugs in large Python codebases — thirty-three checks, eight backed by a bug that was actually found and merged (or opened as a PR) into a major open-source AI framework, the rest hardening rules verified against real false positives across a ~29-framework validation corpus instead of just reasoned about.**
29
29
 
30
30
  [![CI](https://github.com/kratos0718/codehound/actions/workflows/ci.yml/badge.svg)](https://github.com/kratos0718/codehound/actions/workflows/ci.yml)
31
31
  [![PyPI](https://img.shields.io/pypi/v/codehound.svg)](https://pypi.org/project/codehound/)
@@ -68,7 +68,13 @@ I was contributing bug fixes to large AI frameworks and noticed the same handful
68
68
 
69
69
  ## How this compares
70
70
 
71
- Being upfront about overlap: `codehound` is not the only tool that catches some of these patterns, and pretending otherwise wouldn't survive five minutes of someone actually checking. [Ruff](https://docs.astral.sh/ruff/)'s `RUF006` already catches a discarded `asyncio.create_task()` (CH006), `flake8-async`'s `ASYNC300` predates it. Ruff's `RUF012` already catches mutable class-level defaults (CH026), `F632` catches `is`-literal comparisons (CH025), `B006`/`UP005`/`E722` cover mutable-default-arguments/deprecated-unittest-aliases/bare-except (CH002/CH024/CH020). Pylint's `W1518` (`method-cache-max-size-none`) is close to a name-for-name match for CH011's `lru_cache`-on-instance-method leak. If you already run ruff and pylint, several of `codehound`'s checks will feel familiar.
71
+ Being upfront about overlap: `codehound` is not the only tool that catches some of these patterns, and pretending otherwise wouldn't survive five minutes of someone actually checking. [Ruff](https://docs.astral.sh/ruff/)'s `RUF006` already catches a discarded `asyncio.create_task()` (CH006), `flake8-async`'s `ASYNC300` predates it. Ruff's `RUF012` already catches mutable class-level defaults (CH026), `F632` catches `is`-literal comparisons (CH025), `B006`/`UP005`/`E722` cover mutable-default-arguments/deprecated-unittest-aliases/bare-except (CH002/CH024/CH020). Pylint's `W1518` (`method-cache-max-size-none`) is close to a name-for-name match for CH011's `lru_cache`-on-instance-method leak. flake8-bugbear's `B012` also overlaps with CH029 (`return`/`break`/`continue` in `finally:`), though CH029 is narrower — bugbear also flags a bare `continue` inside a `finally:` loop body, which this project hasn't verified has the same swallowed-exception risk in every case. If you already run ruff and pylint, several of `codehound`'s checks will feel familiar.
72
+
73
+ Three checks are explicit adaptations of a flake8-bugbear idea, kept deliberately narrower than the source rule after checking where the broader version's false-positive risk actually lands:
74
+
75
+ - **CH010** extends to cover a nested `def` capturing a loop variable, the same shape bugbear's `B023` covers alongside its lambda case — the same storage-based precision guard (only fires if the function is actually stored past the iteration) applies to both.
76
+ - **CH032** takes bugbear's `B008` idea — "a call as a default argument is suspicious" — and narrows it to a curated list of ten functions (`time.time`, `datetime.now`, `random.random`, `uuid.uuid4`, …) whose result is *never* sensibly the same across calls. B008 as written also flags `def f(x=some_factory()):`, which is frequently a deliberate compute-once memoization; that ambiguity is exactly why this project didn't just port the broader rule.
77
+ - **CH033** takes `B005`'s "`.strip()` with a multi-character argument is misleading" and adds one precision pass B005 doesn't: skip the argument entirely when it contains no letter or digit. Scanning ~30 real frameworks turned up over a hundred multi-character `.strip()` calls, and the overwhelming majority — `.strip('\r\n')`, `.strip('[]')`, `.strip('\'"')`, box-drawing tree glyphs — were deliberate, correct uses of the character-*set* semantics, not the substring mistake the rule exists to catch. Only the argument that reads as a word or token (`data:`, `/v1`, `THREAD#`) is the real bug; a bag of punctuation isn't. Full before/after counts in [`docs/FINDINGS.md`](docs/FINDINGS.md).
72
78
 
73
79
  What actually seems to be missing elsewhere, as far as I've been able to find:
74
80
 
@@ -88,7 +94,7 @@ And a difference in kind, not just coverage: every check here is checked against
88
94
  pip install codehound
89
95
  ```
90
96
 
91
- Zero dependencies — it's ~4,000 lines on top of the standard-library `ast` module, so this installs instantly and runs fully offline, no API key or network call involved.
97
+ Zero dependencies — it's ~4,300 lines on top of the standard-library `ast` module, so this installs instantly and runs fully offline, no API key or network call involved.
92
98
 
93
99
  <details>
94
100
  <summary>From a clone instead (for development)</summary>
@@ -181,7 +187,7 @@ Uploads findings to the repo's **Security → Code Scanning** tab via SARIF, in
181
187
  ```yaml
182
188
  repos:
183
189
  - repo: https://github.com/kratos0718/codehound
184
- rev: v1.8.0
190
+ rev: v1.9.0
185
191
  hooks:
186
192
  - id: codehound
187
193
  ```
@@ -201,7 +207,7 @@ repos:
201
207
  | **CH007** | `unawaited-coroutine-call` | `foo()` where `foo` is `async def`, called as a bare statement — no `await`, no scheduling. The coroutine object is created and dropped; the body **never runs at all**. | hardening rule — see below |
202
208
  | **CH008** | `asyncio-run-in-running-loop` | `asyncio.run(...)` called from inside an `async def` — always raises `RuntimeError`, immediately, every time. | hardening rule — zero corpus hits (see below) |
203
209
  | **CH009** | `floating-thread` | A non-daemon `threading.Thread` that's `.start()`ed but never `.join()`ed — the thread analog of CH006. | hardening rule — see below |
204
- | **CH010** | `loop-closure-capture` | A `lambda` inside a `for` loop (or comprehension) that's *stored* (appended, assigned, returned) and captures the loop variable by reference — every stored instance ends up sharing the loop's **final** value. | **accelerate** (HuggingFace) — `MegatronEngine.get_module_config`'s `param_sync_func` list, PR #4273 |
210
+ | **CH010** | `loop-closure-capture` | A `lambda` *or* nested `def` inside a `for` loop (or comprehension) that's *stored* (appended, assigned, returned) and captures the loop variable by reference — every stored instance ends up sharing the loop's **final** value. | **accelerate** (HuggingFace) — `MegatronEngine.get_module_config`'s `param_sync_func` list, PR #4273 |
205
211
  | **CH011** | `lru-cache-on-method` | `@lru_cache`/`@cache` decorating an instance method — the cache holds a strong reference to `self` forever, so every instance that ever calls the method leaks for the process lifetime. | **optuna** — `_FanovaTree`'s node-lookup methods leaked every tree built for a `get_param_importances()` call; **llama_index** — `VectaraIndex._get_corpus_key` leaked the index *and* broke its own `__del__`-based HTTP session cleanup; **litellm** — `Router._cached_get_model_group_info` leaked every `Router` even after its own documented `discard()` cleanup |
206
212
  | **CH012** | `floating-process` | A non-daemon `multiprocessing.Process` that's `.start()`ed but never `.join()`ed — the process analog of CH009. | hardening rule |
207
213
  | **CH013** | `discarded-future` | `ThreadPoolExecutor`/`ProcessPoolExecutor.submit(...)` called as a bare statement — the returned `Future` (and any exception raised inside the submitted work) is silently discarded. | hardening rule — real hits in litellm, accelerate, langchain |
@@ -223,6 +229,8 @@ repos:
223
229
  | **CH029** | `finally-swallows-exception` | `return`/`break`/`continue` in a `finally:` block silently discards any exception from the `try:` — the caller never sees it. | hardening rule — real hits in letta |
224
230
  | **CH030** | `lru-cache-on-async-function` | `@lru_cache`/`@cache` on `async def` caches the coroutine *object*, not its result — the second call with the same arguments crashes. | hardening rule |
225
231
  | **CH031** | `unclosed-pool` | `multiprocessing.Pool()` never `.close()`d/`.terminate()`d — worker processes leak for the life of the parent. | hardening rule |
232
+ | **CH032** | `nondeterministic-default-argument` | A default argument computed from `time.time()`/`datetime.now()`/`random.random()`/`uuid.uuid4()` etc. — evaluated once at definition time, so every call using the default gets the *same* value forever. (inspired by flake8-bugbear B008, narrowed to a curated function list — see below) | hardening rule — real hit in litellm (`BudgetManager.create_budget`'s `created_at=time.time()` default) |
233
+ | **CH033** | `strip-multichar-argument` | `.strip()`/`.lstrip()`/`.rstrip()` called with a multi-character string that contains a letter or digit — `str.strip(chars)` removes any of those *characters*, not the substring, from each end. (inspired by flake8-bugbear B005, narrowed to skip punctuation-only character sets — see below) | hardening rule — real hit in huggingface_hub (SSE parsing: `line.lstrip("data:").rstrip("/n")`, the second almost certainly meant `"\n"`) |
226
234
 
227
235
  `codehound list` prints this from the source of truth.
228
236
 
@@ -473,7 +481,7 @@ codehound/
473
481
 
474
482
  Each check receives a parsed `ast` tree plus the precomputed parent map and returns `Finding`s. Adding a rule is one file + one registry line + a test. See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for a full walkthrough of the engine, the parent map, and the design decisions.
475
483
 
476
- **False-positive discipline is a feature.** CH005 won't flag a handle that's `return`ed (the caller owns it) or explicitly `.close()`d. CH006 won't flag `TaskGroup.create_task` (the group holds the reference). CH001 only fires when the *enclosing* function is `async`. CH007 scopes `self.foo()` matches to async methods on the *same* class as the call site, and bare `foo()` matches to module-level async functions that aren't shadowed by a same-named parameter. CH009 doesn't flag a thread handed off as *any* object's attribute, not just `self`. CH010 only fires when a lambda is directly stored (appended, assigned, returned), not merely passed as a callback argument that gets consumed on the spot. CH016 doesn't flag a socket returned as part of a tuple/list, or passed as an argument to any call (as opposed to being the receiver of a call on itself) — real patterns found in vllm's rendezvous code. CH020 won't flag a `BaseException` handler whose bound name is actually referenced, or whose body re-raises anywhere in its own scope (not counting a nested try/except's own handler) — both real patterns found in agno. CH021 doesn't flag a relative import (`node.level != 0`) of a same-named local module, or an import already inside a `try:`/`except ImportError:` fallback — real patterns found in vllm and agno respectively. CH025 pairs each chained comparison's op with only its own adjacent operands, rather than matching a literal and an `is`/`is not` anywhere in the same chain independently — a real pattern found in litellm. CH027 and CH028 both recognize a handle stored as *any* object's attribute as a hand-off, matching CH009/CH016's precedent — real patterns found in dspy and weaviate-python-client respectively. CH028 also only trusts a bare `Timer(...)` when `from threading import Timer` was actually seen — real hits in agno were its own unrelated stopwatch class. CH029 skips a `try` whose `except` clauses never re-raise anywhere in their own scope — a real pattern in letta where the exception is deliberately logged and recorded, never propagated, so a `return` in `finally` isn't discarding anything live. All of those guards exist because of real false positives caught while building the checks (see above and [`docs/FINDINGS.md`](docs/FINDINGS.md)). The test suite asserts both "bad code is flagged" and "correct code is not."
484
+ **False-positive discipline is a feature.** CH005 won't flag a handle that's `return`ed (the caller owns it) or explicitly `.close()`d. CH006 won't flag `TaskGroup.create_task` (the group holds the reference). CH001 only fires when the *enclosing* function is `async`. CH007 scopes `self.foo()` matches to async methods on the *same* class as the call site, and bare `foo()` matches to module-level async functions that aren't shadowed by a same-named parameter. CH009 doesn't flag a thread handed off as *any* object's attribute, not just `self`. CH010 only fires when a lambda is directly stored (appended, assigned, returned), not merely passed as a callback argument that gets consumed on the spot. CH016 doesn't flag a socket returned as part of a tuple/list, or passed as an argument to any call (as opposed to being the receiver of a call on itself) — real patterns found in vllm's rendezvous code. CH020 won't flag a `BaseException` handler whose bound name is actually referenced, or whose body re-raises anywhere in its own scope (not counting a nested try/except's own handler) — both real patterns found in agno. CH021 doesn't flag a relative import (`node.level != 0`) of a same-named local module, or an import already inside a `try:`/`except ImportError:` fallback — real patterns found in vllm and agno respectively. CH025 pairs each chained comparison's op with only its own adjacent operands, rather than matching a literal and an `is`/`is not` anywhere in the same chain independently — a real pattern found in litellm. CH027 and CH028 both recognize a handle stored as *any* object's attribute as a hand-off, matching CH009/CH016's precedent — real patterns found in dspy and weaviate-python-client respectively. CH028 also only trusts a bare `Timer(...)` when `from threading import Timer` was actually seen — real hits in agno were its own unrelated stopwatch class. CH029 skips a `try` whose `except` clauses never re-raise anywhere in their own scope — a real pattern in letta where the exception is deliberately logged and recorded, never propagated, so a `return` in `finally` isn't discarding anything live. CH033 skips a `.strip()` argument that's every character the same (`.strip('```')`) or made entirely of punctuation/whitespace with no letter or digit (`.strip('\r\n')`, `.strip('[]')`) — real patterns found across nearly every framework scanned, all deliberate uses of the character-*set* semantics rather than the substring mistake the check exists to catch. All of those guards exist because of real false positives caught while building the checks (see above and [`docs/FINDINGS.md`](docs/FINDINGS.md)). The test suite asserts both "bad code is flagged" and "correct code is not."
477
485
 
478
486
  ---
479
487
 
@@ -517,11 +525,14 @@ Every check has paired tests: the buggy pattern *is* flagged, and the idiomatic
517
525
  - [x] `--fix` — CH017 always, CH004 only inside `async def` (CH002/CH003
518
526
  turned out to need judgment calls or import-injection this tool
519
527
  won't guess at, so they stay detection-only; see docs/ARCHITECTURE.md)
520
- - [ ] Cross-module resolution for CH007/CH009 (currently same-file only)
521
- - [ ] Extend CH001 to a curated denylist of sync AI/agent SDK client calls inside async functions (vector-DB clients, LLM SDKs) — the gap flake8-async's stdlib-only denylist leaves open
522
528
  - [x] Parallelize scanning across files for large codebases — a full
523
529
  HuggingFace transformers scan went from 57s to 12s (measured,
524
530
  byte-identical output verified against the sequential run)
531
+ - [x] 33 checks — nested-`def` loop-closure capture alongside lambdas
532
+ (CH010, same shape as bugbear's B023), nondeterministic default
533
+ arguments, multi-character `.strip()` arguments — CH032-CH033
534
+ - [ ] Cross-module resolution for CH007/CH009 (currently same-file only)
535
+ - [ ] Extend CH001 to a curated denylist of sync AI/agent SDK client calls inside async functions (vector-DB clients, LLM SDKs) — the gap flake8-async's stdlib-only denylist leaves open
525
536
 
526
537
  ---
527
538
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  <h1 align="center">codehound</h1>
6
6
 
7
- **An AST-based static analyzer that hunts *real* bugs in large Python codebases — thirty-one checks, eight backed by a bug that was actually found and merged (or opened as a PR) into a major open-source AI framework, the rest hardening rules verified against real false positives across a ~29-framework validation corpus instead of just reasoned about.**
7
+ **An AST-based static analyzer that hunts *real* bugs in large Python codebases — thirty-three checks, eight backed by a bug that was actually found and merged (or opened as a PR) into a major open-source AI framework, the rest hardening rules verified against real false positives across a ~29-framework validation corpus instead of just reasoned about.**
8
8
 
9
9
  [![CI](https://github.com/kratos0718/codehound/actions/workflows/ci.yml/badge.svg)](https://github.com/kratos0718/codehound/actions/workflows/ci.yml)
10
10
  [![PyPI](https://img.shields.io/pypi/v/codehound.svg)](https://pypi.org/project/codehound/)
@@ -47,7 +47,13 @@ I was contributing bug fixes to large AI frameworks and noticed the same handful
47
47
 
48
48
  ## How this compares
49
49
 
50
- Being upfront about overlap: `codehound` is not the only tool that catches some of these patterns, and pretending otherwise wouldn't survive five minutes of someone actually checking. [Ruff](https://docs.astral.sh/ruff/)'s `RUF006` already catches a discarded `asyncio.create_task()` (CH006), `flake8-async`'s `ASYNC300` predates it. Ruff's `RUF012` already catches mutable class-level defaults (CH026), `F632` catches `is`-literal comparisons (CH025), `B006`/`UP005`/`E722` cover mutable-default-arguments/deprecated-unittest-aliases/bare-except (CH002/CH024/CH020). Pylint's `W1518` (`method-cache-max-size-none`) is close to a name-for-name match for CH011's `lru_cache`-on-instance-method leak. If you already run ruff and pylint, several of `codehound`'s checks will feel familiar.
50
+ Being upfront about overlap: `codehound` is not the only tool that catches some of these patterns, and pretending otherwise wouldn't survive five minutes of someone actually checking. [Ruff](https://docs.astral.sh/ruff/)'s `RUF006` already catches a discarded `asyncio.create_task()` (CH006), `flake8-async`'s `ASYNC300` predates it. Ruff's `RUF012` already catches mutable class-level defaults (CH026), `F632` catches `is`-literal comparisons (CH025), `B006`/`UP005`/`E722` cover mutable-default-arguments/deprecated-unittest-aliases/bare-except (CH002/CH024/CH020). Pylint's `W1518` (`method-cache-max-size-none`) is close to a name-for-name match for CH011's `lru_cache`-on-instance-method leak. flake8-bugbear's `B012` also overlaps with CH029 (`return`/`break`/`continue` in `finally:`), though CH029 is narrower — bugbear also flags a bare `continue` inside a `finally:` loop body, which this project hasn't verified has the same swallowed-exception risk in every case. If you already run ruff and pylint, several of `codehound`'s checks will feel familiar.
51
+
52
+ Three checks are explicit adaptations of a flake8-bugbear idea, kept deliberately narrower than the source rule after checking where the broader version's false-positive risk actually lands:
53
+
54
+ - **CH010** extends to cover a nested `def` capturing a loop variable, the same shape bugbear's `B023` covers alongside its lambda case — the same storage-based precision guard (only fires if the function is actually stored past the iteration) applies to both.
55
+ - **CH032** takes bugbear's `B008` idea — "a call as a default argument is suspicious" — and narrows it to a curated list of ten functions (`time.time`, `datetime.now`, `random.random`, `uuid.uuid4`, …) whose result is *never* sensibly the same across calls. B008 as written also flags `def f(x=some_factory()):`, which is frequently a deliberate compute-once memoization; that ambiguity is exactly why this project didn't just port the broader rule.
56
+ - **CH033** takes `B005`'s "`.strip()` with a multi-character argument is misleading" and adds one precision pass B005 doesn't: skip the argument entirely when it contains no letter or digit. Scanning ~30 real frameworks turned up over a hundred multi-character `.strip()` calls, and the overwhelming majority — `.strip('\r\n')`, `.strip('[]')`, `.strip('\'"')`, box-drawing tree glyphs — were deliberate, correct uses of the character-*set* semantics, not the substring mistake the rule exists to catch. Only the argument that reads as a word or token (`data:`, `/v1`, `THREAD#`) is the real bug; a bag of punctuation isn't. Full before/after counts in [`docs/FINDINGS.md`](docs/FINDINGS.md).
51
57
 
52
58
  What actually seems to be missing elsewhere, as far as I've been able to find:
53
59
 
@@ -67,7 +73,7 @@ And a difference in kind, not just coverage: every check here is checked against
67
73
  pip install codehound
68
74
  ```
69
75
 
70
- Zero dependencies — it's ~4,000 lines on top of the standard-library `ast` module, so this installs instantly and runs fully offline, no API key or network call involved.
76
+ Zero dependencies — it's ~4,300 lines on top of the standard-library `ast` module, so this installs instantly and runs fully offline, no API key or network call involved.
71
77
 
72
78
  <details>
73
79
  <summary>From a clone instead (for development)</summary>
@@ -160,7 +166,7 @@ Uploads findings to the repo's **Security → Code Scanning** tab via SARIF, in
160
166
  ```yaml
161
167
  repos:
162
168
  - repo: https://github.com/kratos0718/codehound
163
- rev: v1.8.0
169
+ rev: v1.9.0
164
170
  hooks:
165
171
  - id: codehound
166
172
  ```
@@ -180,7 +186,7 @@ repos:
180
186
  | **CH007** | `unawaited-coroutine-call` | `foo()` where `foo` is `async def`, called as a bare statement — no `await`, no scheduling. The coroutine object is created and dropped; the body **never runs at all**. | hardening rule — see below |
181
187
  | **CH008** | `asyncio-run-in-running-loop` | `asyncio.run(...)` called from inside an `async def` — always raises `RuntimeError`, immediately, every time. | hardening rule — zero corpus hits (see below) |
182
188
  | **CH009** | `floating-thread` | A non-daemon `threading.Thread` that's `.start()`ed but never `.join()`ed — the thread analog of CH006. | hardening rule — see below |
183
- | **CH010** | `loop-closure-capture` | A `lambda` inside a `for` loop (or comprehension) that's *stored* (appended, assigned, returned) and captures the loop variable by reference — every stored instance ends up sharing the loop's **final** value. | **accelerate** (HuggingFace) — `MegatronEngine.get_module_config`'s `param_sync_func` list, PR #4273 |
189
+ | **CH010** | `loop-closure-capture` | A `lambda` *or* nested `def` inside a `for` loop (or comprehension) that's *stored* (appended, assigned, returned) and captures the loop variable by reference — every stored instance ends up sharing the loop's **final** value. | **accelerate** (HuggingFace) — `MegatronEngine.get_module_config`'s `param_sync_func` list, PR #4273 |
184
190
  | **CH011** | `lru-cache-on-method` | `@lru_cache`/`@cache` decorating an instance method — the cache holds a strong reference to `self` forever, so every instance that ever calls the method leaks for the process lifetime. | **optuna** — `_FanovaTree`'s node-lookup methods leaked every tree built for a `get_param_importances()` call; **llama_index** — `VectaraIndex._get_corpus_key` leaked the index *and* broke its own `__del__`-based HTTP session cleanup; **litellm** — `Router._cached_get_model_group_info` leaked every `Router` even after its own documented `discard()` cleanup |
185
191
  | **CH012** | `floating-process` | A non-daemon `multiprocessing.Process` that's `.start()`ed but never `.join()`ed — the process analog of CH009. | hardening rule |
186
192
  | **CH013** | `discarded-future` | `ThreadPoolExecutor`/`ProcessPoolExecutor.submit(...)` called as a bare statement — the returned `Future` (and any exception raised inside the submitted work) is silently discarded. | hardening rule — real hits in litellm, accelerate, langchain |
@@ -202,6 +208,8 @@ repos:
202
208
  | **CH029** | `finally-swallows-exception` | `return`/`break`/`continue` in a `finally:` block silently discards any exception from the `try:` — the caller never sees it. | hardening rule — real hits in letta |
203
209
  | **CH030** | `lru-cache-on-async-function` | `@lru_cache`/`@cache` on `async def` caches the coroutine *object*, not its result — the second call with the same arguments crashes. | hardening rule |
204
210
  | **CH031** | `unclosed-pool` | `multiprocessing.Pool()` never `.close()`d/`.terminate()`d — worker processes leak for the life of the parent. | hardening rule |
211
+ | **CH032** | `nondeterministic-default-argument` | A default argument computed from `time.time()`/`datetime.now()`/`random.random()`/`uuid.uuid4()` etc. — evaluated once at definition time, so every call using the default gets the *same* value forever. (inspired by flake8-bugbear B008, narrowed to a curated function list — see below) | hardening rule — real hit in litellm (`BudgetManager.create_budget`'s `created_at=time.time()` default) |
212
+ | **CH033** | `strip-multichar-argument` | `.strip()`/`.lstrip()`/`.rstrip()` called with a multi-character string that contains a letter or digit — `str.strip(chars)` removes any of those *characters*, not the substring, from each end. (inspired by flake8-bugbear B005, narrowed to skip punctuation-only character sets — see below) | hardening rule — real hit in huggingface_hub (SSE parsing: `line.lstrip("data:").rstrip("/n")`, the second almost certainly meant `"\n"`) |
205
213
 
206
214
  `codehound list` prints this from the source of truth.
207
215
 
@@ -452,7 +460,7 @@ codehound/
452
460
 
453
461
  Each check receives a parsed `ast` tree plus the precomputed parent map and returns `Finding`s. Adding a rule is one file + one registry line + a test. See [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for a full walkthrough of the engine, the parent map, and the design decisions.
454
462
 
455
- **False-positive discipline is a feature.** CH005 won't flag a handle that's `return`ed (the caller owns it) or explicitly `.close()`d. CH006 won't flag `TaskGroup.create_task` (the group holds the reference). CH001 only fires when the *enclosing* function is `async`. CH007 scopes `self.foo()` matches to async methods on the *same* class as the call site, and bare `foo()` matches to module-level async functions that aren't shadowed by a same-named parameter. CH009 doesn't flag a thread handed off as *any* object's attribute, not just `self`. CH010 only fires when a lambda is directly stored (appended, assigned, returned), not merely passed as a callback argument that gets consumed on the spot. CH016 doesn't flag a socket returned as part of a tuple/list, or passed as an argument to any call (as opposed to being the receiver of a call on itself) — real patterns found in vllm's rendezvous code. CH020 won't flag a `BaseException` handler whose bound name is actually referenced, or whose body re-raises anywhere in its own scope (not counting a nested try/except's own handler) — both real patterns found in agno. CH021 doesn't flag a relative import (`node.level != 0`) of a same-named local module, or an import already inside a `try:`/`except ImportError:` fallback — real patterns found in vllm and agno respectively. CH025 pairs each chained comparison's op with only its own adjacent operands, rather than matching a literal and an `is`/`is not` anywhere in the same chain independently — a real pattern found in litellm. CH027 and CH028 both recognize a handle stored as *any* object's attribute as a hand-off, matching CH009/CH016's precedent — real patterns found in dspy and weaviate-python-client respectively. CH028 also only trusts a bare `Timer(...)` when `from threading import Timer` was actually seen — real hits in agno were its own unrelated stopwatch class. CH029 skips a `try` whose `except` clauses never re-raise anywhere in their own scope — a real pattern in letta where the exception is deliberately logged and recorded, never propagated, so a `return` in `finally` isn't discarding anything live. All of those guards exist because of real false positives caught while building the checks (see above and [`docs/FINDINGS.md`](docs/FINDINGS.md)). The test suite asserts both "bad code is flagged" and "correct code is not."
463
+ **False-positive discipline is a feature.** CH005 won't flag a handle that's `return`ed (the caller owns it) or explicitly `.close()`d. CH006 won't flag `TaskGroup.create_task` (the group holds the reference). CH001 only fires when the *enclosing* function is `async`. CH007 scopes `self.foo()` matches to async methods on the *same* class as the call site, and bare `foo()` matches to module-level async functions that aren't shadowed by a same-named parameter. CH009 doesn't flag a thread handed off as *any* object's attribute, not just `self`. CH010 only fires when a lambda is directly stored (appended, assigned, returned), not merely passed as a callback argument that gets consumed on the spot. CH016 doesn't flag a socket returned as part of a tuple/list, or passed as an argument to any call (as opposed to being the receiver of a call on itself) — real patterns found in vllm's rendezvous code. CH020 won't flag a `BaseException` handler whose bound name is actually referenced, or whose body re-raises anywhere in its own scope (not counting a nested try/except's own handler) — both real patterns found in agno. CH021 doesn't flag a relative import (`node.level != 0`) of a same-named local module, or an import already inside a `try:`/`except ImportError:` fallback — real patterns found in vllm and agno respectively. CH025 pairs each chained comparison's op with only its own adjacent operands, rather than matching a literal and an `is`/`is not` anywhere in the same chain independently — a real pattern found in litellm. CH027 and CH028 both recognize a handle stored as *any* object's attribute as a hand-off, matching CH009/CH016's precedent — real patterns found in dspy and weaviate-python-client respectively. CH028 also only trusts a bare `Timer(...)` when `from threading import Timer` was actually seen — real hits in agno were its own unrelated stopwatch class. CH029 skips a `try` whose `except` clauses never re-raise anywhere in their own scope — a real pattern in letta where the exception is deliberately logged and recorded, never propagated, so a `return` in `finally` isn't discarding anything live. CH033 skips a `.strip()` argument that's every character the same (`.strip('```')`) or made entirely of punctuation/whitespace with no letter or digit (`.strip('\r\n')`, `.strip('[]')`) — real patterns found across nearly every framework scanned, all deliberate uses of the character-*set* semantics rather than the substring mistake the check exists to catch. All of those guards exist because of real false positives caught while building the checks (see above and [`docs/FINDINGS.md`](docs/FINDINGS.md)). The test suite asserts both "bad code is flagged" and "correct code is not."
456
464
 
457
465
  ---
458
466
 
@@ -496,11 +504,14 @@ Every check has paired tests: the buggy pattern *is* flagged, and the idiomatic
496
504
  - [x] `--fix` — CH017 always, CH004 only inside `async def` (CH002/CH003
497
505
  turned out to need judgment calls or import-injection this tool
498
506
  won't guess at, so they stay detection-only; see docs/ARCHITECTURE.md)
499
- - [ ] Cross-module resolution for CH007/CH009 (currently same-file only)
500
- - [ ] Extend CH001 to a curated denylist of sync AI/agent SDK client calls inside async functions (vector-DB clients, LLM SDKs) — the gap flake8-async's stdlib-only denylist leaves open
501
507
  - [x] Parallelize scanning across files for large codebases — a full
502
508
  HuggingFace transformers scan went from 57s to 12s (measured,
503
509
  byte-identical output verified against the sequential run)
510
+ - [x] 33 checks — nested-`def` loop-closure capture alongside lambdas
511
+ (CH010, same shape as bugbear's B023), nondeterministic default
512
+ arguments, multi-character `.strip()` arguments — CH032-CH033
513
+ - [ ] Cross-module resolution for CH007/CH009 (currently same-file only)
514
+ - [ ] Extend CH001 to a curated denylist of sync AI/agent SDK client calls inside async functions (vector-DB clients, LLM SDKs) — the gap flake8-async's stdlib-only denylist leaves open
504
515
 
505
516
  ---
506
517
 
@@ -1,9 +1,9 @@
1
1
  """codehound - an AST-based static analyzer that hunts real bugs in Python code.
2
2
 
3
- Thirty-one checks. Eight are each backed by a bug that was actually
3
+ Thirty-three checks. Eight are each backed by a bug that was actually
4
4
  found and fixed (or opened as a PR) in a popular open-source AI framework
5
5
  (agno, crewAI, mem0, llama_index, accelerate, optuna, litellm). The rest
6
- (CH007-CH009, CH012-CH031) are hardening rules verified against real
6
+ (CH007-CH009, CH012-CH033) are hardening rules verified against real
7
7
  false positives across a ~29-framework validation corpus instead - see
8
8
  docs/FINDINGS.md.
9
9
 
@@ -19,7 +19,7 @@ from __future__ import annotations
19
19
  from codehound.checks import ALL_CHECKS, get_checks
20
20
  from codehound.core import Check, Finding, scan_file, scan_files, scan_path
21
21
 
22
- __version__ = "1.8.0"
22
+ __version__ = "1.9.0"
23
23
 
24
24
  __all__ = [
25
25
  "ALL_CHECKS",
@@ -22,11 +22,13 @@ from codehound.checks.lru_cache_on_async_function import LruCacheOnAsyncFunction
22
22
  from codehound.checks.lru_cache_on_method import LruCacheOnMethod
23
23
  from codehound.checks.mutable_class_attribute import MutableClassAttribute
24
24
  from codehound.checks.mutable_defaults import MutableDefaultArgument
25
+ from codehound.checks.nondeterministic_default import NondeterministicDefault
25
26
  from codehound.checks.removed_asyncio_task_methods import RemovedAsyncioTaskMethods
26
27
  from codehound.checks.removed_getargspec import RemovedGetargspec
27
28
  from codehound.checks.removed_stdlib_attribute import RemovedStdlibAttribute
28
29
  from codehound.checks.removed_stdlib_module import RemovedStdlibModule
29
30
  from codehound.checks.resource_leak import UnclosedFileHandle
31
+ from codehound.checks.strip_multichar import StripMultichar
30
32
  from codehound.checks.unawaited_coroutine import UnawaitedCoroutineCall
31
33
  from codehound.checks.unclosed_pool import UnclosedPool
32
34
  from codehound.checks.unclosed_socket import UnclosedSocket
@@ -67,6 +69,8 @@ ALL_CHECKS: list[type[Check]] = [
67
69
  FinallySwallowsException,
68
70
  LruCacheOnAsyncFunction,
69
71
  UnclosedPool,
72
+ NondeterministicDefault,
73
+ StripMultichar,
70
74
  ]
71
75
 
72
76
 
@@ -29,6 +29,14 @@ Comprehensions (`` [lambda: i for i in range(3)] ``) are the one
29
29
  exception: the ``elt``/``key``/``value`` position *is* inherently the
30
30
  "produce and store" position, so no extra storage-context check is
31
31
  needed there.
32
+
33
+ Same bug, same fix, different syntax: a nested ``def`` inside a ``for``
34
+ loop captures the loop variable exactly the same way a lambda does -
35
+ flake8-bugbear's B023 covers both shapes under one rule, and this check
36
+ now does too. ``def`` is a statement, not an expression, so "is it
37
+ stored" means something different: the function's *name* has to show up
38
+ later in a storage position (appended, assigned, returned), not the
39
+ ``def`` itself.
32
40
  """
33
41
 
34
42
  from __future__ import annotations
@@ -54,6 +62,53 @@ def _references_name_unshadowed(lam: ast.Lambda, name: str) -> bool:
54
62
  return False
55
63
 
56
64
 
65
+ def _references_name_in_body(funcdef: ast.FunctionDef | ast.AsyncFunctionDef, name: str) -> bool:
66
+ """Like ``_references_name_unshadowed`` but for a ``def``'s own
67
+ parameters and statement body rather than a lambda's params and
68
+ single expression - a same-named parameter shadows the outer loop
69
+ variable exactly like it would for a lambda."""
70
+ args = funcdef.args
71
+ param_names = {a.arg for a in (args.posonlyargs + args.args + args.kwonlyargs)}
72
+ if args.vararg:
73
+ param_names.add(args.vararg.arg)
74
+ if args.kwarg:
75
+ param_names.add(args.kwarg.arg)
76
+ if name in param_names:
77
+ return False
78
+ for stmt in funcdef.body:
79
+ for node in ast.walk(stmt):
80
+ if isinstance(node, ast.Name) and node.id == name and isinstance(node.ctx, ast.Load):
81
+ return True
82
+ return False
83
+
84
+
85
+ def _name_is_stored(name: str, loop_body: list[ast.stmt], parents: dict) -> bool:
86
+ """True if `name` (a nested def's own name) is later used in a
87
+ storage position anywhere in the loop body: assigned, returned/
88
+ yielded, or passed to `.append()`/`.add()` - same storage shapes
89
+ `_is_stored` recognizes for a lambda, just checked via the Name
90
+ reference's parent instead of the def statement's own parent, since
91
+ a `def` can't be the direct value of an assignment the way a lambda
92
+ expression can."""
93
+ for stmt in loop_body:
94
+ for node in ast.walk(stmt):
95
+ if not (isinstance(node, ast.Name) and node.id == name and isinstance(node.ctx, ast.Load)):
96
+ continue
97
+ parent = parents.get(id(node))
98
+ if isinstance(parent, (ast.Assign, ast.AnnAssign)) and parent.value is node:
99
+ return True
100
+ if isinstance(parent, (ast.Return, ast.Yield)) and parent.value is node:
101
+ return True
102
+ if (
103
+ isinstance(parent, ast.Call)
104
+ and isinstance(parent.func, ast.Attribute)
105
+ and parent.func.attr in _STORAGE_METHODS
106
+ and node in parent.args
107
+ ):
108
+ return True
109
+ return False
110
+
111
+
57
112
  def _is_stored(lam: ast.Lambda, parents: dict) -> bool:
58
113
  """True only if the lambda is directly stored somewhere that outlives
59
114
  this loop iteration - not merely passed as a callback argument to a
@@ -120,4 +175,35 @@ class LoopClosureCapture(Check):
120
175
  )
121
176
  )
122
177
  break
178
+
179
+ # Same bug, `def` instead of `lambda`: a nested function
180
+ # defined directly in a `for` loop's body, capturing the loop
181
+ # variable, whose *name* (not the def itself) is later stored
182
+ # somewhere that outlives this iteration.
183
+ if isinstance(loop, ast.For) and isinstance(loop.target, ast.Name):
184
+ var = loop.target.id
185
+ for stmt in loop.body:
186
+ if not isinstance(stmt, (ast.FunctionDef, ast.AsyncFunctionDef)):
187
+ continue
188
+ if id(stmt) in seen:
189
+ continue
190
+ if not _references_name_in_body(stmt, var):
191
+ continue
192
+ if not _name_is_stored(stmt.name, loop.body, parents):
193
+ continue
194
+ seen.add(id(stmt))
195
+ findings.append(
196
+ Finding(
197
+ path=path,
198
+ line=stmt.lineno,
199
+ col=stmt.col_offset,
200
+ code=self.code,
201
+ message=(
202
+ f"`{stmt.name}` captures loop variable `{var}` by reference; if "
203
+ f"called after the loop moves on, every instance sees the same "
204
+ f"final value. Bind it explicitly with a default argument, e.g. "
205
+ f"`def {stmt.name}({var}={var}):`."
206
+ ),
207
+ )
208
+ )
123
209
  return findings
@@ -0,0 +1,99 @@
1
+ """CH032 - a default argument computed from a call to a non-deterministic function.
2
+
3
+ A default value is evaluated exactly *once*, when the function is
4
+ defined, not on every call - the same fact CH002 is about, but this is
5
+ a distinct shape: a call to something like `time.time()` or
6
+ `datetime.now()` isn't mutable, so CH002's "shared mutable object" check
7
+ doesn't fire, and it's syntactically identical to a perfectly reasonable
8
+ default like `def f(x=DEFAULT_TIMEOUT):`. What makes it a bug is that
9
+ the *value itself* depends on when it's called, and every default
10
+ argument only ever captures the value from function-definition time.
11
+ Verified directly:
12
+
13
+ def f(x=time.time()):
14
+ return x
15
+
16
+ a = f()
17
+ time.sleep(0.05)
18
+ b = f()
19
+ a == b # True - both calls return the exact same timestamp
20
+
21
+ Deliberately narrow, unlike a general "any call as a default is
22
+ suspicious" rule (flake8-bugbear's B008, which also flags things like
23
+ `def f(x=some_factory()):` that may well be an intentional
24
+ compute-once memoization): this only flags a curated set of functions
25
+ where "the same value every call" can never be what the author wanted -
26
+ the current time, a random number, a new UUID. A generic factory call
27
+ as a default might be deliberate; a cached `time.time()` never is.
28
+ """
29
+
30
+ from __future__ import annotations
31
+
32
+ import ast
33
+
34
+ from codehound.core import Check, Finding
35
+
36
+ # (module, attribute) pairs whose result changes every call and would
37
+ # never sensibly be memoized as a shared default.
38
+ _NONDETERMINISTIC_CALLS: dict[tuple[str, str], str] = {
39
+ ("time", "time"): "time.time()",
40
+ ("time", "monotonic"): "time.monotonic()",
41
+ ("time", "perf_counter"): "time.perf_counter()",
42
+ ("datetime", "now"): "datetime.now()",
43
+ ("datetime", "utcnow"): "datetime.utcnow()",
44
+ ("date", "today"): "date.today()",
45
+ ("random", "random"): "random.random()",
46
+ ("random", "randint"): "random.randint()",
47
+ ("random", "choice"): "random.choice()",
48
+ ("uuid", "uuid4"): "uuid.uuid4()",
49
+ }
50
+
51
+
52
+ def _nondeterministic_call_name(node: ast.expr) -> str | None:
53
+ if not isinstance(node, ast.Call):
54
+ return None
55
+ func = node.func
56
+ if isinstance(func, ast.Attribute) and isinstance(func.value, ast.Name):
57
+ return _NONDETERMINISTIC_CALLS.get((func.value.id, func.attr))
58
+ return None
59
+
60
+
61
+ def _iter_defaults(args: ast.arguments):
62
+ positional = args.posonlyargs + args.args
63
+ for arg, default in zip(reversed(positional), reversed(args.defaults)):
64
+ yield arg, default
65
+ for arg, default in zip(args.kwonlyargs, args.kw_defaults):
66
+ if default is not None:
67
+ yield arg, default
68
+
69
+
70
+ class NondeterministicDefault(Check):
71
+ code = "CH032"
72
+ name = "nondeterministic-default-argument"
73
+ description = "Default argument calls a function (time/random/uuid) whose result changes every call."
74
+
75
+ def run(self, tree: ast.AST, parents: dict, path: str) -> list[Finding]:
76
+ findings: list[Finding] = []
77
+ for node in ast.walk(tree):
78
+ if not isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef, ast.Lambda)):
79
+ continue
80
+ for arg, default in _iter_defaults(node.args):
81
+ call_text = _nondeterministic_call_name(default)
82
+ if call_text is None:
83
+ continue
84
+ name = getattr(node, "name", "<lambda>")
85
+ findings.append(
86
+ Finding(
87
+ path=path,
88
+ line=default.lineno,
89
+ col=default.col_offset,
90
+ code=self.code,
91
+ message=(
92
+ f"default value for `{arg.arg}` in `{name}` calls `{call_text}` - "
93
+ f"evaluated once, at definition time, not on every call. Every "
94
+ f"invocation using the default gets the exact same value. Use "
95
+ f"`{arg.arg}=None` and compute it inside the function body instead."
96
+ ),
97
+ )
98
+ )
99
+ return findings
@@ -0,0 +1,88 @@
1
+ """CH033 - ``.strip()``/``.lstrip()``/``.rstrip()`` called with a multi-character string.
2
+
3
+ `str.strip(chars)` doesn't remove a substring - `chars` is a *set* of
4
+ characters, stripped one at a time from each end for as long as the
5
+ next character matches something in the set. Verified directly, in the
6
+ shape this actually bites people in:
7
+
8
+ "report.txt".strip(".txt") # 'repor' - not 'report'
9
+ "test.txt".strip(".txt") # 'es' - not 'test'
10
+
11
+ Both look like "strip the `.txt` suffix," and both are wrong: the
12
+ trailing `t` in "report" and the leading `t` in "test" are themselves in
13
+ the character set `{'.', 't', 'x'}`, so they get eaten too. This is
14
+ flake8-bugbear's B005, included here because it's exactly the kind of
15
+ subtle, easy-to-write, hard-to-notice correctness bug this project
16
+ exists to catch - the code runs, returns a string, and looks plausible
17
+ at a glance.
18
+
19
+ Scanning ~30 real frameworks turned up over a hundred multi-character
20
+ `.strip()` calls, and the overwhelming majority were deliberate,
21
+ correct uses of the character-*set* semantics: `.strip('\r\n')` to
22
+ absorb either line-ending convention, `.strip('[]')`/`.strip('()')` to
23
+ peel matching brackets, `.strip('\'"')` to drop either quote style,
24
+ `.lstrip('│ ├└─')` to strip box-drawing tree glyphs.
25
+ None of those are "misread as a substring" mistakes - a reader who
26
+ sees a bag of punctuation or whitespace correctly reads it as a set.
27
+ The real mistakes only showed up when the argument contained a letter
28
+ or digit: `.lstrip('data:')` (the SSE "data: " prefix), `.strip('/v1')`
29
+ (an API version suffix), `.strip('THREAD#')`/`.strip('STEP#')` (DynamoDB
30
+ key prefixes), `.rstrip('/n')` (almost certainly a typo for `'\n'`) -
31
+ those really do read like someone meant a prefix or suffix and reached
32
+ for the wrong method.
33
+
34
+ So this only flags a multi-character argument that contains at least
35
+ one letter or digit, and isn't just the same character repeated
36
+ (`.strip('```')` strips one character, backtick, no matter how many
37
+ times it appears in the argument - no charset/substring ambiguity to
38
+ get wrong either).
39
+ """
40
+
41
+ from __future__ import annotations
42
+
43
+ import ast
44
+
45
+ from codehound.core import Check, Finding
46
+
47
+ _STRIP_METHODS = {"strip", "lstrip", "rstrip"}
48
+
49
+
50
+ class StripMultichar(Check):
51
+ code = "CH033"
52
+ name = "strip-multichar-argument"
53
+ description = "str.strip()/.lstrip()/.rstrip() with a multi-character argument strips a character set, not a substring."
54
+
55
+ def run(self, tree: ast.AST, parents: dict, path: str) -> list[Finding]:
56
+ findings: list[Finding] = []
57
+ for node in ast.walk(tree):
58
+ if not (
59
+ isinstance(node, ast.Call)
60
+ and isinstance(node.func, ast.Attribute)
61
+ and node.func.attr in _STRIP_METHODS
62
+ and len(node.args) == 1
63
+ and not node.keywords
64
+ ):
65
+ continue
66
+ arg = node.args[0]
67
+ if not (isinstance(arg, ast.Constant) and isinstance(arg.value, str) and len(arg.value) > 1):
68
+ continue
69
+ chars = arg.value
70
+ if len(set(chars)) == 1:
71
+ continue
72
+ if not any(c.isalnum() for c in chars):
73
+ continue
74
+ findings.append(
75
+ Finding(
76
+ path=path,
77
+ line=node.lineno,
78
+ col=node.col_offset,
79
+ code=self.code,
80
+ message=(
81
+ f"`.{node.func.attr}({arg.value!r})` strips any of these characters "
82
+ f"from each end, not the substring `{arg.value!r}` - "
83
+ f"`{arg.value[0]!r}{arg.value[-1]!r}` and every character in between are "
84
+ f"each removed independently for as long as they keep matching."
85
+ ),
86
+ )
87
+ )
88
+ return findings
@@ -468,6 +468,71 @@ def test_ch010_still_flags_lambda_appended_even_when_named_like_a_key_fn():
468
468
  assert len(findings) == 1
469
469
 
470
470
 
471
+ def test_ch010_flags_nested_def_capturing_loop_variable():
472
+ # Same bug as the lambda case, `def` instead - flake8-bugbear's B023
473
+ # covers this shape too.
474
+ code = (
475
+ "callbacks = []\n"
476
+ "for i in range(3):\n"
477
+ " def handler():\n"
478
+ " return i\n"
479
+ " callbacks.append(handler)\n"
480
+ )
481
+ findings = _run(code, ["CH010"])
482
+ assert len(findings) == 1
483
+ assert findings[0].code == "CH010"
484
+
485
+
486
+ def test_ch010_flags_nested_def_returned():
487
+ code = (
488
+ "def make_handlers():\n"
489
+ " handlers = []\n"
490
+ " for i in range(3):\n"
491
+ " def handler():\n"
492
+ " return i\n"
493
+ " handlers.append(handler)\n"
494
+ " return handlers\n"
495
+ )
496
+ findings = _run(code, ["CH010"])
497
+ assert len(findings) == 1
498
+
499
+
500
+ def test_ch010_ignores_nested_def_shadowed_by_own_parameter():
501
+ # def's own parameter `i` shadows the outer loop variable - the same
502
+ # guard the lambda case already has for lambda i=i: i.
503
+ code = (
504
+ "callbacks = []\n"
505
+ "for i in range(3):\n"
506
+ " def handler(i):\n"
507
+ " return i\n"
508
+ " callbacks.append(handler)\n"
509
+ )
510
+ assert _run(code, ["CH010"]) == []
511
+
512
+
513
+ def test_ch010_ignores_nested_def_not_referencing_loop_var():
514
+ code = (
515
+ "callbacks = []\n"
516
+ "for i in range(3):\n"
517
+ " def handler():\n"
518
+ " return 42\n"
519
+ " callbacks.append(handler)\n"
520
+ )
521
+ assert _run(code, ["CH010"]) == []
522
+
523
+
524
+ def test_ch010_ignores_nested_def_never_stored():
525
+ # Defined and called immediately within the same iteration - nothing
526
+ # outlives the loop, same idea as the immediately-invoked lambda case.
527
+ code = (
528
+ "for i in range(3):\n"
529
+ " def handler():\n"
530
+ " return i\n"
531
+ " print(handler())\n"
532
+ )
533
+ assert _run(code, ["CH010"]) == []
534
+
535
+
471
536
  # --- CH011 lru-cache-on-method ------------------------------------------------------
472
537
 
473
538
 
@@ -1707,3 +1772,104 @@ def test_ch031_ignores_pool_stored_as_attribute():
1707
1772
  )
1708
1773
  assert _run(code, ["CH031"]) == []
1709
1774
 
1775
+
1776
+ # --- CH032 nondeterministic-default-argument --------------------------------------------
1777
+
1778
+
1779
+ def test_ch032_flags_time_time_default():
1780
+ code = "import time\ndef f(x=time.time()):\n return x\n"
1781
+ findings = _run(code, ["CH032"])
1782
+ assert len(findings) == 1
1783
+ assert findings[0].code == "CH032"
1784
+
1785
+
1786
+ def test_ch032_flags_datetime_now_default():
1787
+ code = "from datetime import datetime\ndef f(x=datetime.now()):\n return x\n"
1788
+ findings = _run(code, ["CH032"])
1789
+ assert len(findings) == 1
1790
+
1791
+
1792
+ def test_ch032_flags_random_default_on_lambda():
1793
+ code = "import random\nf = lambda x=random.random(): x\n"
1794
+ findings = _run(code, ["CH032"])
1795
+ assert len(findings) == 1
1796
+
1797
+
1798
+ def test_ch032_flags_uuid4_keyword_only_default():
1799
+ code = "import uuid\ndef f(*, id=uuid.uuid4()):\n return id\n"
1800
+ findings = _run(code, ["CH032"])
1801
+ assert len(findings) == 1
1802
+
1803
+
1804
+ def test_ch032_ignores_none_default():
1805
+ code = "def f(x=None):\n return x\n"
1806
+ assert _run(code, ["CH032"]) == []
1807
+
1808
+
1809
+ def test_ch032_ignores_literal_default():
1810
+ code = "def f(x=10):\n return x\n"
1811
+ assert _run(code, ["CH032"]) == []
1812
+
1813
+
1814
+ def test_ch032_ignores_unrelated_call_default():
1815
+ code = "def f(x=get_default_timeout()):\n return x\n"
1816
+ assert _run(code, ["CH032"]) == []
1817
+
1818
+
1819
+ def test_ch032_ignores_module_constant_default():
1820
+ code = "import time\ndef f(x=time.sleep):\n return x\n"
1821
+ assert _run(code, ["CH032"]) == []
1822
+
1823
+
1824
+ # --- CH033 strip-multichar-argument ------------------------------------------------------
1825
+
1826
+
1827
+ def test_ch033_flags_strip_with_multichar_string():
1828
+ code = "'report.txt'.strip('.txt')\n"
1829
+ findings = _run(code, ["CH033"])
1830
+ assert len(findings) == 1
1831
+ assert findings[0].code == "CH033"
1832
+
1833
+
1834
+ def test_ch033_flags_lstrip_with_multichar_string():
1835
+ code = "'v1.2.3'.lstrip('v.')\n"
1836
+ findings = _run(code, ["CH033"])
1837
+ assert len(findings) == 1
1838
+
1839
+
1840
+ def test_ch033_flags_rstrip_with_multichar_string():
1841
+ code = "'name.txt'.rstrip('.txt')\n"
1842
+ findings = _run(code, ["CH033"])
1843
+ assert len(findings) == 1
1844
+
1845
+
1846
+ def test_ch033_ignores_single_char_argument():
1847
+ code = "'name,'.strip(',')\n"
1848
+ assert _run(code, ["CH033"]) == []
1849
+
1850
+
1851
+ def test_ch033_ignores_strip_with_no_argument():
1852
+ code = "' name '.strip()\n"
1853
+ assert _run(code, ["CH033"]) == []
1854
+
1855
+
1856
+ def test_ch033_ignores_non_string_variable_argument():
1857
+ code = "chars = build_chars()\n'name'.strip(chars)\n"
1858
+ assert _run(code, ["CH033"]) == []
1859
+
1860
+
1861
+ def test_ch033_ignores_repeated_single_character():
1862
+ code = "'```sql```'.strip('```')\n"
1863
+ assert _run(code, ["CH033"]) == []
1864
+
1865
+
1866
+ def test_ch033_ignores_bracket_or_quote_character_set():
1867
+ code = "'[1,2,3]'.strip('[]')\nline.rstrip('\\r\\n')\ns.strip('\\'\"')\n"
1868
+ assert _run(code, ["CH033"]) == []
1869
+
1870
+
1871
+ def test_ch033_flags_argument_with_letters_even_with_punctuation():
1872
+ code = "url.strip('/v1')\n"
1873
+ findings = _run(code, ["CH033"])
1874
+ assert len(findings) == 1
1875
+
File without changes
File without changes
File without changes
File without changes
File without changes