Only use annotations of `@overload`ed functions to type check the implementation
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 20.6k
- フォーク
- 3.3k
- 平均マージ
- 1日 18時間
- マージ済み PR(30日)
- 54
説明
Consider the following real-world example of a function. The type of one of the parameters of this function depends on another one:
from typing import *
K = TypeVar("K", bound=Hashable)
V = TypeVar("V")
@overload
def dict_get_factory(dictionary: Dict[K, V],
key: K,
factory: Callable[[], V],
takes_key: Literal[False]) -> V: ...
@overload
def dict_get_factory(dictionary: Dict[K, V],
key: K,
factory: Callable[[K], V],
takes_key: Literal[True]) -> V: ...
def dict_get_factory(dictionary: Dict[K, V],
key: K,
factory: Union[Callable[[], V], Callable[[K], V]],
takes_key: bool=False) -> V:
"""Like dict.setdefault(), but uses a factory
>>> dict_get_factory(d := {}, "foo", int)
0
>>> dict_get_factory(d, "bar", lambda key: len(key), takes_key=True)
3
>>> d
{'foo': 0, 'bar': 3}
"""
try:
return dictionary[key]
except KeyError:
return dictionary.setdefault(key,
factory(key) if takes_key else factory())
i1: int = dict_get_factory({"foo": 1}, "bar", lambda: 1, False) # ok
i2: int = dict_get_factory({"foo": 1}, "bar", lambda s: 1, True) # ok
It doesn't typecheck as if you only look at the annotations of the implementation, the signature of the factory is ambiguous:
main.py:36: error: Too many arguments
main.py:36: error: Too few arguments
I don't think it's possible to annotate the implementation in such a way that it would typecheck. So it would be nice if mypy used the signatures of the @overloaded methods, and one wouldn't have to annotate the signature of the implementation at all. Even if you could annotate it in such a way that it would typecheck, wouldn't it be redundant?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue の overload の例から始め、mypy が実装シグネチャと overload チェックをどのように扱うかを調査します。実装内部の呼び出しに対する意図された動作を判断し、その後、対象を絞った回帰テストを追加して、例で競合する factory 呼び出しエラーが報告されなくなったことを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- compilers, devtools
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100