glob 生成器的类型注释

Question

我的函数应该返回一个生成器，该生成器通过来自pathlib 模块的Path 生成特定签名的文件。问题是我不明白如何在 Python 3 中正确注释函数。

函数如下：

from pathlib import Path
from typing import Generator

def get_waves_generator(directory: str) -> ???:
    gen = Path(directory).rglob('*.wav')
    return gen

我找到了this answer，它本质上是文档的副本。我需要用以下注释它

Generator[YieldType, SendType, ReturnType]

就我而言，YieldType、SendType 和 ReturnType 是什么？

Answer 1

来自the docs：

一个生成器可以被泛型类型Generator[YieldType, SendType, ReturnType]注解。例如：

def echo_round() -> Generator[int, float, str]:
    sent = yield 0
    while sent >= 0:
        sent = yield round(sent)
    return 'Done'

请注意，与类型模块中的许多其他泛型不同， SendType of Generator 的行为是逆变的，而不是协变的或 不变。

如果您的生成器只会产生值，请设置 SendType 和 ReturnType 无：

def infinite_stream(start: int) -> Generator[int, None, None]:
    while True:
        yield start
        start += 1

由于该生成器正在返回 pathlib.Path 的实例，您可以这样做

from pathlib import Path
from typing import Generator

def get_waves_generator(directory: str) -> Generator[Path, None, None]:
    gen = Path(directory).rglob('*.wav')
    return gen