python yield用法

1 yield关键字
yield在函数中的功能类似于return，不同的是yield每次返回结果之后函数并没有退出，而是每次遇到yield关键字后返回相应结果，并保留函数当前的运行状态，等待下一次的调用。如果一个函数需要多次循环执行一个动作，并且每次执行的结果都是需要的，这种场景很适合使用yield实现。

包含yield的函数成为一个生成器，生成器同时也是一个迭代器，支持通过next方法获取下一个值。

使用yield的好处是通过使用生成器，避免占用内存，提高运行效率。

2 代码示例
示例代码块如下：

def foo():
    print("---start----")
    while True:
        result = yield 4
        print("result:", result)


if __name__ == "__main__":
    test = foo()
    print("next(test)", next(test))
    print("*" * 20)
    print(next(test))

在这里插入图片描述

代码分析：

（1）针对test = foo()，由于函数foo中存在yield关键字，所以函数foo内的代码一开始并不执行，而是得到一个生成器test（相当于一个对象）。

（2）针对print(next(test))。由于调用了next方法，foo函数开始执行。先输出starting…，然后进入while循环。在循环内，遇到yield关键字。这里可以把yield想象成return。因此，foo函数返回4，并通过print函数输出。注意：这里并没有执行result的赋值操作。

（3）针对print(“*”*20)。程序输出20个星号。

（4）针对print(next(test))。这句代码是接着步骤（2）结束的地方开始执行，执行的是result的赋值操作。注意：由于在步骤（2）的时候，4已经return出去，并没有完成赋值操作。因此，现在给result赋的值是None。所以输出的结果是result: None。程序接着在While内继续执行，又一次碰到yield关键字，同样返回4，并通过print函数输出。

总结一下，带yield的函数是一个生成器，而不再是一般意义上的一个函数了，这个生成器有一个方法就是next方法，next就相当于“下一步”生成哪个数，这一次的next开始的地方是接着上一次的next停止的地方执行的，所以第二次调用next的时候，生成器并不会从foo函数最开始的地方执行，而是接着上一步停止的地方开始，然后遇到yield后，return出要生成的数，此步就结束。

3 两点补充
（1）除了next方法，yield得到的生成器还支持send方法。该方法可以向生成器传递参数。

代码块示例如下：

def food():
    print("---start----")
    while True:
        result = yield 4
        print("result:", result)


if __name__ == "__main__":
    test = food()
    print("next(test)", next(test))
    print("*" * 20)
    print(test.send(7))

在这里插入图片描述

针对最后一条语句print(test.send(7))，send函数开始执行的时候，接着上一回next方法结束的地方，先完成赋值操作，将7赋值给变量result。然后执行next方法的功能。先输出结果result: 7。然后在While内继续执行，又一次碰到yield关键字，同样返回4，并通过print函数输出。

  （2）对于yield得到的生成器，当调用方法next时，将获取生成器yield后边表达式的值；当执行完最后一次循环后，结束yield语句；此时，如果继续调用next方法，生成器会抛出StopIteration异常。

代码块示例如下：

def func():
    for i in range(0, 2):
        yield i


if __name__ == "__main__":
    f = func()
    print(next(f))
    print(next(f))
    print(next(f))