Python递归类型注解与继承的mypy错误修复方案咨询

问题描述 #

用户定义了如下类层级结构：

#!/usr/bin/env python3

from typing import List, Optional, Tuple, Type

class Attribute:
    def __init__(self, name: bytes) -> None:
        self._name = name

    @property
    def name(self) -> bytes:
        return self._name

class Element:
    def __init__(self, name: bytes, attributes: Tuple[Type['Attribute'], ...], elements: Tuple['Element', ...]) -> None:
        self._name       = name
        self._elements   = elements
        self._attributes = attributes

    @property
    def name(self) -> bytes:
        return self._name

    @property
    def elements(self) -> Tuple['Element', ...]:
        return self._elements

    @property
    def attributes(self) -> Tuple[Type['Attribute'], ...]:
        return self._attributes

class SubAttribute1(Attribute):
    def __init__(self, name: bytes, field1: bytes) -> None:
        super().__init__(name)
        self._afield1 = field1

class SubElement1(Element):
    def __init__(self, name: bytes, attributes: Tuple[Type[Attribute], ...], elements: Tuple['Element', ...], field1: bytes, field2: bytes) -> None:
        super().__init__(name, attributes, elements)
        self._field1 = field1
        self._field2 = field2
        
if __name__ == '__main__':
    subE  = SubElement1(b'name', None, None, b'', b'')
    subA  = SubAttribute1(b'name', b'field1')
    subE2 = SubElement1(b'name', (subA,), (subE,), b'', b'')
    print(subE2.elements[0]._field1)
    print(subE2.attributes[0]._afield1)
    print(type(subE2.elements[0]))

代码运行正常，但触发以下mypy错误：

question.py:45: error: Argument 2 to "SubElement1" has incompatible type "Tuple[SubAttribute1]"; expected "Tuple[Type[Attribute], ...]"
question.py:46: error: "Element" has no attribute "_field1"
question.py:47: error: "Type[Attribute]" has no attribute "_afield1"

用户期望elements和attributes字段分别存储派生类对象，需要修改代码消除这些类型错误。

错误原因分析 #

1. 类型注解与实际需求不匹配：基类Element的attributes参数被注解为Tuple[Type['Attribute'], ...]，表示它接受类类型的元组，但用户实际传入的是SubAttribute1的实例，导致类型不兼容。
2. 基类类型限制过严：elements和attributes返回的是基类类型，mypy无法识别实际存储的是子类实例，因此访问子类独有的私有字段时会报错。

解决方案 #

修改思路 #

• 修正基类的类型注解，将Type[Attribute]改为Attribute，明确存储的是实例而非类本身。
• 使用泛型让派生类可以指定elements和attributes的具体子类类型，实现类型具体化。
• 处理None的类型问题，用空元组替代不符合类型要求的None。

修改后的完整代码 #

#!/usr/bin/env python3

from typing import Tuple, TypeVar, Generic, Optional

# 定义类型变量，约束为对应基类的子类
A = TypeVar('A', bound='Attribute')
E = TypeVar('E', bound='Element')

class Attribute:
    def __init__(self, name: bytes) -> None:
        self._name = name

    @property
    def name(self) -> bytes:
        return self._name

class Element(Generic[A, E]):
    def __init__(self, name: bytes, attributes: Optional[Tuple[A, ...]] = None, elements: Optional[Tuple[E, ...]] = None) -> None:
        self._name       = name
        # 为空值提供默认空元组
        self._elements   = elements if elements is not None else ()
        self._attributes = attributes if attributes is not None else ()

    @property
    def name(self) -> bytes:
        return self._name

    @property
    def elements(self) -> Tuple[E, ...]:
        return self._elements

    @property
    def attributes(self) -> Tuple[A, ...]:
        return self._attributes

class SubAttribute1(Attribute):
    def __init__(self, name: bytes, field1: bytes) -> None:
        super().__init__(name)
        self._afield1 = field1

class SubElement1(Element[SubAttribute1, 'SubElement1']):
    def __init__(self, name: bytes, attributes: Optional[Tuple[SubAttribute1, ...]] = None, elements: Optional[Tuple['SubElement1', ...]] = None, field1: bytes = b'', field2: bytes = b'') -> None:
        super().__init__(name, attributes, elements)
        self._field1 = field1
        self._field2 = field2
        
if __name__ == '__main__':
    subE  = SubElement1(b'name')
    subA  = SubAttribute1(b'name', b'field1')
    subE2 = SubElement1(b'name', (subA,), (subE,))
    print(subE2.elements[0]._field1)
    print(subE2.attributes[0]._afield1)
    print(type(subE2.elements[0]))

关键修改点说明 #

1. 引入泛型类型变量：定义A和E两个类型变量，分别约束为Attribute和Element的子类，让Element类可以灵活指定自身的属性和元素类型。
2. 修正基类类型注解：将attributes和elements的类型改为泛型参数A和E，同时支持Optional类型，为空值提供默认空元组。
3. 派生类绑定具体类型：SubElement1继承Element[SubAttribute1, 'SubElement1']，明确声明自己的属性是SubAttribute1实例，元素是SubElement1实例，让mypy能识别子类独有的字段。
4. 优化参数默认值：给__init__参数添加默认值，简化实例化代码，同时避免传入None导致的类型错误。

内容的提问来源于stack exchange，提问作者Michael Schäfer