* argsおよび** kwargsの型注釈

いくつかのインターフェイスを作成するために、抽象基本クラスを使用してPythonの型注釈を試しています。*argsandの可能なタイプに注釈を付ける方法はあり**kwargsますか？

たとえば、関数への賢明な引数が1つintまたは2つintのであることをどのように表現しますか？type(args)与えTuple私の推測のようにタイプに注釈を付けることだったのでUnion[Tuple[int, int], Tuple[int]]、これは動作しません。

from typing import Union, Tuple

def foo(*args: Union[Tuple[int, int], Tuple[int]]):
    try:
        i, j = args
        return i + j
    except ValueError:
        assert len(args) == 1
        i = args[0]
        return i

# ok
print(foo((1,)))
print(foo((1, 2)))
# mypy does not like this
print(foo(1))
print(foo(1, 2))

mypyからのエラーメッセージ：

t.py: note: In function "foo":
t.py:6: error: Unsupported operand types for + ("tuple" and "Union[Tuple[int, int], Tuple[int]]")
t.py: note: At top level:
t.py:12: error: Argument 1 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"
t.py:14: error: Argument 1 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"
t.py:15: error: Argument 1 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"
t.py:15: error: Argument 2 to "foo" has incompatible type "int"; expected "Union[Tuple[int, int], Tuple[int]]"

mypyはtuple、呼び出し自体にaがあることを期待しているため、関数呼び出しではこれを好まないのは理にかなっています。解凍後の追加も、理解できない入力エラーを引き起こします。

*argsand の賢明な型にどのように注釈を付けるの**kwargsですか？

可変位置引数（*args）および可変キーワード引数（**kw）の場合、指定する必要があるのは、そのような引数の1つに期待される値だけです。

タイプヒント PEP の任意の引数リストとデフォルトの引数値セクションから：

任意の引数リストには、タイプ注釈を付けることもできるため、定義は次のようになります。

def foo(*args: str, **kwds: int): ...

は受け入れ可能であり、たとえば、以下のすべてが有効なタイプの引数を持つ関数呼び出しを表すことを意味します。

foo('a', 'b', 'c')
foo(x=1, y=2)
foo('', z=0)

したがって、次のようにメソッドを指定する必要があります。

def foo(*args: int):

ただし、関数で1つまたは2つの整数値しか受け入れられない場合は、まったく使用*argsしないでください。1つの明示的な位置引数と2番目のキーワード引数を使用します。

def foo(first: int, second: Optional[int] = None):

これで、関数は実際には1つまたは2つの引数に制限され、指定する場合は両方とも整数でなければなりません。*args は常に 0以上を意味し、タイプヒントによって特定の範囲に制限することはできません。

これを行う適切な方法は、 @overload

from typing import overload

@overload
def foo(arg1: int, arg2: int) -> int:
    ...

@overload
def foo(arg: int) -> int:
    ...

def foo(*args):
    try:
        i, j = args
        return i + j
    except ValueError:
        assert len(args) == 1
        i = args[0]
        return i

print(foo(1))
print(foo(1, 2))

@overload実際の実装には注釈を追加または入力しないでください。注釈は最後に来る必要があります。

スタブファイルの外でtyping @overloadをサポートするには、両方の新しいバージョンとmypy が必要です。

これを使用して、返される結果を変化させ、どの引数タイプがどの戻りタイプに対応するかを明示することもできます。例えば：

from typing import Tuple, overload

@overload
def foo(arg1: int, arg2: int) -> Tuple[int, int]:
    ...

@overload
def foo(arg: int) -> int:
    ...

def foo(*args):
    try:
        i, j = args
        return j, i
    except ValueError:
        assert len(args) == 1
        i = args[0]
        return i

print(foo(1))
print(foo(1, 2))

前の回答への短い追加として、Python 2ファイルでmypyを使用しようとしていて、注釈の代わりにコメントを使用して型を追加する必要がある場合は、型の接頭辞としてargs、およびkwargswith *およびwith を**それぞれ使用する必要があります。

def foo(param, *args, **kwargs):
    # type: (bool, *str, **int) -> None
    pass

これは、以下のPython 3.5バージョンと同じものとしてmypyによって処理されますfoo。

def foo(param: bool, *args: str, **kwargs: int) -> None:
    pass