Generate a JSON report from your mypy output
Project description
Mypy JSON Report
A JSON report of your mypy output that helps you push towards full type coverage of your project.
Quickstart
Install with pip.
pip install mypy-json-report
Pipe the output of mypy through the mypy-json-report
CLI app.
Store the output to a file, and commit it to your git repo.
mypy . --strict | mypy-json-report > known-mypy-errors.json
git add known-mypy-errors.json
git commit -m "Add mypy errors lockfile"
Now you have a snapshot of the mypy errors in your project. Compare against this file when making changes to your project to catch regressions and improvements.
Example output
If mypy was showing you errors like this:
example.py:8: error: Function is missing a return type annotation
example.py:8: note: Use "-> None" if function does not return a value
example.py:58: error: Call to untyped function "main" in typed context
example.py:69: error: Call to untyped function "main" in typed context
Found 3 errors in 1 file (checked 3 source files)
Then the report would look like this:
{
"example.py": {
"Call to untyped function \"main\" in typed context": 2,
"Function is missing a return type annotation": 1
}
}
Errors are grouped by file. To reduce churn, the line on which the errors occur is removed and repeated errors are counted.
Example usage
You could create a GitHub Action to catch regressions (or improvements).
---
name: Mypy check
on: [push]
jobs:
build:
runs-on: ubuntu-latest
mypy:
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: "3.10"
- name: Install Python dependencies
run: |
pip install mypy mypy-json-report
- name: Run mypy
run: |
mypy . --strict | mypy-json-report > known-mypy-errors.json
- name: Check for mypy changes
run: |
git diff --exit-code
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy_json_report-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf46f98514f413fb98006a45d0b40c37d9b719df4b4d5d3544ff71c21c9f2a5a |
|
MD5 | f5174f1faa783e7a383bd1e38f4a2d92 |
|
BLAKE2b-256 | 84f9d7a3375e17ffc691b78dc1c06b55f8b767f2c1f2eaac3abc7616db09758e |