* Args ve ** kwargs için ek açıklamalar yazın

Bazı arayüzler yazmak için soyut temel sınıflarla Python'un tip ek açıklamalarını deniyorum. Olası *argsve türlerine açıklama eklemenin bir yolu var mı **kwargs?

Örneğin, bir işleve ilişkin mantıklı argümanların ya bir intya da iki ints olduğunu nasıl ifade edebiliriz ? type(args)verir Tuplebenim tahminim olarak türünü açıklama oldu bu yüzden Union[Tuple[int, int], Tuple[int]], ama bu işe yaramaz.

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 hata mesajları:

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 işlev çağrısı için bundan hoşlanmaz çünkü tupleçağrının kendisinde bir tane olmasını bekler . Paketi açtıktan sonra ek olarak anlamadığım bir yazma hatası verir.

İnsan nasıl için mantıklı türlerini açıklama yok *argsve **kwargs?

Değişken pozisyonel argümanlar (For *args) ve değişken anahtar kelime argümanlar ( **kw) yalnızca için beklenen değerini belirtmek gerekir bir tür argüman.

Gönderen Keyfi argüman listeleri ve varsayılan argüman değerleri bölümünün içinde Tipi İpuçları PEP:

Rasgele argüman listeleri de açıklama eklenebilir, böylece tanım:

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

kabul edilebilirdir ve şu anlama gelir, örneğin aşağıdakilerin tümü geçerli argüman türlerine sahip işlev çağrılarını temsil eder:

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

Dolayısıyla, yönteminizi şu şekilde belirtmek istersiniz:

def foo(*args: int):

Ancak, işleviniz yalnızca bir veya iki tamsayı değerini kabul edebiliyorsa, hiç kullanmamalısınız *args, bir açık konum bağımsız değişkeni ve ikinci bir anahtar kelime bağımsız değişkeni kullanın:

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

Şimdi işleviniz aslında bir veya iki argümanla sınırlıdır ve belirtilirse her ikisi de tamsayı olmalıdır. *args her zaman 0 veya daha fazla anlamına gelir ve tür ipuçlarıyla daha spesifik bir aralıkla sınırlandırılamaz.

Bunu yapmanın doğru yolu @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))

@overloadAsıl uygulamaya son eklenmesi gereken ek açıklamalar eklemediğiniz veya yazmamanız gerektiğini unutmayın.

Saplama dosyalarının dışındatyping @overload desteği almak için hem mypy'nin hem de mypy'nin yeni bir sürümüne ihtiyacınız olacak .

Bunu, döndürülen sonucu hangi argüman türlerinin hangi dönüş türüne karşılık geldiğini açıkça gösterecek şekilde değiştirmek için de kullanabilirsiniz. Örneğin:

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

Önceki cevaba kısa bir ek olarak, Python 2 dosyalarında mypy'yi kullanmaya çalışıyorsanız ve ek açıklamalar yerine tür eklemek için yorum kullanmanız gerekiyorsa, sırasıyla argsve kwargsile *ve türlerinin önüne ön ek eklemeniz gerekir **:

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

Bu mypy tarafından aşağıdaki Python 3.5 sürümü ile aynı olarak ele alınır foo:

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