Python嵌套协议的类型检查行为与Mypy的局限性

本文深入探讨了python中嵌套协议（Nested Protocols）在类型检查工具Mypy和Pylance中的行为。我们发现，当内部协议作为嵌套类实现时，Mypy/Pylance可能无法正确检测类型不匹配。文章解释了这一现象是Mypy的一个已知限制，并对比了Pyright在此场景下的正确行为，同时提供了Mypy用户通过外部定义类型并赋值的有效规避方案。

在Python的类型提示系统中，Protocol 提供了一种强大的方式来实现结构化子类型（structural subtyping），允许我们定义一个类型必须具备哪些属性和方法，而无需显式继承。这在构建灵活的接口和组件时非常有用。然而，当协议内部包含另一个协议（即嵌套协议）时，其类型检查行为在不同的工具中可能存在差异，尤其是在Mypy和Pylance中。

理解嵌套协议与类型检查挑战

考虑以下场景：我们定义了一个 Parent 协议，它要求一个名为 Child 的属性，而这个 Child 属性本身又是一个 Child 协议的实例，该 Child 协议要求一个 name 字符串属性。

from typing import Protocol  class Child(Protocol):     name: str  class Parent(Protocol):     Child: Child  # 尝试实现 Parent 协议 class FooBar(Parent):     class Child:         # 这里缺少 name 属性         pass

在这个例子中，FooBar 类内部定义了一个名为 Child 的嵌套类。根据 Parent 协议的定义，FooBar.Child 应该符合 Child 协议，即它必须有一个 name: str 属性。然而，在上述实现中，FooBar.Child 并没有 name 属性。直观上，我们期望类型检查器能报告一个错误。

立即学习“Python免费学习笔记（深入）”；

Mypy/Pylance的局限性

令人惊讶的是，在使用Mypy或Pylance（基于Pyright，但Pylance的某些版本或配置可能与Pyright行为不完全一致）进行类型检查时，上述代码可能不会报告任何错误。这表明Mypy/Pylance在处理这种“作为嵌套类实现的嵌套协议”的场景时，未能正确地推断并检查内部协议的类型合规性。

这并非Mypy的缺陷，而是其内部实现的一个已知限制。Mypy社区已经记录了相关问题（例如gitHub上的issue #14767），表明这种对嵌套类属性的协议检查尚未完全实现。

Pyright的对比行为

值得注意的是，另一个流行的Python类型检查器Pyright（vs code的Pylance扩展底层就是基于Pyright，但其默认配置或版本可能有所不同）在处理此问题时表现得更为严格和准确。Pyright能够正确地识别出 FooBar.Child 违反了 Child 协议，因为它缺少 name 属性，从而报告相应的类型错误。这表明在某些复杂的类型检查场景下，Pyright可能提供更全面的类型安全保障。

Mypy的规避方案

尽管Mypy存在上述限制，但我们可以通过调整代码结构来规避这一问题，使其能够正确地检查嵌套协议。核心思想是避免将内部协议的实现直接作为嵌套类定义，而是将其定义为外部类，然后作为属性赋值给实现类。

芦笋演示

一键出成片的录屏演示软件，专为制作产品演示、教学课程和使用教程而设计。

227

查看详情

以下是Mypy能够正确检测错误的修改方案：

from typing import Protocol  class Child(Protocol):     name: str  class Parent(Protocol):     Child: Child  # 将 Child 的实现定义为外部类 class _ChildImpl:     pass # 仍然缺少 name 属性  class FooBar(Parent):     # 将外部定义的类赋值给 Child 属性     Child = _ChildImpl

在这种修改后的代码中，Mypy会报告以下错误：

E: Incompatible types in assignment (expression has type "type[_ChildImpl]", base class "Parent" defined the type as "Child")  [assignment]

错误分析：

Mypy现在能够识别到 _ChildImpl 类型与 Parent 协议期望的 Child 协议不兼容，因为它缺少 name 属性。这是因为当 Child 被赋值为一个外部类型时，Mypy能够更有效地对其进行类型推断和协议检查。

正确的实现方式：

为了完全符合协议，_ChildImpl 应该包含 name 属性：

from typing import Protocol  class Child(Protocol):     name: str  class Parent(Protocol):     Child: Child  # 正确实现 Child 协议的外部类 class _ChildImpl:     name: str = "default_name" # 提供 name 属性  class FooBar(Parent):     Child = _ChildImpl # 现在类型检查通过

注意事项与总结

1. Mypy的限制：当在实现一个协议时，其内部属性本身也是一个协议，并且这个内部协议的实现被定义为一个嵌套类时，Mypy可能不会对其进行完整的协议检查。
2. 规避策略：为了确保Mypy能够正确检查嵌套协议，建议将内部协议的实现定义为独立的外部类，然后将其赋值给实现类中的相应属性。
3. 工具选择：对于需要更严格和全面类型检查的场景，特别是涉及复杂协议和嵌套结构时，可以考虑使用Pyright，因为它在某些特定情况下可能提供更强大的类型推断能力。
4. 清晰的类型定义：无论使用何种工具，始终建议保持类型定义的清晰和直接。避免过于复杂的嵌套结构，或在必要时通过外部定义和赋值的方式来帮助类型检查器更好地理解代码意图。

理解这些限制和规避方案，有助于我们在使用Python的类型提示系统时，构建更健壮、更易于维护的代码。