Wpisz adnotacje dla * args i ** kwargs

Wypróbowuję adnotacje typu Pythona z abstrakcyjnymi klasami bazowymi, aby napisać niektóre interfejsy. Czy istnieje sposób na dodanie adnotacji do możliwych typów *argsi **kwargs?

Na przykład, jak można by wyrazić, że sensowne argumenty funkcji to jeden intlub dwa ints? type(args)daje Tuplewięc przypuszczam, że dodam adnotację jako Union[Tuple[int, int], Tuple[int]], ale to nie działa.

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

Komunikaty o błędach od 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]]"

To ma sens, że mypy nie lubi tego dla wywołania funkcji, ponieważ oczekuje, że tuplew samym wywołaniu będzie występować a . Dodatek po rozpakowaniu daje też błąd pisarski którego nie rozumiem.

W jaki sposób można opisać rozsądne typy dla *argsi **kwargs?

W przypadku zmiennych pozycyjnych arguments ( *args) i zmiennych słów kluczowych arguments ( **kw) wystarczy określić oczekiwaną wartość tylko dla jednego takiego argumentu.

Z dowolnych list argumentów i wartości domyślne argumentów odcinku od typu Hints PEP:

Arbitralne listy argumentów mogą być również opatrzone adnotacjami, tak aby definicja:

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

jest akceptowalny i oznacza to, że np. wszystkie poniższe reprezentują wywołania funkcji z prawidłowymi typami argumentów:

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

Więc chciałbyś określić swoją metodę w następujący sposób:

def foo(*args: int):

Jeśli jednak twoja funkcja może akceptować tylko jedną lub dwie wartości całkowite, nie powinieneś jej *argsw ogóle używać, użyj jednego jawnego argumentu pozycyjnego i drugiego argumentu słowa kluczowego:

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

Teraz twoja funkcja jest w rzeczywistości ograniczona do jednego lub dwóch argumentów i oba muszą być liczbami całkowitymi, jeśli zostały określone. *args zawsze oznacza 0 lub więcej i nie można go ograniczyć wskazówkami typu do bardziej szczegółowego zakresu.

Właściwym sposobem na to jest użycie @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))

Zauważ, że nie dodajesz @overloadani nie wpisujesz adnotacji do rzeczywistej implementacji, która musi być ostatnia.

Będziesz potrzebować nowej wersji obu typingi mypy, aby uzyskać obsługę @overload poza plikami pośredniczącymi .

Możesz również użyć tego do zróżnicowania zwracanego wyniku w sposób, który wyraźnie określa, które typy argumentów odpowiadają typowi zwracanemu. na przykład:

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

Jako krótki dodatek do poprzedniej odpowiedzi, jeśli starasz się używać mypy na Pythonie 2 pliki i trzeba używać komentarzy, aby dodać typy zamiast adnotacji, trzeba poprzedzić typy do argsi kwargsz *i **odpowiednio:

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

Jest to traktowane przez mypy jako to samo, co poniżej, wersja Pythona 3.5 foo:

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