Add GitHub annotations format for --output

[edgarrmondragon]

Adds a new output format as GitHub Workflow commands, aka annotations.

Refs:

• https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions

Closes #17612

[Seluj78]

I would love to see this merged, many people asked for it in #10816 and #14962 !

[A5rocks]

I assume this no longer needs to be marked as a draft?

[edgarrmondragon]

I assume this no longer needs to be marked as a draft?

I've got a TODO comment in the diff that I want to address before opening the PR for review.

[edgarrmondragon]

Here's how these look like in the diff view:

[Seluj78]

Looks amazing!

[vasanth-asokan]

This looks amazing! We would like to use it in our github actions! Will this PR be merged soon?

[edgarrmondragon]

This was preventing the choices from being displayed in the --help output

[github-actions]

Diff from mypy_primer, showing the effect of this PR on open source code:

schemathesis (https://github.com/schemathesis/schemathesis)
-   File "/tmp/mypy_primer/old_mypy/venv/bin/mypy", line 8, in <module>
+   File "/tmp/mypy_primer/new_mypy/venv/bin/mypy", line 8, in <module>
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/__main__.py", line 15, in console_entry
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/__main__.py", line 15, in console_entry
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/main.py", line 119, in main
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/main.py", line 119, in main
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/main.py", line 203, in run_build
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/main.py", line 203, in run_build
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 191, in build
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 191, in build
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 267, in _build
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 267, in _build
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 2947, in dispatch
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 2947, in dispatch
-   File "/tmp/mypy_primer/old_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 976, in write_deps_cache
+   File "/tmp/mypy_primer/new_mypy/venv/lib/python3.12/site-packages/mypy/build.py", line 976, in write_deps_cache

[lpulley]

This would be a great feature; is it likely to make its way into 1.16?

[edgarrmondragon]

This would be a great feature; is it likely to make its way into 1.16?

Probably not. See #11396 (comment).

[Seluj78]

Since the output format of json has been merged, and it seems like they don't want to add another tool, can someone write something to convert from json to github format ?

[pdgendt]

Since the output format of json has been merged, and it seems like they don't want to add another tool, can someone write something to convert from json to github format ?

A simple one-liner you can add to your Github Workflow:

mypy . --output=json | jq -r '"::error title=Mypy issue,file=\(.file),line=\(.line),col=\(.column)::\(.message)"'

[Seluj78]

Thanks ! I'm not skilled enough with jq, couldn't figure it out (Didn't try with AI).

Cheers @pdgendt

[emmatyping]

I agree with @JelleZijlstra that it would be preferable not to have to maintain multiple output formats. Perhaps as a compromise we could document the one-liner that @pdgendt created?

[cj81499]

Bummed that this was closed, but I agree that documenting @pdgendt's one-liner would be highly valuable, with a much lower maintenance cost.

Any maintainers around to say if a contribution to do so would be welcomed? Any input on where it would belong in the docs?

[brianschubert]

FYI, there are some (rather low) limits on the number of annotations that GitHub will show. See e.g.

• https://github.com/orgs/community/discussions/26680
• https://github.com/orgs/community/discussions/68471

My understanding is that only up to 10 errors from a single mypy step can be show. That makes me wonder how useful it would be to document this, or if it might lead to user confusion due to some errors being hidden.

[A5rocks]

Bummed that this was closed, but I agree that documenting @pdgendt's one-liner would be highly valuable, with a much lower maintenance cost.

Any maintainers around to say if a contribution to do so would be welcomed? Any input on where it would belong in the docs?

Maybe https://mypy.readthedocs.io/en/stable/command_line.html#cmdoption-mypy-O or https://mypy.readthedocs.io/en/stable/faq.html