为什么mypy忽略包含类型与TypeVar不兼容的泛型变量?

时间:2019-03-27 10:48:11

标签: python types type-hinting mypy

下面,我定义类型变量,泛型类型别名和点积函数。 mypy不会引发错误。为什么不呢?

我希望它会引起v3的错误,因为它是字符串的向量,并且我已经指定T必须是intfloatcomplex

from typing import Any, Iterable, Tuple, TypeVar

T = TypeVar('T', int, float, complex)
Vector = Iterable[T]

def dot_product(a: Vector[T], b: Vector[T]) -> T:
    return sum(x * y for x, y in zip(a, b))

v1: Vector[int] = []    # same as Iterable[int], OK
v2: Vector[float] = []  # same as Iterable[float], OK
v3: Vector[str] = []    # no error - why not?

1 个答案:

答案 0 :(得分:1)

我认为这里的问题是,当您构造类型别名时,您实际上并没有在构造新的类型-您只是给现有的昵称或备用拼写。

如果您正在做的只是提供一种类型的替代拼写,这意味着在这样做时应该不可能添加任何额外的行为。这就是这里发生的事情:您正在尝试向Iterable添加其他信息(您的三个类型约束),而mypy忽略了它们。在mypy docs on generic type aliases的底部,有一条基本上是这样的音符。

mypy只是默默使用TypeVar而没有警告其附加约束被忽略的事实,实际上感觉像是一个错误。具体来说,这感觉像是一个可用性错误:Mypy应该在这里发出警告,并且不允许在类型别名中使用除不受限制的typevar之外的任何其他内容。


那您该怎么办呢?

好吧,一种干净的解决方案是不必费心创建Vector类型的别名-或创建它,而不用担心可以使用它进行参数化。

这意味着用户可以创建一个Vector[str](也称为Iterable[str]),但这没什么大不了的:他们在尝试将其实际传递给任何函数(如您的{em)做的dot_product函数使用类型别名。

第二种解决方案是创建自定义vector子类。如果这样做,您将创建一个新类型,因此可以实际添加新的约束-但您将不再能够将列表等直接传递到您的dot_product中类:您需要将它们包装在自定义的Vector类中。

这可能有点笨拙,但是您仍然可能最终转向该解决方案:它使您有机会向新的Vector类添加自定义方法,这可能有助于提高代码的整体可读性,具体取决于你到底在做什么。

第三个也是最后一个解决方案是定义自定义“向量” Protocol。这样可以避免我们将列表包装在一些自定义类中,并且我们正在创建一个新类型,以便可以添加所需的任何约束。例如:

from typing import Iterable, TypeVar, Iterator, List
from typing_extensions import Protocol

T = TypeVar('T', int, float, complex)

# Note: "class Vector(Protocol[T])" here means the same thing as 
# "class Vector(Protocol, Generic[T])".
class Vector(Protocol[T]):
    # Any object that implements these three methods with a compatible signature
    # is considered to be compatible with "Vector".

    def __iter__(self) -> Iterator[T]: ...

    def __getitem__(self, idx: int) -> T: ...

    def __setitem__(self, idx: int, val: T) -> None: ...

def dot_product(a: Vector[T], b: Vector[T]) -> T:
    return sum(x * y for x, y in zip(a, b))

v1: Vector[int] = []    # OK: List[int] is compatible with Vector[int]
v2: Vector[float] = []  # OK: List[float] is compatible with Vector[int]
v3: Vector[str] = []    # Error: Value of type variable "T" of "Vector" cannot be "str"

dot_product(v3, v3)  # Error: Value of type variable "T" of "dot_product" cannot be "str"

nums: List[int] = [1, 2, 3]
dot_product(nums, nums)  # OK: List[int] is compatible with Vector[int]

此方法的主要缺点是,您无法真正在协议中添加任何具有实际逻辑的方法,这些方法可以在可能被视为“向量”的任何对象之间重用。 (好吧,您可以,但在您的示例中不会有用)。