Python:如何按值为 bool 参数编写typing.overload 装饰器

dum*_*bPy 9 python overloading static-typing mypy pyright

我要问的示例代码如下。
互联网上没有一个例子试图重载参数值。
其中一个参数是 bool 值,我想基于 bool 值而不是通常的参数类型重载一个方法。

from typing import overload, Union

@overload
def myfunc(arg:bool=True)-> str: ...

@overload
def myfunc(arg:bool=False)-> int: ...

def myfunc(arg:bool)->Union[int, str]:
    if arg: return "something"
    else: return 0
Run Code Online (Sandbox Code Playgroud)

上面示例代码中的重载代码是否正确?
你能给出一个提到这种重载的例子/博客/来源吗,因为我在 Python 文档和pep-484 中找不到任何东西

我发现一种可能的方法是typing.Literal使用最新的 python 文档(自 python v3.8 起)

from typing import overload, Union, Literal

@overload
def myfunc(arg:Literal[True])-> str: ...

@overload
def myfunc(arg:Literal[False])-> int: ...

def myfunc(arg:bool)->Union[int, str]:
    if arg: return "something"
    else: return 0

Run Code Online (Sandbox Code Playgroud)

但是我还不能转移到 python 3.8,因为我正在处理仍然在 python 3.6 上的生产代码,很快就会升级到 3.7。
因此,我仍在寻找有关如何在 python 3.6 中实现这一目标的答案

Mic*_*x2a 13

安装包含各种类型结构的官方向后移植的typing-extensions模块。然后做:

from typing import overload, Union

# typing_extensions defines Literal for Python 3.7 and earlier, but
# re-exports it from 'typing' for later versions of Python.
from typing_extensions import Literal

@overload
def myfunc(arg: Literal[True]) -> str: ...

@overload
def myfunc(arg: Literal[False]) -> int: ...

@overload
def myfunc(arg: bool) -> Union[str, int]: ...

def myfunc(arg: bool) -> Union[int, str]:
    if arg: return "something"
    else: return 0
Run Code Online (Sandbox Code Playgroud)

请参阅mypy 文档中关于文字类型的第一个示例,了解为什么我在 bool 中包含了第三个重载。


Jas*_*sha 5

建立正确的接受答案@overloading对于默认(关键字)参数可以实现如下:

from typing import overload, Union, Literal

@overload
def myfunc(arg: Literal[True] = True) -> str: ...

@overload
def myfunc(arg: Literal[False]) -> int: ...

def myfunc(arg: bool =  True) -> Union[int, str]:
    if arg: return "something"
    else: return 0
Run Code Online (Sandbox Code Playgroud)

第一个重载 (with Literal[True]) 用于对函数调用myfunc(True)and进行类型检查myfunc(),而第二个重载 (with Literal[False]) 用于对函数 call 进行类型检查myfunc(False)

  • 此示例演示如何键入提供默认参数的函数,该参数未包含在接受的答案中。特别是,上面的模式使像 mypy 这样的类型检查器能够对不带任何参数的“myfunc”调用执行类型推断,例如“x = myfunc()”。 (3认同)
  • 如果“arg”参数前面有另一个具有默认值的参数,那么这将如何工作。例如: ```python def myfunc(some_arg: int = 0, arg: bool = True) -> int | str: ``` 在这种情况下,`mypy` 将针对第二个重载定义引发错误 `non-default argument follow default argument [syntax]`,因为它没有指定默认值。然而,实际上将默认值指定为 ```python @overload def myfunc(some_arg: int = 0, arg: Literal[False] = False) -> str: ... ``` 将打印 `重载函数签名 1 和 2与不兼容的返回类型重叠[misc]` (3认同)
  • 起初,我认为您不需要实际/非重载函数定义的类型注释。但实际上,您应该包含它们,因为否则您可能会在重载中得到错误的类型,并且它无法辨别 - 它会将所有参数视为“Any”。这似乎并没有按照应有的方式确定下来 - https://github.com/python/mypy/issues/8867#issuecomment-767842357 (2认同)