为SimPy仿真函数加类型注解：Generator/Iterable/Iterator如何选择？

先理清核心类型的区别 #

这三个类型的层级和定位差异很关键：

• Generator[YieldType, SendType, ReturnType]：最精准的生成器专属类型，三个泛型参数分别对应：
  • YieldType：函数中yield产出值的类型
  • SendType：通过send()方法传入生成器的值的类型
  • ReturnType：函数最终return的值的类型
• Iterator[YieldType]：表示支持next()操作的可迭代对象，是Generator的父类，但会丢失send()和返回值的类型信息
• Iterable[YieldType]：仅表示可被遍历（比如for循环），连next()操作的特性都无法体现，是最宽泛的类型

SimPy场景的最优选择 #

SimPy的进程函数（比如你测试的drive()）本质是事件驱动的生成器，按以下逻辑选注解：

1. 函数内部yield的都是SimPy的Event（或其子类，如Timeout、Process），所以YieldType设为Event或更具体的事件类型
2. SimPy会在事件完成后，把事件结果通过send()传入生成器，这个值的类型取决于事件（比如Timeout返回None，Process返回子进程的返回值），不确定的话可以用Any
3. 大多数SimPy进程函数没有显式返回值，所以ReturnType设为None

举个精准注解的例子：

from simpy import Environment, Event
from typing import Generator

def drive(env: Environment) -> Generator[Event, Any, None]:
    yield env.timeout(1)
    # 其他仿真逻辑

如果你的函数只yield特定事件（比如仅Timeout），可以把YieldType改成Timeout，进一步缩小类型范围。

为什么Mypy允许其他注解？ #

因为Generator是Iterator的子类，而Iterator又是Iterable的子类，用父类注解生成器函数时，Mypy会判定类型兼容，但这会丢失关键的类型约束：

• 用Iterator[Event]：无法体现生成器支持send()的特性，也没法标注返回值类型
• 用Iterable[Event]：连迭代器的next()操作特性都无法体现，属于过度宽泛的描述

通用场景的选择原则 #

• 需要精确描述生成器的产出、传入、返回三个维度类型时，必须用Generator
• 仅需表示对象可被遍历，不需要迭代器或生成器特性时，用Iterable
• 需要支持next()操作，但不关心send()和返回值时，用Iterator

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