warn when default values on overloads differ from implementation signature
オープン
まだ誰も着手していません。
feature
topic-overloads
- 主要言語
- Python
- スター
- 20.6k
- フォーク
- 3.3k
- PR マージ指標
- PR 指標を取得中
説明
from typing import overload
@overload
def foo(value1: str, value2: bool = False) -> str: # this default value is wrong/useless
...
@overload
def foo(value1: int, value2: bool = False) -> int: # this default value is wrong/useless
...
def foo(value1: str | int, value2: bool = True) -> str | int:
...
in fact, maybe even prohibit defaults on overload signatures entirely, like in typescript:
function foo(value1: number, value2: boolean = false): number //error: A parameter initializer is only allowed in a function or constructor implementation.
function foo(value1: string, value2: boolean = false): string //error: A parameter initializer is only allowed in a function or constructor implementation.
function foo(value1: number | string, value2: boolean = true): number | string {
return 1
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず overload の例を再現し、mypy の overload-signature checking を追跡します。受け入れるべき動作が、実装と異なる defaults に対する警告なのか、overload 上のあらゆる defaults に対するエラーなのかを判断します。選択したルールが一貫して適用され、regression tests でカバーされれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100