Multiple reviews generated for multiline mypy error

[abelcheung]

I'm using action with following step configuration:

    - name: Mypy review
      uses: tsuyoshicho/action-mypy@v3
      with:
        reporter: github-pr-review
        level: warning
        fail_on_error: true

As an example, following is a multi-line mypy error when overriding superclass property in an incompatible way:

/home/runner/.../file.pyi:28:6: error: Signature of "error_log" incompatible with supertype "_Validator"
/home/runner/.../file.pyi:28:6: note:      Superclass:
/home/runner/.../file.pyi:28:6: note:          def error_log(self) -> _ErrorLog
/home/runner/.../file.pyi:28:6: note:      Subclass:
/home/runner/.../file.pyi:28:6: note:          @overload
/home/runner/.../file.pyi:28:6: note:          def error_log(self) -> int
/home/runner/.../file.pyi:29:5: error: Return type "int" of "error_log" incompatible with return type "_ErrorLog" in supertype "_Validator"

The error came from a single diff hunk, so I was expecting a single reviewdog action. Instead, it generated 7 independent reviews on the same pull request, each containing one line, and all of them are attached to the same diff.

[tsuyoshicho]

Work in progress...

[tsuyoshicho]

Hi @abelcheung san,

github.com/tsuyoshicho/test-action-mypy/pull/1
Simply reproduction PR

Basically, mypy report only error and work fine it.
If your project mypy.ini report note:, option mypy_flags use to suppress it.

If you have a problem that you haven't set up that way,
I want you to make a minimum reproduction PR and report it here. (like above PR)

[abelcheung]

Hi,

I have added tsuyoshicho/test-action-mypy#2, but needs your approval to run CI.

For the initial sample error above, mypy can probably hide the note: lines without --show-error-context, therefore this time I created another kind of error that mypy cannot suppress.

[abelcheung]

As an example, following image shows the behavior I want to see -- multiple lines which are related to the same error can be grouped together.

[tsuyoshicho]

FYI
https://github.com/jordemort/action-pyright
use rdjson format (rich error report support),
mypy json report python/mypy#10816

I will think about it.

[abelcheung]

Ouch, you're right, it is not easy to handle mypy error in its current state. It is fine to put the idea on hold until mypy has done something to improve the situation.

[tsuyoshicho]

Thanks a lot. (report and PR)

[tsuyoshicho]

tsuyoshicho/action-test-repo#21

Reproduce PR create in my test repo.
This code is same as abel's test code.

@abelcheung san
Your PR are closed
Please remove forked test-action-mypy repository.
This original test-action-mypy repository are other user test repo...Sorry.
I remove my forked repository too.

[abelcheung]

@tsuyoshicho OK it's done.

[tsuyoshicho]

Note:
python/mypy#10816 (comment)

FYI:
Relation File Format information.
reviewdog are diagnostics parsing tool, and that support json file.
https://github.com/reviewdog/reviewdog/tree/master/proto/rdf#rdjson

action-pyright using converted rdjson from original json.

When mypy implements Pyright's format json, converting the json using already existing action-pyright's method will be solved this issue.

[tsuyoshicho]

@abelcheung san

With no progress on JSON support, I've introduced a workaround.

You can ignore the notice of note.
Please try setting according to your needs.

Release 3.10.0 https://github.com/tsuyoshicho/action-mypy/releases/tag/v3.10.0
test result for ignore note: tsuyoshicho/action-test-repo#27

This issue remains open.

[abelcheung]

@tsuyoshicho I have tried the ignore_note setting and it works fine here. It seems mypy developers don't have interest in implementing JSON support, so your workaround is probably the best approach right now.

[tsuyoshicho]

JSON output has been merged

Development of JSON output support will begin.