Python yield

生成器是python中一個很是酷的特性，python 2.2中引入後在2.3變成了標準的一部分。它可以讓你在許多狀況下以一種優雅而又更低內存消耗的方式簡化無界（無限）序列相關的操做。

生成器是能夠當作iterator使用的特殊函數，它功能的實現依賴於關鍵字yield，下面是它如何運做一個簡單的演示：

>>>def spam():
　　yield"first"
　　yield"second"
　　yield"third"


>>> spam
<function spam at 0x011F32B0>
>>>for x in spam():
print x


first
second
third
>>> gen=spam()
>>> gen
<generator object spam at 0x01220B20>
>>> gen.next()
'first'
>>> gen.next()
'second'
>>> gen.next()
'third'

在函數spam（）內定義了一個生成器，可是對spam（）的調用永遠只能得到一個單獨的生成器對象，而不是執行函數裏面的語句，這個對象（generator object）包含了函數的原始代碼和函數調用的狀態，這狀態包括函數中變量值以及當前的執行點——函數在yield語句處暫停（suspended），返回當前的值並儲存函數的調用狀態，當須要下一個條目（item）時，能夠再次調用next，從函數上次中止的狀態繼續執行，知道下一個yield語句。

生成器和函數的主要區別在於函數 return a value，生成器 yield a value同時標記或記憶 point of the yield 以便於在下次調用時從標記點恢復執行。 yield 使函數轉換成生成器，而生成器反過來又返回迭代器。

有三種方式告訴循環生成器中沒有更多的內容：

1. 執行到函數的末尾（"fall off the end"）
2. 用一個return語句（它可能不會返回任何值）
3. 拋出StopIteration異常

 

 

1. 包含yield的函數

假如你看到某個函數包含了yield，這意味着這個函數已是一個Generator，它的執行會和其餘普通的函數有不少不一樣。好比下面的簡單的函數：

 

def h():
print 'To be brave'
yield 5

h()

 

能夠看到，調用h()以後，print 語句並無執行！這就是yield，那麼，如何讓print 語句執行呢？這就是後面要討論的問題，經過後面的討論和學習，就會明白yield的工做原理了。

2. yield是一個表達式

Python2.5之前，yield是一個語句，但如今2.5中，yield是一個表達式(Expression)，好比：

 

m = yield 5

 

表達式(yield 5)的返回值將賦值給m，因此，認爲 m = 5 是錯誤的。那麼如何獲取(yield 5)的返回值呢？須要用到後面要介紹的send(msg)方法。

3. 透過next()語句看原理

如今，咱們來揭曉yield的工做原理。咱們知道，咱們上面的h()被調用後並無執行，由於它有yield表達式，所以，咱們經過next()語句讓它執行。next()語句將恢復Generator執行，並直到下一個yield表達式處。好比：

 

def h():
print 'Wen Chuan'
yield 5
print 'Fighting!'

c = h()
c.next()

 

c.next()調用後，h()開始執行，直到遇到yield 5，所以輸出結果：

 

Wen Chuan

 

當咱們再次調用c.next()時，會繼續執行，直到找到下一個yield表達式。因爲後面沒有yield了，所以會拋出異常：

 

Wen Chuan
Fighting!
Traceback (most recent call last):
File "/home/evergreen/Codes/yidld.py", line 11, in <module>
c.next()
StopIteration

4. send(msg) 與 next()

瞭解了next()如何讓包含yield的函數執行後，咱們再來看另一個很是重要的函數send(msg)。其實next()和send()在必定意義上做用是類似的，區別是send()能夠傳遞yield表達式的值進去，而next()不能傳遞特定的值，只能傳遞None進去。所以，咱們能夠看作

 

c.next() 和 c.send(None) 做用是同樣的。

 

來看這個例子：

 

def h():
print 'Wen Chuan',
m = yield 5 # Fighting!
print m
d = yield 12
print 'We are together!'

c = h()
c.next() #至關於c.send(None)
c.send('Fighting!') #(yield 5)表達式被賦予了'Fighting!'

 

輸出的結果爲：

 

Wen Chuan Fighting!

 

須要提醒的是，第一次調用時，請使用next()語句或是send(None)，不能使用send發送一個非None的值，不然會出錯的，由於沒有yield語句來接收這個值。

5. send(msg) 與 next()的返回值

send(msg) 和 next()是有返回值的，它們的返回值很特殊，返回的是下一個yield表達式的參數。好比yield 5，則返回 5 。到這裏，是否是明白了一些什麼東西？本文第一個例子中，經過for i in alist 遍歷 Generator，實際上是每次都調用了alist.Next()，而每次alist.Next()的返回值正是yield的參數，即咱們開始認爲被壓進去的東東。咱們再延續上面的例子：

 

def h():
print 'Wen Chuan',
m = yield 5 # Fighting!
print m
d = yield 12
print 'We are together!'

c = h()
m = c.next() #m 獲取了yield 5 的參數值 5
d = c.send('Fighting!') #d 獲取了yield 12 的參數值12
print 'We will never forget the date', m, '.', d

 

輸出結果：

 

Wen Chuan Fighting!

 

We will never forget the date 5 . 12

6. throw() 與 close()中斷 Generator

中斷Generator是一個很是靈活的技巧，能夠經過throw拋出一個GeneratorExit異常來終止Generator。Close()方法做用是同樣的，其實內部它是調用了throw(GeneratorExit)的。咱們看：

 

def close(self):
try:
self.throw(GeneratorExit)
except (GeneratorExit, StopIteration):
pass
else:
raise RuntimeError("generator ignored GeneratorExit")
# Other exceptions are not caught

 

所以，當咱們調用了close()方法後，再調用next()或是send(msg)的話會拋出一個異常：

 

Traceback (most recent call last):
File "/home/evergreen/Codes/yidld.py", line 14, in <module>
d = c.send('Fighting!') #d 獲取了yield 12 的參數值12
StopIteration