Nhập chú thích cho * args và ** kwargs

Tôi đang thử các chú thích kiểu Python với các lớp cơ sở trừu tượng để viết một số giao diện. Có cách nào để chú thích các loại có thể *argsvà **kwargs?

Ví dụ, làm thế nào một người có thể diễn tả rằng các đối số hợp lý cho một hàm là một inthoặc hai ints? type(args)đưa ra Tupledự đoán của tôi là chú thích loại như Union[Tuple[int, int], Tuple[int]], nhưng điều này không hoạt động.

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

Thông báo lỗi từ 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]]"

Điều này có nghĩa là mypy không thích điều này đối với lệnh gọi hàm vì nó hy vọng sẽ có một tuplecuộc gọi trong chính nó. Việc bổ sung sau khi giải nén cũng gây ra lỗi đánh máy mà tôi không hiểu.

Làm thế nào để một chú thích các loại hợp lý cho *argsvà **kwargs?

Đối với các đối số vị trí biến ( *args) và đối số từ khóa biến ( **kw), bạn chỉ cần xác định giá trị mong đợi cho một đối số như vậy.

Từ danh sách đối số tùy ý và phần giá trị đối số mặc định của Loại gợi ý PEP:

Danh sách đối số tùy ý cũng có thể được chú thích, sao cho định nghĩa:

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

được chấp nhận và điều đó có nghĩa là, ví dụ, tất cả các lệnh gọi hàm đại diện sau với các loại đối số hợp lệ:

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

Vì vậy, bạn muốn chỉ định phương pháp của bạn như thế này:

def foo(*args: int):

Tuy nhiên, nếu hàm của bạn chỉ có thể chấp nhận một hoặc hai giá trị số nguyên, bạn hoàn toàn không nên sử dụng *args, hãy sử dụng một đối số vị trí rõ ràng và đối số từ khóa thứ hai:

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

Bây giờ chức năng của bạn thực sự bị giới hạn ở một hoặc hai đối số và cả hai phải là số nguyên nếu được chỉ định. *args luôn luôn có nghĩa là 0 trở lên, và không thể bị giới hạn bởi loại gợi ý đến một phạm vi cụ thể hơn.

Cách thích hợp để làm điều này là sử dụng @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))

Lưu ý rằng bạn không thêm @overloadhoặc nhập chú thích vào việc triển khai thực tế, điều này phải đến sau cùng.

Bạn sẽ cần một phiên bản mới của cả hai typingvà mypy để nhận được hỗ trợ cho @overload bên ngoài các tệp sơ khai .

Bạn cũng có thể sử dụng điều này để thay đổi kết quả trả về theo cách làm rõ ràng loại đối số nào tương ứng với loại trả về. ví dụ:

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

Là một bổ sung ngắn cho câu trả lời trước, nếu bạn đang cố gắng sử dụng mypy trên các tệp Python 2 và cần sử dụng các nhận xét để thêm các loại thay vì chú thích, bạn cần phải thêm tiền tố các loại cho argsvà kwargsvới *và **tương ứng:

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

Điều này được mypy coi là giống như bên dưới, phiên bản Python 3.5 của foo:

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