python - 为仅返回一组特定值的函数键入提示

Question

我有一个只能返回 a 的函数, b或 c , 它们都是 T 类型.我想在签名中包含这个事实，因为它们在函数上下文中具有特殊含义。我该怎么做？

目前我用的是这个

def fun(...) -> "a or b or c":
    #briefly explain the meaning of a, b and c in its docstring

这是正确的吗？

我知道我可以做到这一点

def fun(...) -> T:
    # briefly explain the meaning of a, b and c in its docstring

但正如我所说，我想在签名中表达该函数仅返回那些特定值。

Answer 1

你可以用 literal types 做到这一点.

from typing_extensions import Literal
# from typing import Literal  # Python 3.8 or higher

def fun(b: int) -> Literal["a", "b", "c"]:
    if b == 0:
        return "a"
    if b == 1:
        return "b"
    return "d"

mypy 能够将 return "d" 检测为无效语句:

error: Incompatible return value type (got "Literal['d']",
expected "Union[Literal['a'], Literal['b'], Literal['c']]")

python 3.8

感谢 PEP 586 , Literal 是 already included默认情况下在 Python 3.8 typing 模块中。