Аннотации типа для * args и * * kwargs
я пробую аннотации типа Python с абстрактными базовыми классами для написания некоторых интерфейсов. Есть ли способ аннотировать возможные типы *args
и **kwargs
?
например, как можно выразить, что разумные аргументы функции являются либо int
и два int
s? 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
в самом вызове. Добавление после распаковки также дает ошибку ввода, которую я не понимаю.
как аннотировать разумные типы для *args
и **kwargs
?
3 ответов
для переменных позиционных аргументов (*args
) и переменные аргументы ключевых слов (**kw
) вам нужно только указать ожидаемое значение для один такой аргумент.
С произвольные списки аргументов и значения аргументов по умолчанию раздел на Тип Подсказки PEP:
произвольные списки аргументов также могут быть аннотированы, так что определение:
def foo(*args: str, **kwds: int): ...
is приемлемо и это означает, что, например, все следующие вызовы функций с действительными типы аргументов:
foo('a', 'b', 'c') foo(x=1, y=2) foo('', z=0)
таким образом, вы хотите указать свой метод следующим образом:
def foo(*args: int):
однако, если ваша функция может принимать только одно или два целых значения, вы не должны использовать *args
вообще, используйте один явный позиционный аргумент и второй аргумент ключевого слова:
def foo(first: int, second: Optional[int] = None):
теперь ваша функция фактически ограничена одним или двумя аргументами, и оба должны быть целыми числами, если не указано. *args
всегда означает 0 или более и не может быть ограничено подсказками типа для более конкретного диапазона.
в качестве короткого дополнения к предыдущему ответу, если вы пытаетесь использовать mypy в файлах Python 2 и вам нужно использовать комментарии для добавления типов вместо аннотаций, вам нужно префикс типов для args
и kwargs
С *
и **
соответственно:
def foo(param, *args, **kwargs):
# type: (bool, *str, **int) -> None
pass
это рассматривается mypy как то же самое, что и ниже, версия Python 3.5 foo
:
def foo(param: bool, *args: str, **kwargs: int) -> None:
pass
правильный способ сделать это с помощью @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
и mypy, чтобы получить поддержку @overload вне заглушки файлов.
вы также можете использовать это, чтобы изменить возвращаемый результат таким образом, чтобы сделать явным, какие типы аргументов соответствуют какому типу возврата. например:
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))