如何编写永远不会产生任何东西的 Python 生成器函数

Question

我想编写一个从不实际产生任何东西的 Python 生成器函数。基本上它是一个“无所事事”的插件，可以被其他期望调用生成器的代码使用（但并不总是需要它的结果）。到目前为止，我有这个：

def empty_generator():
    # ... do some stuff, but don't yield anything
    if False:
        yield

现在，这行得通，但我想知道是否有一种更具表现力的方式来表达相同的意思，即，将函数声明为生成器，即使它永远不会产生任何值。我在上面使用的技巧是在我的函数中向 Python 显示一个 yield 语句，即使它无法访问。

Answer 1

为了获得最大的可读性和可维护性，我会优先考虑位于函数顶部的构造。所以要么

1. 你原来的 if False: yield 构造，但被提升到第一行，或者
2. 一个单独的装饰器，它将生成器行为添加到非生成器可调用对象中。

（假设你不只是需要一个可调用的，它做了一些事情然后返回一个空的迭代器/迭代器。如果是这样，那么你可以只使用一个常规函数，最后使用return ()/return iter(())。）

想象一下你的代码的读者会看到：

def name_fitting_what_the_function_does():
    # We need this function to be an empty generator:
    if False: yield

    # that crucial stuff that this function exists to do

将 this 置于顶部会立即向该函数的每个读者提示该细节，会影响整个函数 - 会影响对该函数的行为和使用的预期和解释。

你的函数体有多长？不止几行？那么作为一个读者，如果我直到最后都没有得到这个函数是生成器的提示，我会对作者感到义愤填膺和谴责，因为我可能会花费大量的精神成本在我的脑海中编织一个基于模型的模型假设这是一个常规函数 - 理想情况下，生成器中的第一个 yield 应该立即可见，当您甚至不知道要查找它时。

另外，在一个多于几行的函数中，函数开头的构造更值得信赖 - 我可以相信任何看过函数的人都可能第一次看到它每次他们看它时都排成一行。这意味着如果这条线错误或损坏，有人会发现它的可能性更高。这意味着我可以不那么警惕整个东西实际上已经损坏但被以一种使损坏不明显的方式使用的可能性。

如果您正在与非常熟悉 Python 工作原理的人一起工作，您甚至可以忽略该评论，因为对于立即记得 yield 是 Python 将函数变成生成器的原因的人来说，很明显，这是效果，也可能是意图，因为没有其他理由让正确的代码有一个未执行的yield。

或者，你可以走装饰路线：

@generator_that_yields_nothing
def name_fitting_what_the_function_does():
    # that crucial stuff for which this exists


def generator_that_yields_nothing(wrapped):
    @functools.wraps(wrapped)
    def wrapper_generator():
        if False: yield
        wrapped()
    return wrapper_generator

Answer 2

更短的解决方案：

def empty_generator():
  yield from []

Answer 3

另一种方法是

def empty_generator():
    return
    yield

并不是真的“更具表现力”，而是更短。 :)

请注意，iter([]) 或简单的 [] 也可以。