从 python 生成器接收“返回”值的最佳方法

Question

从 Python 3.3 开始，如果生成器函数返回一个值，则该值将成为引发的 StopIteration 异常的值。这可以通过多种方式收集：

• yield from 表达式的值，这意味着封闭函数也是一个生成器。
• 将对next() 或.send() 的调用封装在try/except 块中。

但是，如果我只是想在 for 循环中迭代生成器 - 最简单的方法 - 似乎没有办法收集 StopIteration 异常的值，从而收集返回值。我使用了一个简单的示例，其中生成器产生值，并在最后返回某种摘要（运行总计、平均值、时间统计等）。

for i in produce_values():
    do_something(i)

values_summary = ....??

一种方法是自己处理循环：

values_iter = produce_values()
try:
    while True:
        i = next(values_iter)
        do_something(i)
except StopIteration as e:
    values_summary = e.value

但这抛弃了 for 循环的简单性。我不能使用yield from，因为这要求调用代码本身就是一个生成器。有没有比上面显示的roll-ones-own for 循环更简单的方法？

答案总结

结合@Chad S. 和@KT 的答案，最简单的方法似乎是使用迭代器协议将我的生成器函数变成一个类：

class ValueGenerator():
    def __iter__(self):
        yield 1
        yield 2
        # and so on
        self.summary = {...}

vg = ValueGenerator()
for i in vg:
    do_something(i)
values_summary = vg.summary

如果我不能重构价值生产者，@Ferdinand Beyer 的答案是最简单的。

Answer 1

您可以将StopIteration（也可以说是StopIteration 本身）的value 属性视为实现细节，而不是设计用于“普通”代码。

查看指定 Python 3.3 的 yield from 功能的 PEP 380：它讨论了使用 StopIteration 携带返回值的一些替代方案。

由于您不应该在普通的for 循环中获取返回值，因此没有语法。与您不应该明确捕获StopIteration 的方式相同。

对于您的情况，一个不错的解决方案是一个小型实用程序类（可能对标准库足够有用）：

class Generator:
    def __init__(self, gen):
        self.gen = gen

    def __iter__(self):
        self.value = yield from self.gen

这将包装任何生成器并捕获其返回值以供稍后检查：

>>> def test():
...     yield 1
...     return 2
...
>>> gen = Generator(test())
>>> for i in gen:
...    print(i)
...
1
>>> print(gen.value)
2

Answer 2

您可以制作一个辅助包装器，它会捕获 StopIteration 并为您提取值：

from functools import wraps

class ValueKeepingGenerator(object):
    def __init__(self, g):
        self.g = g
        self.value = None
    def __iter__(self):
        self.value = yield from self.g

def keep_value(f):
    @wraps(f)
    def g(*args, **kwargs):
        return ValueKeepingGenerator(f(*args, **kwargs))
    return g

@keep_value
def f():
    yield 1
    yield 2
    return "Hi"

v = f()
for x in v:
    print(x)

print(v.value)

Answer 3

一种处理返回值的轻量级方法（不涉及实例化辅助类）是使用dependency injection。

即，可以使用以下包装器/辅助生成器函数传入处理/作用于返回值的函数：

def handle_return(generator, func):
    returned = yield from generator
    func(returned)

例如下面的——

def generate():
    yield 1
    yield 2
    return 3

def show_return(value):
    print('returned: {}'.format(value))

for x in handle_return(generate(), show_return):
    print(x)

结果——

1
2
returned: 3

Answer 4

对此我能想到的最明显的方法是用户定义的类型，它会为您记住摘要..

>>> import random
>>> class ValueProducer:
...    def produce_values(self, n):
...        self._total = 0
...        for i in range(n):
...           r = random.randrange(n*100)
...           self._total += r
...           yield r
...        self.value_summary = self._total/n
...        return self.value_summary
... 
>>> v = ValueProducer()
>>> for i in v.produce_values(3):
...    print(i)
... 
25
55
179
>>> print(v.value_summary)
86.33333333333333
>>>