如何编写永不产生任何结果的 Python 生成器函数

Question

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

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

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

Answer 1

一个更短的解决方案：

def empty_generator():
  yield from []

Answer 2

另一种方式

def empty_generator():
    return
    yield

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

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

Answer 3

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

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 的人来说，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