Improve "override" error output
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 20.6k
- フォーク
- 3.3k
- PR マージ指標
- PR 指標を取得中
説明
(Opening a new issue for this as discussed in #12390.)
Live demo: https://mypy-play.net/?mypy=latest&python=3.10&flags=strict&gist=d3e1a06857e4c6f1c698b7fa89e22f40
Example code:
import typing as t
class A:
@t.overload
def pop(self) -> int: ...
@t.overload
def pop(self, d: int = ...) -> int: ...
def pop(self, d: int = ...) -> int: ...
class B(A):
@t.overload
def pop(self) -> int: ...
@t.overload
def pop(self, d: int) -> int: ...
def pop(self, d: int = ...) -> int: ...
Current mypy output:
main.py:14: error: Signature of "pop" incompatible with supertype "A"
main.py:14: note: Superclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int = ...) -> int
main.py:14: note: Subclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int) -> int
Found 1 error in 1 file (checked 1 source file)
It's somewhat helpful that mypy quotes the code in this error output, but it would be really helpful if mypy's output helped us zero in on exactly where the problem is, e.g.:
main.py:14: error: Signature of "pop" incompatible with supertype "A" in second overload
main.py:14: note: Superclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int = ...) -> int
^^^^^
main.py:14: note: Subclass:
main.py:14: note: @overload
main.py:14: note: def pop(self) -> int
main.py:14: note: @overload
main.py:14: note: def pop(self, d: int) -> int
Found 1 error in 1 file (checked 1 source file)
Note the addition of "in second overload" in the error message, as well as the all-important ^ arrows pointing to exactly where the supertype differs (namely, d should be a keyword argument). Without the arrows, it's harder to see in the output that the only difference is the = ... in the code for the superclass.
This is exacerbated when method signatures are more complex than this, e.g. MutableMapping.pop(), where the current output makes it even harder to spot where the problem is compared to this minimized example (see https://github.com/python/mypy/issues/12390#issuecomment-1073811096). It is also exacerbated by mypy ignoring the signature in the actual implementation, where d correctly appears as a keyword argument in the subclass. Finally, it can be exacerbated when upgrading to a mypy version that includes typeshed changes like this one: https://github.com/python/typeshed/pull/6941/commits/92438dcbe3e9e7720d9de56c6be0f0b5d2b14a2e#diff-b12c4be0f8e39f89957bbe7be6b6327185e18b69ea80a0f62c0746bb26f4a58eL478
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
mypy-play のライブデモと、提供されている A/B オーバーロード例から始めて、現在の診断を再現します。override シグネチャの診断とそのフォーマットテストを追跡します。完了の条件は、出力が異なるオーバーロードを特定し、不一致を指摘し、既存の比較コンテキストを維持することです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- compilers
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 28/100