深刻理解Python中的生成器

時間 2019-11-19

原文原文鏈接

生成器(generator)概念

生成器不會把結果保存在一個系列中，而是保存生成器的狀態，在每次進行迭代時返回一個值，直到遇到StopIteration異常結束。html

生成器語法

生成器表達式：通列表解析語法，只不過把列表解析的[]換成()
生成器表達式能作的事情列表解析基本都能處理，只不過在須要處理的序列比較大時，列表解析比較費內存。

>>> gen = (x**2 for x in range(5))
>>> gen
<generator object <genexpr> at 0x0000000002FB7B40>
>>> for g in gen:
...   print(g, end='-')
...
0-1-4-9-16-
>>> for x in [0,1,2,3,4,5]:
...   print(x, end='-')
...
0-1-2-3-4-5-

生成器函數：在函數中若是出現了yield關鍵字，那麼該函數就再也不是普通函數，而是生成器函數。
可是生成器函數能夠生產一個無線的序列，這樣列表根本沒有辦法進行處理。
yield 的做用就是把一個函數變成一個 generator，帶有 yield 的函數再也不是一個普通函數，Python 解釋器會將其視爲一個 generator。

下面爲一個能夠無窮生產奇數的生成器函數。python

def odd():
    n=1
    while True:
        yield n
        n+=2
odd_num = odd()
count = 0
for o in odd_num:
    if count >=5: break
    print(o)
    count +=1

固然經過手動編寫迭代器能夠實現相似的效果，只不過生成器更加直觀易懂ide

class Iter:
    def __init__(self):
        self.start=-1
    def __iter__(self):
        return self
    def __next__(self):
        self.start +=2 
        return self.start
I = Iter()
for count in range(5):
    print(next(I))

題外話：生成器是包含有__iter__()和__next__()方法的，因此能夠直接使用for來迭代，而沒有包含StopIteration的自編Iter來只能經過手動循環來迭代。函數

>>> from collections import Iterable
>>> from collections import Iterator
>>> isinstance(odd_num, Iterable)
True
>>> isinstance(odd_num, Iterator)
True
>>> iter(odd_num) is odd_num
True
>>> help(odd_num)
Help on generator object:

odd = class generator(object)
 |  Methods defined here:
 |
 |  __iter__(self, /)
 |      Implement iter(self).
 |
 |  __next__(self, /)
 |      Implement next(self).
 ......

看到上面的結果，如今你能夠頗有信心的按照Iterator的方式進行循環了吧！code

在 for 循環執行時，每次循環都會執行 fab 函數內部的代碼，執行到 yield b 時，fab 函數就返回一個迭代值，下次迭代時，代碼從 yield b 的下一條語句繼續執行，而函數的本地變量看起來和上次中斷執行前是徹底同樣的，因而函數繼續執行，直到再次遇到 yield。看起來就好像一個函數在正常執行的過程當中被 yield 中斷了數次，每次中斷都會經過 yield 返回當前的迭代值。orm

yield 與 return

在一個生成器中，若是沒有return，則默認執行到函數完畢時返回StopIteration；

>>> def g1():
...     yield 1
...
>>> g=g1()
>>> next(g)    #第一次調用next(g)時，會在執行完yield語句後掛起，因此此時程序並無執行結束。
1
>>> next(g)    #程序試圖從yield語句的下一條語句開始執行，發現已經到告終尾，因此拋出StopIteration異常。
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration
>>>

若是遇到return,若是在執行過程當中 return，則直接拋出 StopIteration 終止迭代。

>>> def g2():
...     yield 'a'
...     return
...     yield 'b'
...
>>> g=g2()
>>> next(g)    #程序停留在執行完yield 'a'語句後的位置。
'a'
>>> next(g)    #程序發現下一條語句是return，因此拋出StopIteration異常，這樣yield 'b'語句永遠也不會執行。
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

若是在return後返回一個值，那麼這個值爲StopIteration異常的說明，不是程序的返回值。

生成器沒有辦法使用return來返回值。協程

>>> def g3():
...     yield 'hello'
...     return 'world'
...
>>> g=g3()
>>> next(g)
'hello'
>>> next(g)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration: world

生成器支持的方法

>>> help(odd_num)
Help on generator object:

odd = class generator(object)
 |  Methods defined here:
 ......
 |  close(...)
 |      close() -> raise GeneratorExit inside generator.
 |
 |  send(...)
 |      send(arg) -> send 'arg' into generator,
 |      return next yielded value or raise StopIteration.
 |
 |  throw(...)
 |      throw(typ[,val[,tb]]) -> raise exception in generator,
 |      return next yielded value or raise StopIteration.
 ......

close()

手動關閉生成器函數，後面的調用會直接返回StopIteration異常。htm

>>> def g4():
...     yield 1
...     yield 2
...     yield 3
...
>>> g=g4()
>>> next(g)
1
>>> g.close()
>>> next(g)    #關閉後，yield 2和yield 3語句將再也不起做用
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

send()

