Python yield 使用淺析（整理自：廖 雪峰, 軟件工程師, HP 2012 年 11 月 22 日?）

　　初學(xué) Python 的開發(fā)者經(jīng)常會發(fā)現(xiàn)很多 Python 函數(shù)中用到了 yield 關(guān)鍵字，然而，帶有 yield 的函數(shù)執(zhí)行流程卻和普通函數(shù)不一樣，yield 到底用來做什么，為什么要設(shè)計 yield ？本文將由淺入深地講解 yield 的概念和用法，幫助讀者體會 Python 里 yield 簡單而強大的功能。

　　您可能聽說過，帶有 yield 的函數(shù)在 Python 中被稱之為 generator（生成器），何謂 generator ？ 我們先拋開 generator，以一個常見的編程題目來展示 yield 的概念。 如何生成斐波那契數(shù)列 斐波那契（Fibonacci）數(shù)列是一個非常簡單的遞歸數(shù)列，除第一個和第二個數(shù)外，任意一個數(shù)都可由前兩個數(shù)相加得到。用計算機程序輸出斐波那契數(shù)列的前 N 個數(shù)是一個非常簡單的問題，許多初學(xué)者都可以輕易寫出如下函數(shù)：

清單 1. 簡單輸出斐波那契數(shù)列前 N 個數(shù)

1 def fab(max): 2 n, a, b = 0, 0, 1 3 while n < max: 4 print (b) 5 a, b = b, a + b 6 n = n + 1 7 fab(5) 8 9 #輸出如下 10 # 1 11 # 1 12 # 2 13 # 3 14 # 5 15 # [Finished in 0.1s]

　　但有經(jīng)驗的開發(fā)者會指出，直接在 fab 函數(shù)中用 print 打印數(shù)字會導(dǎo)致該函數(shù)可復(fù)用性較差，因為 fab 函數(shù)返回 None，其他函數(shù)無法獲得該函數(shù)生成的數(shù)列。 要提高 fab 函數(shù)的可復(fù)用性，最好不要直接打印出數(shù)列，而是返回一個 List。以下是 fab 函數(shù)改寫后的第二個版本：

清單 2. 輸出斐波那契數(shù)列前 N 個數(shù)第二版

1 def fab(max): 2 n, a, b = 0, 0, 1 3 L = [] 4 while n < max: 5 L.append(b) 6 a, b = b, a + b 7 n = n + 1 8 return L 9 10 for n in fab(5): 11 print (n) 12 13 #輸出如下 14 # 1 15 # 1 16 # 2 17 # 3 18 # 5 19 # [Finished in 0.2s]

　　改寫后的 fab 函數(shù)通過返回 List 能滿足復(fù)用性的要求，但是更有經(jīng)驗的開發(fā)者會指出，該函數(shù)在運行中占用的內(nèi)存會隨著參數(shù) max 的增大而增大，如果要控制內(nèi)存占用，最好不要用 List 來保存中間結(jié)果，而是通過 iterable 對象來迭代。

　　例如，在 Python2.x 中，代碼：

清單 3. 通過 iterable 對象來迭代

　　for i in range(1000): pass

　　會導(dǎo)致生成一個 1000 個元素的 List，

　　而代碼： for i in xrange(1000): pass

　　則不會生成一個 1000 個元素的 List，而是在每次迭代中返回下一個數(shù)值，內(nèi)存空間占用很小。因為 xrange 不返回 List，而是返回一個 iterable 對象。 利用 iterable 我們可以把 fab 函數(shù)改寫為一個支持 iterable 的 class，以下是第三個版本的 Fab：

清單 4. 第三個版本

1 class Fab(object): 2 3 def __init__(self, max): 4 self.max = max 5 self.n, self.a, self.b = 0, 0, 1 6 7 def __iter__(self): 8 return self 9 10 def __next__(self): 11 if self.n < self.max: 12 r = self.b 13 self.a, self.b = self.b, self.a + self.b 14 self.n = self.n + 1 15 return r 16 raise StopIteration() 17 18 for n in Fab(5): 19 print (n) 20 #輸出如下 21 # 1 22 # 1 23 # 2 24 # 3 25 # 5 26 # [Finished in 0.1s]

　　然而，使用 class 改寫的這個版本，代碼遠(yuǎn)遠(yuǎn)沒有第一版的 fab 函數(shù)來得簡潔。如果我們想要保持第一版 fab 函數(shù)的簡潔性，同時又要獲得 iterable 的效果，yield 就派上用場了：

清單 5. 使用 yield 的第四版

?

1 def fab(max): 2 n, a, b = 0, 0, 1 3 while n < max: 4 yield b 5 # print b 6 a, b = b, a + b 7 n = n + 1 8 9 10 for n in fab(5): 11 print (n) 12 13 #輸出如下: 14 # 1 15 # 1 16 # 2 17 # 3 18 # 5 19 # [Finished in 0.2s]

