mfisherlevine/mypy-coverage

Report mypy annotation coverage. Add inline annotations and gate CI on a coverage threshold.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
versionmypy-coverage version on PyPI. Use 'latest' or pin like '0.2.4'.nolatest
python-versionPython version to install.no3.11
pathsSpace-separated paths to scan. Defaults to the ``files`` and ``mypy_path`` settings in the discovered mypy config.no""
configPath to mypy config file. Auto-detected if empty.no""
rootProject root. Defaults to the config's directory or CWD.no""
thresholdFail the step if coverage falls below this percentage (0-100). Leave empty to disable the gate.no""
threshold-metricWhich metric --threshold applies to: 'checked' or 'fully-typed'.nochecked
formatOutput format for the user-facing run: text, json, markdown, or github.nogithub
sortSort the per-file table by 'path' (alphabetical) or 'coverage' (worst first).nopath
silent-anySet to 'true' to also flag patterns that decay to Any.nofalse
include-excludedInclude the walled-off excluded-files section ('true' or 'false').notrue
listSet to 'true' to list every unannotated definition by name.nofalse
list-partialSet to 'true' to list every partially annotated definition by name.nofalse
namedescription
percent-checkedFraction of definitions whose body mypy actually analyses, as a percentage.
percent-fully-typedFraction of definitions with complete annotations, as a percentage.
unannotatedCount of unannotated definitions in the main body.
partialCount of partially-annotated definitions in the main body.
totalTotal definitions in the main body (excludes mypy-excluded files).