พิมพ์คำอธิบายประกอบสำหรับ * args และ ** kwargs

ฉันกำลังลองใช้คำอธิบายประกอบชนิดของ Python พร้อมคลาสเบสที่เป็นนามธรรมเพื่อเขียนอินเตอร์เฟส มีวิธีการอธิบายประเภทที่เป็นไปได้*argsและ**kwargs?

ตัวอย่างเช่นเราจะแสดงให้เห็นว่าข้อโต้แย้งที่สมเหตุสมผลกับฟังก์ชั่นนั้นเป็นได้intหรือintไม่? 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อย่างไร

สำหรับตัวแปรตำแหน่งอาร์กิวเมนต์ ( *args) และอาร์กิวเมนต์คำหลักตัวแปร ( **kw) คุณจะต้องระบุค่าที่คาดไว้สำหรับอาร์กิวเมนต์หนึ่งรายการเท่านั้น

จากรายการอาร์กิวเมนต์โดยพลการและค่าอาร์กิวเมนต์เริ่มต้นในส่วนของประเภทคำแนะนำ PEP:

รายการอาร์กิวเมนต์ตามอำเภอใจสามารถพิมพ์คำอธิบายประกอบได้ดังนั้นคำจำกัดความ:

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

เป็นที่ยอมรับและก็หมายความว่าเช่นทั้งหมดต่อไปนี้เป็นตัวแทนการเรียกใช้ฟังก์ชันที่มีประเภทของอาร์กิวเมนต์ที่ถูกต้อง:

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

ตอนนี้ฟังก์ชั่นของคุณถูก จำกัด ไว้ที่หนึ่งหรือสองอาร์กิวเมนต์และทั้งสองต้องเป็นจำนวนเต็มถ้าระบุ หมายถึง 0 *args เสมอหรือมากกว่าและไม่สามารถถูก จำกัด โดยคำแนะนำประเภทเป็นช่วงที่เฉพาะเจาะจงมากขึ้น

วิธีที่เหมาะสมในการทำเช่นนี้คือการใช้ @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))

นอกเหนือจากคำตอบก่อนหน้านี้หากคุณพยายามใช้ 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