Python NewType('X', Y): mypy 显示错误：得到 Y，预期 X

Question

我想使用一个类型检查器来帮助我编写好的代码，我认为mypy 可以满足我的需求。但我不明白如何编写以下代码。

import typing as tau

Offset = tau.NewType('Offset', tau.Tuple[int, int])


def f(x: int, y: int) -> Offset:
    return x, y


important_for_me = Offset != tau.Tuple[int, int]
assert important_for_me

对于我正在编写的框架，重要的是不仅要为类型分配标识符，而且我仍然希望类型检查器知道如何帮助我（所以不仅仅是分配 TypeVar 并丢失信息）。

typing.NewType 工作得很好，但 mypy 在第 7 行给我一个错误：

返回值类型不兼容（得到“Tuple[int, int]”，预期 “偏移”）

有没有一种方法可以像我一样编写它，但要让类型检查器理解它？

Answer 1

您需要从您的 x, y 元组显式创建一个 Offset：

def f(x: int, y: int) -> Offset:
    return Offset((x, y))

这是因为，从 NewType helper function 开始：“类型检查器需要从 int 显式转换，而 UserId 是预期的”，或者在您的情况下：从 Tuple[int, int] 到 Offset。

可能只是为了您的示例，但如果 f 在返回 Offset 之前确实没有对 x 和 y 执行任何验证，则此处的 NewType 是不必要的。在这种情况下，我建议将Offset 声明为：

Offset = tau.Tuple[int, int]

这是一个type alias。