Lint Artifacts¶

What are these files?

Static analysis reports that keep style, formatting, typing and complexity in check.

Ruff: rules & auto-fixes; Ruff Format: code formatter
codespell: common typos
mypy/pyright/pytype: static typing at different speeds/strictness
pydocstyle: Google-style docstrings
radon: cyclomatic complexity (CC), Maintainability Index (MI)

Files & what they’re for

ruff-format.log — Formatter check (ruff format --check).
- Good: No changes needed. — would reformat: 0, reformatted: 0
- How to use: Run ruff format; enforce via pre-commit.
ruff.log — Python linter (style + correctness).
- Good: 0 violations (or only nits). — issues: 0
- How to use: Run ruff --fix for auto-fixes; justify any # noqa.
mypy.log — Static type-checker (mypy).
- Good: Success: no issues found. — success
- How to use: Annotate public APIs; enable stricter flags gradually.
pyright.log — Static type-checker (pyright).
- Good: 0 errors, 0 warnings. — errors: 0, warnings: 0
- How to use: Use strict mode per module; ratchet warnings down.
codespell.log — Spelling checker for identifiers, comments, docs.
- Good: Empty log (no typos). — typos: 0
- How to use: Accept valid suggestions; collect custom words.
radon.log — Complexity & maintainability (CC, MI).
- Good: Mostly A; MI ≥ 70; nothing above thresholds. — worst CC grade: F
- How to use: Refactor hotspots (C–F); track MI/CC thresholds.
pydocstyle.log — Google-style docstring conventions (pydocstyle).
- Good: 0 violations (Google convention). — violations: 0
- How to use: Follow Google sections (Args/Returns/Raises); set --convention=google.
pytype.log — Type inference + checking (pytype).
- Good: No errors. — errors: 0
- How to use: Prefer precise hints over Any; use pragmas sparingly.
_passed — Suite sentinel.
- Good: Present with OK marker. — OK
- How to use: All checks green.

ruff-format.log¶

About this report & how to act on it

What it is: Formatter check (ruff format --check). What good looks like: No changes needed.

Open full contents

ruff.log¶

About this report & how to act on it

What it is: Python linter (style + correctness). What good looks like: 0 violations (or only nits).

Open full contents

mypy.log¶

About this report & how to act on it

What it is: Static type-checker (mypy). What good looks like: Success: no issues found.

Open full contents

pyright.log¶

About this report & how to act on it

What it is: Static type-checker (pyright). What good looks like: 0 errors, 0 warnings.

Open full contents

codespell.log¶

About this report & how to act on it

What it is: Spelling checker for identifiers, comments, docs. What good looks like: Empty log (no typos).

Open full contents

radon.log¶

About this report & how to act on it

What it is: Complexity & maintainability (CC, MI). What good looks like: Mostly A; MI ≥ 70; nothing above thresholds.

Open full contents

pydocstyle.log¶

About this report & how to act on it

What it is: Google-style docstring conventions (pydocstyle). What good looks like: 0 violations (Google convention).

Open full contents

pytype.log¶

About this report & how to act on it

What it is: Type inference + checking (pytype). What good looks like: No errors.

Open full contents

_passed¶

About this report & how to act on it

What it is: Suite sentinel. What good looks like: Present with OK marker.

Open full contents