Python mypy 检查 TypeVar(bound=Union[A, B]) 的返回类型不会出错 vs TypeVar(A, B) 会出错

Question

当我以两种不同的方式使用 TypeVar 时，我一直试图理解它的边界：

• Enums = TypeVar("Enums", Enum1, Enum2)
• Enums = TypeVar("Enums", bound=Union[Enum1, Enum2])

这是我正在使用的代码：

#!/usr/bin/env python3.6

"""Figuring out why enum is saying incompatible return type."""


from enum import IntEnum, EnumMeta
from typing import TypeVar, Union


class Enum1(IntEnum):

    MEMBER1 = 1
    MEMBER2 = 2


class Enum2(IntEnum):

    MEMBER3 = 3
    MEMBER4 = 4


# Enums = TypeVar("Enums", bound=Union[Enum1, Enum2])  # Case 1... Success
Enums = TypeVar("Enums", Enum1, Enum2)  # Case 2... error: Incompatible return value


def _enum_to_num(val: int, cast_enum: EnumMeta) -> Enums:
    return cast_enum(val)


def get_some_enum(val: int) -> Enum1:
    return _enum_to_num(val, Enum1)


def get_another_enum(val: int) -> Enum2:
    return _enum_to_num(val, Enum2)  # line 35

运行mypy==0.770时：

• Case 1: Success: no issues found
• Case 2: 35: error: Incompatible return value type (got "Enum1", expected "Enum2")

这个案例非常类似于这个问题：Difference between TypeVar('T', A, B) and TypeVar('T', bound=Union[A, B])

答案说明使用案例1(bound=Union[Enum1, Enum2])时，以下是合法的：

1. Union[Enum1, Enum2]
2. Enum1
3. Enum2

并且当使用 case 2 (A, B) 时，以下是合法的：

1. Enum1
2. Enum2

---

但是，我认为这个答案不能解释我的问题，我没有使用 Union 案例。

谁能告诉我这是怎么回事？

Answer 1

我认为错误的发生是因为类型检查器没有足够的信息通过查看输入参数的类型来推断返回类型。虽然处理可能会有所改善。

假设你有一个简单的泛型函数：

Enums = TypeVar("Enums", Enum1, Enum2)

def add(x: Enums, y: Enums) -> Enums:
    return x

类型检查器可以通过输入参数的类型推断返回类型：

add(Enum2.MEMBER3, Enum2.MEMBER4) # ok, return Enum2
add(Enum1.MEMBER1, Enum1.MEMBER2) # ok, return Enum1

add(Enum2.MEMBER3, Enum1.MEMBER2) # not ok

再看看你的函数_enum_to_num，类型检查器没有办法推断返回类型，它只是不知道会返回什么类型，因为它不知道cast_enum会返回什么类型：

def _enum_to_num(val: int, cast_enum: EnumMeta) -> Enums:
    return cast_enum(val)

静态类型检查的想法是它在不执行的情况下评估代码，它调查变量的类型，而不是动态的值。通过查看cast_enum 的类型，即EnumMeta，类型检查器无法判断cast_enum 是否会返回Enums。看起来它只是假设它将返回Enum1，并导致_enum_to_num(val, Enum2) 中的错误。

您知道_enum_to_num(val, Enum2) 将返回Enum2，因为您知道cast_enum 的值 是Enum2。 value 是 type 检查器通常不会触及的东西。可能会造成混淆，变量cast_enum的值是Enum2，而cast_enum的类型是EnumMeta，虽然Enum2是一个类型。

可以通过使用typing.Type 告诉类型检查器类型将通过cast_enum 来解决此问题：

from typing import TypeVar, Union, Type

...

def _enum_to_num(val: int, cast_enum: Type[Enums]) -> Enums:
    return cast_enum(val)

错误将消失，因为现在类型检查器可以推断返回类型。

Answer 2

我先写一点关于 mypy 看到和报告的内容，然后提出这是否是 mypy 错误的问题。

消息：

Incompatible return value type (got "Enum1", expected "Enum2")

在这里的意思大致是 Enum2 或它的子类型。 Enum2 是 get_another_enum() 的声明返回值。但是 mypy 认为函数调用 _enum_to_num() 正在返回 Enum1 类型。

“大致”部分是因为当类型未绑定，或者是Any，或Union 类型时，类型检查存在异常；但这不适用于此示例。

Mypy 决定 _enum_to_num() 中的函数 cast_enum() 正在返回 Enums 中列出的 first 类型——我想作为静态类型检查器，它必须选择一个，这就是它做。

因此，如果您在Enums 分配中切换顺序并编写：

Enums = TypeVar("Enums", Enum2, Enum1)  # Case 2... error: Incompatible return value

那么第 35 行会成功，但是get_some_enum() 中的返回会失败并显示消息：

error: Incompatible return value type (got "Enum2", expected "Enum1")

至于这是否是mypy的bug，很难说……

您可以使用type() 或ininstance() 函数在此处找到动态类型错误； 运行代码也按预期工作。

另一方面，无论是在编译时还是运行时，Python 都不会检查返回类型：您可以将 _enum_to_none() 的返回类型更改为 None，这对于 Python 解释器仍然有效很担心。

然后问题归结为：在 mypy 强加的静态类型系统中，这是一个错误吗？ （我不认为 PEP 484、526 或其他数字试图解决这个问题）。

更有资格的人应该回答这个问题，这是否是一个应该被静态分析器捕获的错误，尤其是 mypy。

查看 Ken Hung 的回答，了解更明确的方法并消除 mypy 的错误。