Skip to main content

Flake8 plugin for detecting static-analysis escape hatches in Python code

Project description

flake8-agents

Flake8 Typed License: MIT PyPI version python version

flake8-agents is a Flake8 plugin for codebases that use AI-generated Python. It exists because generated code often hides problems from static analysis with reflection, broad types, casts, raw namespace access, and stale suppressions.

The plugin turns those escape hatches into explicit AGT diagnostics.

Usage

uv sync
uv run flake8 --select AGT src
uv run module-size src --warn-lines 800 --error-lines 1000

Minimal Flake8 config:

[flake8]
select = AGT

Rules

Suppressions

Code Catches Example
AGT001 unused explicit AGT noqa suppressions value: int = 1 # noqa: AGT105
AGT100 broad type-checker suppressions value = 1 # type: ignore[assignment]

Type escapes

Code Catches Example
AGT101 typing.cast used as a narrowing bypass result = cast(int, value)
AGT102 broad object annotations def handle(value: object) -> None: ...
AGT103 known-shape containers that erase value shape payload: dict[str, object]
AGT104 vague callable signatures callback: Callable[..., int]
AGT105 broad Any at non-local boundaries def handle(value: Any) -> None: ...
AGT106 legacy type-parameter factories T = TypeVar("T")
AGT107 classmethod factories returning their class name def build(cls) -> "Box": ...

Dynamic anti-patterns

Code Catches Example
AGT200 dynamic attribute reads value = getattr(target, "name")
AGT201 dynamic attribute writes setattr(target, "name", value)
AGT202 raw namespace extraction namespace = vars(target)
AGT203 dynamic import builtin module = __import__("package")
AGT204 importlib.import_module calls module = importlib.import_module("package")
AGT205 setattr-style mutation methods target.setattr("name", value)
AGT206 direct __setattr__ calls target.__setattr__("name", value)
AGT207 direct __new__ construction instance = Target.__new__(Target)
AGT208 direct raw __dict__ indexing value = target.__dict__["name"]
AGT209 aliasing raw __dict__ namespace = target.__dict__
AGT210 indexing raw __dict__ aliases value = namespace["name"]
AGT211 aliasing dotted module imports import package.module as alias

Import boundaries

Code Catches Example
AGT300 private project imports across module boundaries from module import _private
AGT301 configured retired project import paths import module.legacy
AGT302 declarations before the module import section is complete VALUE = 1 before import ast

module-size

module-size is a separate command that fails on oversized Python modules.

uv run module-size src --warn-lines 800 --error-lines 1000
Option Default Meaning
paths required Python files or directories to scan
--warn-lines 800 print warning findings at or above this line count
--error-lines 1000 return failure at or above this line count
--exclude REGEX none skip files whose resolved path matches the regex
--suppress-warnings false hide warning findings from stdout
PATH                              LINES  LEVEL    THRESHOLD
/path/to/src/package/large.py     1012   error    1000

Python support

flake8-agents supports Python >=3.10 and is typed (py.typed). Runtime dependencies are intentionally small: flake8 and typing-extensions.

License

MIT. See LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8_agents-0.1.1.tar.gz (105.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_agents-0.1.1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file flake8_agents-0.1.1.tar.gz.

File metadata

  • Download URL: flake8_agents-0.1.1.tar.gz
  • Upload date:
  • Size: 105.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for flake8_agents-0.1.1.tar.gz
Algorithm Hash digest
SHA256 fae155749b8596e5ea31292240de1d853b8b87b095f2e0b6e8898d6bdf74eef4
MD5 df1f50341361fe5f953871d94d368ee9
BLAKE2b-256 f9f7a40913936b3da2797d6d57f9932e990f1c71dc2a625b64bdc4077d36884d

See more details on using hashes here.

File details

Details for the file flake8_agents-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: flake8_agents-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for flake8_agents-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f6b4509e708442d504d4adbbb10a2ae4e7640707a41232aaca2ba166539ecc4
MD5 a0560b07b87eb38a9e1367410664a700
BLAKE2b-256 ababddedafc2f8dec828b35613bc77305ef36c7599bb0bd768297f5c670e58df

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page