帶有 yield 的函數(shù)在 Python 中被稱之為 generator(生成器),何謂 generator ?
我們先拋開 generator,以一個(gè)常見的編程題目來展示 yield 的概念。
1 如何生成斐波那契數(shù)列
斐波那契(Fibonacci)數(shù)列是一個(gè)非常簡單的遞歸數(shù)列,除第一個(gè)和第二個(gè)數(shù)外,任意一個(gè)數(shù)都可由前兩個(gè)數(shù)相加得到。用計(jì)算機(jī)程序輸出斐波那契數(shù)列的前 N 個(gè)數(shù)是一個(gè)非常簡單的問題,許多初學(xué)者都可以輕易寫出如下函數(shù):
def fab(max):
n, a, b = 0, 0, 1
while n < max:
print b
a, b = b, a + b
n = n + 1
執(zhí)行 fab(5),我們可以得到如下輸出:
>>> fab(5)
1
1
2
3
5
結(jié)果沒有問題,但有經(jīng)驗(yàn)的開發(fā)者會指出,直接在 fab 函數(shù)中用 print 打印數(shù)字會導(dǎo)致該函數(shù)可復(fù)用性較差,因?yàn)?fab 函數(shù)返回 None,其他函數(shù)無法獲得該函數(shù)生成的數(shù)列。
清單 2. 輸出斐波那契數(shù)列前 N 個(gè)數(shù)第二版
def fab(max):
n, a, b = 0, 0, 1
L = []
while n < max:
L.append(b)
a, b = b, a + b
n = n + 1
return L
可以使用如下方式打印出 fab 函數(shù)返回的 List:
>>> for n in fab(5):
... print n
...
1
1
2
3
5
改寫后的 fab 函數(shù)通過返回 List 能滿足復(fù)用性的要求,但是更有經(jīng)驗(yàn)的開發(fā)者會指出,該函數(shù)在運(yùn)行中占用的內(nèi)存會隨著參數(shù) max 的增大而增大,如果要控制內(nèi)存占用,最好不要用 List
來保存中間結(jié)果,而是通過 iterable 對象來迭代。例如,在 Python2.x 中,代碼:
清單 3. 通過 iterable 對象來迭代:
for i in range(1000): pass
會導(dǎo)致生成一個(gè) 1000 個(gè)元素的 List,而代碼:
for i in xrange(1000): pass
則不會生成一個(gè) 1000 個(gè)元素的 List,而是在每次迭代中返回下一個(gè)數(shù)值,內(nèi)存空間占用很小。因?yàn)?xrange 不返回 List,而是返回一個(gè) iterable 對象。
利用 iterable 我們可以把 fab 函數(shù)改寫為一個(gè)支持 iterable 的 class,以下是第三個(gè)版本的 Fab:
清單 4. 第三個(gè)版本
class Fab(object):
def __init__(self, max):
self.max = max
self.n, self.a, self.b = 0, 0, 1
def __iter__(self):
return self
def next(self):
if self.n < self.max:
r = self.b
self.a, self.b = self.b, self.a + self.b
self.n = self.n + 1
return r
raise StopIteration()
Fab 類通過 next() 不斷返回?cái)?shù)列的下一個(gè)數(shù),內(nèi)存占用始終為常數(shù):
>>> for n in Fab(5):
... print n
...
1
1
2
3
5
然而,使用 class 改寫的這個(gè)版本,代碼遠(yuǎn)遠(yuǎn)沒有第一版的 fab 函數(shù)來得簡潔。如果我們想要保持第一版 fab 函數(shù)的簡潔性,同時(shí)又要獲得 iterable 的效果,yield 就派上用場了:
清單 5. 使用 yield 的第四版
def fab(max):
n, a, b = 0, 0, 1
while n < max:
yield b
# print b
a, b = b, a + b
n = n + 1
第四個(gè)版本的 fab 和第一版相比,僅僅把 print b 改為了 yield b,就在保持簡潔性的同時(shí)獲得了 iterable 的效果。
調(diào)用第四版的 fab 和第二版的 fab 完全一致:
>>> for n in fab(5):
... print n
...
1
1
2
3
5
簡單地講,yield 的作用就是把一個(gè)函數(shù)變成一個(gè) generator,帶有 yield 的函數(shù)不再是一個(gè)普通函數(shù),Python 解釋器會將其視為一個(gè) generator,調(diào)用 fab(5) 不會執(zhí)行 fab 函數(shù),而是返回一個(gè) iterable 對象!在 for 循環(huán)執(zhí)行時(shí),每次循環(huán)都會執(zhí)行 fab 函數(shù)內(nèi)部的代碼,執(zhí)行到 yield b 時(shí),fab 函數(shù)就返回一個(gè)迭代值,下次迭代時(shí),代碼從 yield b 的下一條語句繼續(xù)執(zhí)行,而函數(shù)的本地變量看起來和上次中斷執(zhí)行前是完全一樣的,于是函數(shù)繼續(xù)執(zhí)行,直到再次遇到 yield。
也可以手動(dòng)調(diào)用 fab(5) 的 next() 方法(因?yàn)?fab(5) 是一個(gè) generator 對象,該對象具有 next() 方法),這樣我們就可以更清楚地看到 fab 的執(zhí)行流程:
>>> f = fab(5)
>>> f.next()
1
>>> f.next()
1
>>> f.next()
2
>>> f.next()
3
>>> f.next()
5
>>> f.next()
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
StopIteration
當(dāng)函數(shù)執(zhí)行結(jié)束時(shí),generator 自動(dòng)拋出 StopIteration 異常,表示迭代完成。在 for 循環(huán)里,無需處理 StopIteration 異常,循環(huán)會正常結(jié)束。
我們可以得出以下結(jié)論:
一個(gè)帶有 yield 的函數(shù)就是一個(gè) generator,它和普通函數(shù)不同,生成一個(gè) generator 看起來像函數(shù)調(diào)用,但不會執(zhí)行任何函數(shù)代碼,直到對其調(diào)用 next()(在 for 循環(huán)中會自動(dòng)調(diào)用 next())才開始執(zhí)行。雖然執(zhí)行流程仍按函數(shù)的流程執(zhí)行,但每執(zhí)行到一個(gè) yield 語句就會中斷,并返回一個(gè)迭代值,下次執(zhí)行時(shí)從 yield 的下一個(gè)語句繼續(xù)執(zhí)行。看起來就好像一個(gè)函數(shù)在正常執(zhí)行的過程中被 yield 中斷了數(shù)次,每次中斷都會通過 yield 返回當(dāng)前的迭代值。
yield 的好處是顯而易見的,把一個(gè)函數(shù)改寫為一個(gè) generator 就獲得了迭代能力,比起用類的實(shí)例保存狀態(tài)來計(jì)算下一個(gè) next() 的值,不僅代碼簡潔,而且執(zhí)行流程異常清晰。
return 的作用
在一個(gè) generator function 中,如果沒有 return,則默認(rèn)執(zhí)行至函數(shù)完畢,如果在執(zhí)行過程中 return,則直接拋出 StopIteration 終止迭代。
另一個(gè)例子
另一個(gè) yield 的例子來源于文件讀取。如果直接對文件對象調(diào)用 read() 方法,會導(dǎo)致不可預(yù)測的內(nèi)存占用。好的方法是利用固定長度的緩沖區(qū)來不斷讀取文件內(nèi)容。通過 yield,我們不再需要編寫讀文件的迭代類,就可以輕松實(shí)現(xiàn)文件讀取:
清單 9. 另一個(gè) yield 的例子
def read_file(fpath):
BLOCK_SIZE = 1024
with open(fpath, 'rb') as f:
while True:
block = f.read(BLOCK_SIZE)
if block:
yield block
else:
return