如何为 bool 参数按值编写 types.overload 装饰器

问题描述 投票:0回答:2

我想问的示例代码如下。
互联网上的示例都没有尝试重载参数值。
其中一个参数是 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

上面示例代码中的重载代码是否正确?
你能给出一个提到这种重载的示例/博客/源吗,因为我在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

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

python mypy python-typing pyright
2个回答
26
投票

安装 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

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


19
投票

构建正确的接受的答案

@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

第一个重载(带有

Literal[True]
)用于对函数调用
myfunc(True)
myfunc()
进行类型检查,而第二个重载(带有
Literal[False]
)用于对函数调用
myfunc(False)
进行类型检查。

© www.soinside.com 2019 - 2024. All rights reserved.