python - 使用 Mypy 与类继承的混淆 - 列表与序列

Question

请原谅我的困惑 - 我是使用打字的新手，并尝试将其与 mypy 一起使用进行检查。看起来我遇到的问题似乎发生在开始大量使用打字和 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 会出现问题。 ...或者可能困惑为什么“列表是不变的，但序列是协变的”。

所以我问，也许代表像我这样尝试真正使用打字的人，所以 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)

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

但是，如果我们实际尝试运行该程序，当我们调用 check_specific_images 时，我们会收到运行时错误! modify_series 在我们的 List[SpecificImageType1] 中添加了一个 TestResultImage 对象，导致随后对 check_specific_images 的调用在运行时崩溃。

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

为什么？因为列表支持 写操作。将 TestResultImage(或 TestResultImage 的任何子类型)插入 List[TestResultImage] 应该始终是安全的，但对于 List[SpecificImageType1] 则不然。

---

因此，如果问题是列表是可变的，那么如果我们改用不可变的类型(仅支持读取操作)呢？这将使我们完全回避这个问题。

这正是 Sequence 的本质:它是一种包含列出支持的所有只读方法的类型(并且是 List 的父类(super class)型)。

---

更广泛地说，假设我们有某种泛型类型 Wrapper[T] 以及两个类 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] 的子类型，Wrapper[Child] 是 Wrapper[Parent] 的子类型。

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

1. 如果一个类是协变的，它只能支持针对 T 的读取操作。实际上，这意味着您无法定义接受任何类型 T 的方法。
2. 如果一个类是逆变的，它只能支持针对 T 的写入操作。实际上，这意味着您不允许定义返回 T 类型的任何内容的方法。
3. 如果一个类是不变的，它可以支持对 T 的读取和写入操作。您可以定义的方法类型没有限制。

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

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

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