混淆使用具有 class 继承的 Mypy - 列表与序列

Question

请原谅我的困惑 - 我刚开始使用打字并尝试将它与 mypy 一起用于检查。看起来 problem/question 我似乎已经开始大量使用打字和 Mypy 的人。

问题

我正在尝试定义数据的抽象组合类，它将被子类化为具体的类以添加额外的数据。

因此，我尝试以简化形式执行以下操作：

from dataclasses import dataclass
from typing import List

@dataclass
class TestResultImage:
    base_var_a: int 


@dataclass
class TestSeries:
    imgs: List[TestResultImage]

# --- concrete instances -------

@dataclass
class SpecificImageType1(TestResultImage):
    specific_var_b: float
    specific_var_c: int 


@dataclass
class SpecificSeries(TestSeries):
    imgs: List[SpecificImageType1]

Mypy 执行上述操作失败并出现错误\

error: Incompatible types in assignment (expression has type "List[SpecificImageType1]", base class "TestSeries" defined the type as "List[TestResultImage]")
note: "List" is invariant -- see http://mypy.readthedocs.io/en/latest/common_issues.html#variance
note: Consider using "Sequence" instead, which is covariant

修复

将 {List} 更改为 {Sequence} 解决了问题 - 如错误中所述。

问题

我已经看到不少 SO 和 Mypy git 与此问题相关的问题和人们的困惑。

所以我去尝试尽可能多地阅读 Mypy 文档。

但它仍然是 - 恕我直言 - 为什么 List 在你子类化时会出现问题。 ...或者可能对为什么 'List is invariant, but Sequence is covariant'.

感到困惑

所以我想问，也许代表像我这样尝试真正使用打字的人，所以 Mypy，除了微不足道的例子之外 - 是否有关于 List 有问题的原因的任何好的解释，以及任何地方的一些例子？

Answer 1

假设我们将以下内容添加到您的原始代码中：

def check_specific_images(imgs: List[SpecificImageType1]) -> None:
    for img in imgs:
        print(img.specific_var_b)

def modify_series(series: TestSeries) -> None:
    series.append(TestResultImage(1))

specific = SpecificTestSeries(imgs=[
    SpecificImageType1(1, 2.0, 3),
    SpecificImageType1(4, 5.0, 6),
])

modify_series(specific)
check_specific_images(specific.imgs)

这个程序表面上应该进行类型检查：specific 是 TestSeries 的一个实例，因此 modify_series(specific) 是合法的。同样，specific.imgs 是 List[SpecificImageType1] 类型，所以 check_specific_images(specific.imgs) 也是合法的。

但是，如果我们真的尝试运行这个程序，我们会在调用 check_specific_images 时得到一个运行时错误！ modify_series 向我们的列表 [SpecificImageType1] 添加了一个 TestResultImage 对象，导致随后对 check_specific_images 的调用在运行时崩溃。

这个问题从根本上解释了为什么 mypy（或几乎任何其他健全的类型系统）不会让 List[SpecificImageType1] 被视为 List[TestResultImage] 的子类型。为了使一种类型成为另一种类型的有效子类型，应该可以在需要父类型的任何位置安全地使用子类型。这对于列表来说是不正确的。

为什么？因为列表支持写操作。将 TestResultImage（或 TestResultImage 的任何子类型）插入到 List[TestResultImage] 中应该始终是安全的，而对于 List[SpecificImageType1].

则不是这样

因此，如果问题是列表是可变的，那么如果我们改为使用不可变的类型——仅支持读取操作，会怎样？这会让我们完全回避这个问题。

这正是 Sequence 的本质：它是一种包含列表支持的所有只读方法的类型（并且是 List 的超类型）。

更广泛地说，假设我们有某种泛型类型 Wrapper[T] 以及两个 classes Parent 和 Child，其中 Child 是 Parent 的子类型。

这就提出了一个问题：Wrapper[Parent] 与 Wrapper[Child] 有什么关系？

对此有四种可能的答案：

Wrapper 是 协变的：Wrapper[Child] 是 Wrapper[Parent] 的子类型。
Wrapper 是逆变：Wrapper[Parent] 是Wrapper[Child] 的子类型。
Wrapper 是 不变的：Wrapper[Parent] 和 Wrapper[Child] 彼此无关，也不是对方的子类型。
Wrapper 是双变量：Wrapper[Parent] 是 Wrapper[Child] 的子类型 and Wrapper[Child ] 是 Wrapper[Parent].

当您定义 Wrapper[T] 时，mypy 会让您选择您希望该类型是协变的、逆变的还是不变的。做出选择后，mypy 将执行以下规则：

如果 class 是协变的，它只能支持对 T 的读取操作。实际上，这意味着您不能定义接受任何类型 T 的方法。
如果 class 是逆变的，它只能支持对 T 的写操作。实际上，这意味着您不能定义 return 任何类型 T 的方法。
如果一个class是不变的，它可以同时支持对T的读和写操作。你可以定义什么类型的方法没有限制。

Mypy 不允许您创建双变类型：这种类型唯一安全的情况是它支持既不对 T 的读或写操作——这会毫无意义。

您通常只在编程中看到双变类型 languages/type 有意使泛型尽可能简单的系统，即使这意味着让用户将如上所示的错误引入他们的程序。

这里的高级直觉是支持对 T 的读取操作或写入操作将限制 Wrapper[Parent] 与 Wrapper[Child] 的关系——如果您支持这两种操作，则组合约束最终会使这两种类型完全无关。

混淆使用具有 class 继承的 Mypy - 列表与序列

Confusion with using Mypy with class inheritance - List vs Sequence

python

mypy

问题

修复

问题