Ketikkan anotasi untuk * args dan ** kwargs

Saya mencoba anotasi tipe Python dengan kelas dasar abstrak untuk menulis beberapa antarmuka. Apakah ada cara untuk menjelaskan jenis *argsdan kemungkinan **kwargs?

Sebagai contoh, bagaimana seseorang menyatakan bahwa argumen yang masuk akal untuk suatu fungsi adalah satu intatau dua int? type(args)memberi Tuplejadi dugaan saya adalah untuk membubuhi keterangan jenis Union[Tuple[int, int], Tuple[int]], tetapi ini tidak berhasil.

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))

Pesan kesalahan dari 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]]"

Masuk akal bahwa mypy tidak menyukai ini untuk pemanggilan fungsi karena ia mengharapkan akan ada tupledalam pemanggilan itu sendiri. Tambahan setelah membongkar juga memberikan kesalahan pengetikan yang saya tidak mengerti.

Bagaimana cara menjelaskan jenis yang masuk akal untuk *argsdan **kwargs?

Untuk argumen posisi variabel ( *args) dan argumen kata kunci variabel ( **kw) Anda hanya perlu menentukan nilai yang diharapkan untuk satu argumen tersebut.

Dari daftar argumen Sewenang - wenang dan bagian nilai argumen default dari Type Hints PEP:

Daftar argumen sewenang-wenang juga dapat diketikkan, sehingga definisi:

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

dapat diterima dan itu berarti, mis., semua yang berikut ini mewakili panggilan fungsi dengan tipe argumen yang valid:

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

Jadi, Anda ingin menentukan metode Anda seperti ini:

def foo(*args: int):

Namun, jika fungsi Anda hanya dapat menerima satu atau dua nilai integer, Anda tidak boleh menggunakan *argssama sekali, gunakan satu argumen posisi eksplisit dan argumen kata kunci kedua:

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

Sekarang fungsi Anda sebenarnya terbatas pada satu atau dua argumen, dan keduanya harus bilangan bulat jika ditentukan. *args selalu berarti 0 atau lebih, dan tidak dapat dibatasi oleh tip petunjuk ke rentang yang lebih spesifik.

Cara yang tepat untuk melakukan ini adalah menggunakan @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))

Perhatikan bahwa Anda tidak menambahkan @overloadatau mengetik anotasi pada implementasi aktual, yang harus menjadi yang terakhir.

Anda membutuhkan versi yang agak baru dari keduanya typingdan mypy untuk mendapatkan dukungan untuk @overload di luar file rintisan .

Anda juga dapat menggunakan ini untuk memvariasikan hasil yang dikembalikan dengan cara yang membuat eksplisit jenis argumen yang sesuai dengan jenis kembali. misalnya:

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))

Sebagai tambahan singkat untuk jawaban sebelumnya, jika Anda mencoba menggunakan mypy pada file Python 2 dan perlu menggunakan komentar untuk menambahkan jenis, bukan anotasi, Anda perlu awalan jenis untuk argsdan kwargsdengan *dan **masing - masing:

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

Ini diperlakukan oleh mypy sebagai sama dengan di bawah ini, versi Python 3.5 dari foo:

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