　　第四個版本的 fab 和第一版相比，僅僅把 print b 改為了 yield b，就在保持簡潔性的同時獲得了 iterable 的效果。 調(diào)用第四版的 fab 和第二版的 fab 完全一致： 簡單地講，yield 的作用就是把一個函數(shù)變成一個 generator，帶有 yield 的函數(shù)不再是一個普通函數(shù)，Python 解釋器會將其視為一個 generator，調(diào)用 fab(5) 不會執(zhí)行 fab 函數(shù)，而是返回一個 iterable 對象！在 for 循環(huán)執(zhí)行時，每次循環(huán)都會執(zhí)行 fab 函數(shù)內(nèi)部的代碼，執(zhí)行到 yield b 時，fab 函數(shù)就返回一個迭代值，下次迭代時，代碼從 yield b 的下一條語句繼續(xù)執(zhí)行，而函數(shù)的本地變量看起來和上次中斷執(zhí)行前是完全一樣的，于是函數(shù)繼續(xù)執(zhí)行，直到再次遇到 yield。 也可以手動調(diào)用 fab(5) 的 next() 方法（因為 fab(5) 是一個 generator 對象，該對象具有 next() 方法），這樣我們就可以更清楚地看到 fab 的執(zhí)行流程：

清單 6. 執(zhí)行流程

1 f = fab(5) 2 print (f.__next__()) 3 #1 4 print(f.__next__()) 5 #1 6 print(f.__next__()) 7 #2 8 print(f.__next__()) 9 #3 10 print(f.__next__()) 11 #5 12 print(f.__next__()) 13 # Traceback (most recent call last): 14 # File "<stdin>", line 1, in <module> 15 # StopIteration

　　?當(dāng)函數(shù)執(zhí)行結(jié)束時，generator 自動拋出 StopIteration 異常，表示迭代完成。在 for 循環(huán)里，無需處理 StopIteration 異常，循環(huán)會正常結(jié)束。

　　我們可以得出以下結(jié)論：

　　一個帶有 yield 的函數(shù)就是一個 generator，它和普通函數(shù)不同，生成一個 generator 看起來像函數(shù)調(diào)用，但不會執(zhí)行任何函數(shù)代碼，直到對其調(diào)用 next()（在 for 循環(huán)中會自動調(diào)用 next()）才開始執(zhí)行。雖然執(zhí)行流程仍按函數(shù)的流程執(zhí)行，但每執(zhí)行到一個 yield 語句就會中斷，并返回一個迭代值，下次執(zhí)行時從 yield 的下一個語句繼續(xù)執(zhí)行。看起來就好像一個函數(shù)在正常執(zhí)行的過程中被 yield 中斷了數(shù)次，每次中斷都會通過 yield 返回當(dāng)前的迭代值。

　　yield 的好處是顯而易見的，把一個函數(shù)改寫為一個 generator 就獲得了迭代能力，比起用類的實例保存狀態(tài)來計算下一個 next() 的值，不僅代碼簡潔，而且執(zhí)行流程異常清晰。

　　如何判斷一個函數(shù)是否是一個特殊的 generator 函數(shù)？可以利用 isgeneratorfunction 判斷：

清單 7. 使用 isgeneratorfunction 判斷 　　

1 from inspect import isgeneratorfunction 2 print(isgeneratorfunction(fab)) 3 #True

　　要注意區(qū)分 fab 和 fab(5)，fab 是一個 generator function，而 fab(5) 是調(diào)用 fab 返回的一個 generator，好比類的定義和類的實例的區(qū)別：

清單 8. 類的定義和類的實例

1 import types 2 print(isinstance(fab, types.GeneratorType)) 3 #False 4 print(isinstance(fab(5), types.GeneratorType)) 5 #True

　　fab 是無法迭代的，而 fab(5) 是可迭代的：

1 from collections import Iterable 2 print(isinstance(fab, Iterable)) 3 #False 4 print(isinstance(fab(5), Iterable)) 5 #True

　　每次調(diào)用 fab 函數(shù)都會生成一個新的 generator 實例，各實例互不影響。

return 的作用

　　在一個 generator function 中，如果沒有 return，則默認(rèn)執(zhí)行至函數(shù)完畢，如果在執(zhí)行過程中 return，則直接拋出 StopIteration 終止迭代。

另一個例子

　　另一個 yield 的例子來源于文件讀取。如果直接對文件對象調(diào)用 read() 方法，會導(dǎo)致不可預(yù)測的內(nèi)存占用。好的方法是利用固定長度的緩沖區(qū)來不斷讀取文件內(nèi)容。通過 yield，我們不再需要編寫讀文件的迭代類，就可以輕松實現(xiàn)文件讀取：

清單 9. 另一個 yield 的例子

1 def read_file(fpath): 2 BLOCK_SIZE = 1024 3 with open(fpath, 'rb') as f: 4 while True: 5 block = f.read(BLOCK_SIZE) 6 if block: 7 yield block 8 else: 9 return

　　以上僅僅簡單介紹了 yield 的基本概念和用法，yield 在 Python 3 中還有更強大的用法，我們會在后續(xù)文章中討論。

注：本文的代碼雖然大部分都是Python2.x中的語法，但是我經(jīng)過重構(gòu)在Python3.x中均調(diào)試通過

轉(zhuǎn)載于:https://www.cnblogs.com/AlwaysWIN/p/6202613.html

總結(jié)

以上是生活随笔為你收集整理的Python中的yield生成器的简单介绍的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。