如何使用多个可选的ARG键入超载功能？

Question

我的功能具有多个带有默认值的Kwargs。其中之一（在中间的某个地方）是一个布线切换，可以控制返回类型。

我想用字面[true/fals] 为此方法创建两个过载，但要保持默认值。

我的想法是以下内容：

from typing import overload, Literal

@overload
def x(a: int = 5, t: Literal[True] = True, b: int = 5) -> int: ...

@overload
def x(a: int = 5, t: Literal[False] = False, b: int = 5) -> str: ...

def x(a: int = 5, t: bool = True, b: int = 5) -> int | str:
    if t:
        return 5
    return "asd"

但是Mypy提出了：

错误：与不兼容的返回类型重叠的函数签名1和2重叠

我认为这是因为 x（）会冲突。

但是我无法在第二个重载中删除默认 = false 值，因为它先于agr a 带有默认值。

我如何正确地重载，以使

• x（）→ int
• x（t = true）→ int int
• 代码> x（t = false）→ str

Answer 1

这是一个古老的问题。原因是您在两个分支中指定默认值，因此 x（）在两者中都是可能的，并且返回类型不确定。

我对这种情况有以下模式：

from typing import overload, Literal

@overload
def x(a: int = ..., t: Literal[True] = True, b: int = ...) -> int: ...

@overload
def x(a: int = ..., *, t: Literal[False], b: int = ...) -> str: ...

@overload
def x(a: int, t: Literal[False], b: int = ...) -> str: ...

def x(a: int = 5, t: bool = True, b: int = 1) -> int | str:
    if t:
        return 5
    return "asd"

为什么以及如何？您必须考虑调用功能的方法。首先，您可以提供 a ，然后可以提供 t 作为夸尔格（＃2）或arg（＃3）。您也可以留下 默认值，然后 t 始终是Kwarg（再次＃2）。这是防止在Kwarg之后放置ARG的需要的，这是 SyntaxError 。在多个参数上过载更加困难，但也可能是这样：

@overload
def f(a: int = ..., b: Literal[True] = ..., c: Literal[True] = ...) -> int: ...

@overload
def f(a: int = ..., *, b: Literal[False], c: Literal[True] = ...) -> Literal['True']: ...

@overload
def f(a: int = ..., *, b: Literal[False], c: Literal[False]) -> Literal['False']: ...

@overload
def f(a: int, b: Literal[False], c: Literal[True] = ...) -> Literal['True']: ...

@overload
def f(a: int, b: Literal[False], c: Literal[False]) -> Literal['False']: ...

def f(a: int = 1, b: bool = True, c: bool = True) -> int | Literal['True', 'False']:
    return a if b else ('True' if c else 'False')  # mypy doesn't like str(c)

您可以使用超载在这里。

eLLIPSIS（ ... ）在过载签名中默认值表示“有默认值，请参阅实现其值”。它与类型检查器的实际值没有什么不同，但是使您的代码saner（默认值仅在实际签名中定义，而不是重复）。

Answer 2

超载具有默认值是没有意义的，并且您 can 删除字面参数的默认值，只要您还从其他参数中删除默认值即可。

@overload
def x(a: int | None, t: Literal[True], b: int | None ) -> int: ...

@overload
def x(a: int | None, t: Literal[False], b: int | None ) -> str: ...