生成器函數最大的特色是能夠接受外部傳入的一個變量，並根據變量內容計算結果後返回。
這是生成器函數最難理解的地方，也是最重要的地方，實現後面我會講到的協程就全靠它了。blog

def gen():
    value=0
    while True:
        receive=yield value
        if receive=='e':
            break
        value = 'got: %s' % receive

g=gen()
print(g.send(None))     
print(g.send('aaa'))
print(g.send(3))
print(g.send('e'))

執行流程：內存

經過g.send(None)或者next(g)能夠啓動生成器函數，並執行到第一個yield語句結束的位置。
此時，執行完了yield語句，可是沒有給receive賦值。
yield value會輸出初始值0
注意：在啓動生成器函數時只能send(None),若是試圖輸入其它的值都會獲得錯誤提示信息。
經過g.send('aaa')，會傳入aaa，並賦值給receive，而後計算出value的值，並回到while頭部，執行yield value語句有中止。
此時yield value會輸出"got: aaa"，而後掛起。
經過g.send(3)，會重複第2步，最後輸出結果爲"got: 3"
當咱們g.send('e')時，程序會執行break而後推出循環，最後整個函數執行完畢，因此會獲得StopIteration異常。
最後的執行結果以下：

0
got: aaa
got: 3
Traceback (most recent call last):
File "h.py", line 14, in <module>
  print(g.send('e'))
StopIteration

throw()

用來向生成器函數送入一個異常，能夠結束系統定義的異常，或者自定義的異常。
throw()後直接跑出異常並結束程序，或者消耗掉一個yield，或者在沒有下一個yield的時候直接進行到程序的結尾。

def gen():
    while True: 
        try:
            yield 'normal value'
            yield 'normal value 2'
            print('here')
        except ValueError:
            print('we got ValueError here')
        except TypeError:
            break

g=gen()
print(next(g))
print(g.throw(ValueError))
print(next(g))
print(g.throw(TypeError))

輸出結果爲：

normal value
we got ValueError here
normal value
normal value 2
Traceback (most recent call last):
  File "h.py", line 15, in <module>
    print(g.throw(TypeError))
StopIteration

解釋：

print(next(g))：會輸出normal value，並停留在yield 'normal value 2'以前。
因爲執行了g.throw(ValueError)，因此會跳過全部後續的try語句，也就是說yield 'normal value 2'不會被執行，而後進入到except語句，打印出we got ValueError here。
而後再次進入到while語句部分，消耗一個yield，因此會輸出normal value。
print(next(g))，會執行yield 'normal value 2'語句，並停留在執行完該語句後的位置。
g.throw(TypeError)：會跳出try語句，從而print('here')不會被執行，而後執行break語句，跳出while循環，而後到達程序結尾，因此跑出StopIteration異常。

下面給出一個綜合例子，用來把一個多維列表展開，或者說扁平化多維列表)

def flatten(nested):
    
    try:
        #若是是字符串，那麼手動拋出TypeError。
        if isinstance(nested, str):
            raise TypeError
        for sublist in nested:
            #yield flatten(sublist)
            for element in flatten(sublist):
                #yield element
                print('got:', element)
    except TypeError:
        #print('here')
        yield nested
        
L=['aaadf',[1,2,3],2,4,[5,[6,[8,[9]],'ddf'],7]]
for num in flatten(L):
    print(num)

若是理解起來有點困難，那麼把print語句的註釋打開在進行查看就比較明瞭了。

yield from

yield產生的函數就是一個迭代器，因此咱們一般會把它放在循環語句中進行輸出結果。
有時候咱們須要把這個yield產生的迭代器放在另外一個生成器函數中，也就是生成器嵌套。
好比下面的例子：

def inner():
    for i in range(10):
        yield i
def outer():
    g_inner=inner()    #這是一個生成器
    while True:
        res = g_inner.send(None)
        yield res

g_outer=outer()
while True:
    try:
        print(g_outer.send(None))
    except StopIteration:
        break

此時，咱們能夠採用yield from語句來減小我麼你的工做量。

def outer2():
    yield from inner()

固然，yield from語句的重點是幫咱們自動處理內外層之間的異常問題，這裏有2篇寫的很好的文章，因此我就再也不囉嗦了。
http://blog.theerrorlog.com/yield-from-in-python-3.html
http://stackoverflow.com/questions/9708902/in-practice-what-are-the-main-uses-for-the-new-yield-from-syntax-in-python-3

總結

按照鴨子模型理論，生成器就是一種迭代器，可使用for進行迭代。
第一次執行next(generator)時，會執行完yield語句後程序進行掛起，全部的參數和狀態會進行保存。
再一次執行next(generator)時，會從掛起的狀態開始日後執行。
在遇到程序的結尾或者遇到StopIteration時，循環結束。
能夠經過generator.send(arg)來傳入參數，這是協程模型。
能夠經過generator.throw(exception)來傳入一個異常。throw語句會消耗掉一個yield。
能夠經過generator.close()來手動關閉生成器。
next()等價於send(None)

說明：