如何在Python元类中为__iter__方法添加Self类型提示？

需求背景 #

我定义了代表生物基因和基因组的Gene和Genome类，需要实现以下遍历逻辑：

for being in Genome:
    ...

for gene in Gene:
    ...

核心要求是类本身可迭代（而非类的实例），用来遍历Gene的所有可能组合（例如A型血基因的AA、AO、OA），或者Genome的所有可能组合（例如包含眼色、血型、Rh抗原基因的全部组合）。

尝试的实现方式 #

最初尝试用@classmethod def __iter__(cls)，但发现__iter__会被硬绑定到实例而非类，无法实现类级别的迭代。于是我创建了如下元类：

from typing import Iterator

class Generable(type):
    # 重写__iter__使其关联到类而非实例
    def __iter__(self) -> Iterator:
        yield from self.iterator()
    def iterator(self) -> Iterator:
        ...

接着定义Gene和Genome类：

from typing import Iterator, Self

class Gene(metaclass=Generable):
    @classmethod
    def iterator(cls) -> Iterator[Self]:
        # 生成所有可能的Gene实例
        ...

class Genome(metaclass=Generable):
    @classmethod
    def iterator(cls) -> Iterator[Self]:
        # 生成所有可能的Genome实例
        ...

遇到的类型提示问题 #

在元类Generable中，无法为__iter__方法添加Iterator[Self]类型提示（元类定义不允许使用大写的Self），这导致编写for being in Genome:时，being的类型被识别为未知——因为Generable.__iter__()返回的是Iterator[unknown]。

如果把元类改成下面这样：

class Generable(type):
    def __iter__(self) -> Iterator['Generable']:
        yield from self.iterator()
    def iterator(self) -> Iterator['Generable']:
        ...

虽然能解决类型提示的问题，但being会被提示为Generable类型，这显然不准确。而且Gene和Genome彼此独立，没有统一的父类可用，我真正需要的是让Generable.__iter__()返回Iterator[Self]。

解决方案：使用泛型元类 #

通过给元类添加泛型参数，就能在类型提示中准确指代子类本身，具体实现如下：

from typing import Iterator, TypeVar, Generic, Self

# 定义类型变量，用于指代继承自Generable的子类
T = TypeVar('T')

class Generable(type, Generic[T]):
    def __iter__(self) -> Iterator[T]:
        yield from self.iterator()
    
    def iterator(self) -> Iterator[T]:
        # 由子类的classmethod实现具体逻辑
        raise NotImplementedError("子类必须实现iterator方法")

# 定义Gene类时，将泛型参数绑定到自身
class Gene(metaclass=Generable['Gene']):
    @classmethod
    def iterator(cls) -> Iterator[Self]:
        # 示例：生成AA、AO、OA三种Gene实例
        yield cls("AA")
        yield cls("AO")
        yield cls("OA")
    
    def __init__(self, genotype: str):
        self.genotype = genotype

# 定义Genome类时，同样将泛型参数绑定到自身
class Genome(metaclass=Generable['Genome']):
    @classmethod
    def iterator(cls) -> Iterator[Self]:
        # 示例：生成不同组合的Genome实例
        yield cls("蓝眼", "A", "+")
        yield cls("棕眼", "O", "-")
    
    def __init__(self, eye_color: str, blood_type: str, rh_factor: str):
        self.eye_color = eye_color
        self.blood_type = blood_type
        self.rh_factor = rh_factor

原理说明 #

1. 泛型元类：让Generable继承Generic[T]，用类型变量T指代具体的子类（如Gene或Genome）。
2. 类型绑定：定义子类时通过metaclass=Generable['Gene']将泛型参数T绑定到子类自身，这样元类的__iter__就能返回Iterator[Gene]或Iterator[Genome]，类型提示会准确识别。
3. Self类型配合：子类的iterator方法使用Self类型，确保返回的是子类自身的实例，和元类的泛型定义形成呼应。

修改后，遍历Gene或Genome时，编辑器会正确识别迭代元素的类型，完全满足需求。

内容的提问来源于stack exchange，提问作者Nuno