生成器

利用迭代器，我们可以在每次迭代获取数据（通过next()方法）时按照特定的规律进行生成。但是我们实现一个迭代器时，关于当前迭代到的状态需要我们自己记录，进而次才能根据当前状态生成下一个数据。为了达到记录当前状态，并配合next()函数进行迭代使用，我们可以采用更简便的语法，即生成器（generator）。
生成器是一类特殊的迭代器。

创建一个generator

1. 第一种方法很简单，只要把一个列表生成式的[]改成()，就创建了一个generator：

>>> L = [x * x for x in range(10)]
>>> L
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> g = (x * x for x in range(10))
>>> g
<generator object <genexpr> at 0x1022ef630>

创建L和g的区别仅在于最外层的[]和()，L是一个list，而g是一个generator。

2. 使用yield关键字创建generator

>>> def odd():
...     print('step 1')
...     yield 1
...     print('step 2')
...     yield(3)
...     print('step 3')
...     yield(5)
... 
>>> print(odd())
<generator object odd at 0x10d48e4d0>

如果一个函数定义中包含yield关键字，那么这个函数就不再是一个普通函数，而是一个generator。

打印出generator的每一个元素

1. 使用next()函数
   可以通过next()函数获得generator的下一个返回值：
   对于（方法一）的generator

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

每次调用next(g)，就计算出g的下一个元素的值，直到计算到最后一个元素，没有更多的元素时，抛出StopIteration的错误。

对于（方法二）的generator

⚠️ generator和函数的执行流程不一样。函数是顺序执行，遇到return语句或者最后一行函数语句就返回。而变成generator的函数，在每次调用next()的时候执行，遇到yield语句返回，再次执行时从上次返回的yield语句处继续执行。

调用该generator时，首先要生成一个generator对象，然后用next()函数不断获得下一个返回值：

>>> o = odd()
>>> next(o)
step 1
1
>>> next(o)
step 2
3
>>> next(o)
step 3
5
>>> next(o)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

可以看到，odd不是普通函数，而是generator，在执行过程中，遇到yield就中断，下次又继续执行。执行3次yield后，已经没有yield可以执行了，所以，第4次调用next(o)就报错。

2. 使用for.. in
   因为generator是可迭代对象,所以可以使用for循环，
   对于（方法一）的generator

>>> g = (x * x for x in range(10))
>>> for n in g:
...     print(n)
... 
0
1
4
9
16
25
36
49
64
81

对于（方法二）的generator

>>> o = odd()
>>> for i in o:
...     print(i)
...
1
3
5

注意事项

• 用for循环调用generator时，发现拿不到generator的return语句的返回值。如果想要拿到返回值，必须捕获StopIteration错误，返回值包含在StopIteration的value中：

def odd():
    print('step 1')
    yield 1
    print('step 2')
    yield(3)
    print('step 3')
    yield(5)
    return "done"
o = odd()

while True:
    try:
        x = next(o)
        print('o:', x)
    except StopIteration as e:
        print('Generator return value:', e.value)
        break

# 输出如下：
# step 1
# o: 1
# step 2
# o: 3
# step 3
# o: 5
# Generator return value: done

• 注意区分普通函数和generator函数
  普通函数调用直接返回结果：

>>> r = abs(6)
>>> r
6

generator函数的“调用”实际返回一个generator对象：

>>> o = odd()
>>> o
<generator object odd at 0x1022ef948>

send()方法启动生成器

除了使用next()启动生成器外，还可以使用send()方法启动，并且可以给生成器传递参数，如下：

def func(all_num):
    a,b = 0,1
    current_num = 0
    while current_num < all_num:
        ret = yield a
        print(">>>>ret:",ret)
        a,b = b,a+b
        current_num += 1

obj = func(10)

ret = obj.send(None)
print(ret)
ret = obj.send("hahahaha")
print(ret)
ret = obj.send("hehehehe")
print(ret)
ret = obj.send("heiheihei")
print(ret)

"""
输出如下：
0
>>>>ret: hahahaha
1
>>>>ret: hehehehe
1
>>>>ret: heiheihei
2
"""

⚠️ 使用send()方法启动时，第一个send()方法不能有参数，即只能传递None，或者第一个使用next()启动，之后在使用send()

小结

• generator是一种特殊的迭代器。
• generator是非常强大的工具，在Python中，可以简单地把列表生成式改成generator，也可以通过函数实现复杂逻辑的generator。
• 要理解generator的工作原理，它是在for循环的过程中不断计算出下一个元素，并在适当的条件结束for循环。对于函数改成的generator来说，遇到return语句或者执行到函数体最后一行语句，就是结束generator的指令，for循环随之结束。