python yield用法 (tornado, coroutine)

yield關鍵字用來定義生成器（Generator），其具體功能是能夠當return使用，從函數裏返回一個值，不一樣之處是用yield返回以後，可讓函數從上回yield返回的地點繼續執行。也就是說，yield返回函數，交給調用者一個返回值，而後再「瞬移」回去，讓函數繼續運行， 直到嚇一跳yield語句再返回一個新的值。

使用yield返回後，調用者實際獲得的是一個迭代器對象，迭代器的值就是返回值，而調用該迭代器的next()方法會致使該函數恢復yield語句的執行環境繼續往下跑，直到遇到下一個yield爲止，若是遇不到yield，就會拋出異常表示迭代結束。

看一個例子：

>>> def test_yield():
...     yield 1
...     yield 2
...     yield (1,2)
...
>>> a = test_yield()
>>> a.next()
1
>>> a.next()
2
>>> a.next()
(1, 2)
>>> a.next()
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
StopIteration

 

1. 包含yield的函數

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

1. def h():  
2. print 'To be brave'  
3. yield 5  
4. h() 

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

2. yield是一個表達式

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

1. m = yield 5 

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

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

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

1. def h():  
2. print 'Wen Chuan'  
3. yield 5  
4. print 'Fighting!'  
5. c = h()  
6. c.next()c.next() 

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

1. Wen Chuan 

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

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

4. send(msg) 與 next()

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

1. def h():  
2. print 'Wen Chuan',  
3. m = yield 5 # Fighting!  
4. print m  
5. d = yield 12  
6. print 'We are together!'  
7. c = h()  
8. c.next() #至關於c.send(None)  
9. c.send('Fighting!') #(yield 5)表達式被賦予了'Fighting!'輸出的結果爲：  
10. Wen Chuan Fighting! 

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

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

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

1. def h():  
2. print 'Wen Chuan',  
3. m = yield 5 # Fighting!  
4. print m  
5. d = yield 12  
6. print 'We are together!'  
7. c = h()  
8. m = c.next() #m 獲取了yield 5 的參數值 5  
9. d = c.send('Fighting!') #d 獲取了yield 12 的參數值12  
10. print 'We will never forget the date', m, '.', d輸出結果：  
11. Wen Chuan Fighting!  
12. We will never forget the date 5 . 12 

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

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

1. def close(self):  
2. try:  
3. self.throw(GeneratorExit)  
4. except (GeneratorExit, StopIteration):  
5. pass  
6. else:  
7. raise RuntimeError("generator ignored GeneratorExit")  
8. # Other exceptions are not caught 

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

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