Generate better error message for incompatible **kwargs
オープン
まだ誰も着手していません。
good-first-issue
priority-1-normal
topic-calls
topic-usability
- 主要言語
- Python
- スター
- 20.6k
- フォーク
- 3.3k
- PR マージ指標
- PR 指標を取得中
説明
This output is from #8772:
$ mypy test.py
test.py:6: error: Argument 2 to "dumps" has incompatible type "**Dict[str, int]"; expected "bool"
test.py:6: error: Argument 2 to "dumps" has incompatible type "**Dict[str, int]"; expected "Optional[Type[JSONEncoder]]"
test.py:6: error: Argument 2 to "dumps" has incompatible type "**Dict[str, int]"; expected "Optional[Tuple[str, str]]"
test.py:6: error: Argument 2 to "dumps" has incompatible type "**Dict[str, int]"; expected "Optional[Callable[[Any], Any]]"
Found 4 errors in 1 file (checked 1 source file)
The error messages are pretty confusing. We should special case this and produce a customized error message that explains the situation better.
Here's the code that triggers the errors:
import json
json_kwargs = dict(indent=2)
json.dumps({}, **json_kwargs)
Some ideas about what to do:
- Generate a single error message instead of multiple ones.
- Add a note suggesting the use of
Dict[str, Any]or a TypedDict type for the**kwargsargument. - Maybe also explain that mypy matches the value type against all arguments, or add a link to documentation (add something to common issues, for example).
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、test.py の例を json.dumps で再現し、#8772 の出力と比較します。既存の **kwargs のエラー報告を追跡し、その結果を Dict[str, Any] または TypedDict についてのガイダンスを含む、単一の明確な診断にします。混乱を招く重複したエラーがなくなったことを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- devtools
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100