本文將由淺入深詳細介紹yield以及generator，包括以下內容：什麼generator，生成generator的方法，generator的特點，generator基礎及高階應用場景，generator使用中的注意事項。本文不包括enhanced generator即pep342相關內容。
generator基礎
在python的函式（function）定義中，只要出現了yield表示式（Yield expression），那麼事實上定義的是一個generator function， 呼叫這個generator function返回值是一個generator。這根普通的函式呼叫有所區別，For example：
|
1 2 3 4 5 6 7 8 9 10 11 |
def gen_generator(): yield 1 def gen_value(): return 1 if __name__ == '__main__': ret = gen_generator() print ret, type(ret) #<generator object gen_generator at 0x02645648> <type 'generator'> ret = gen_value() print ret, type(ret) # 1 <type 'int'> |
從上面的程式碼可以看出，gen_generator函式返回的是一個generator例項，generator有以下特別：
- 遵循迭代器（iterator）協議，迭代器協議需要實現__iter__、next介面
- 能過多次進入、多次返回，能夠暫停函式體中程式碼的執行
下面看一下測試程式碼：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
>>> def gen_example(): ... print 'before any yield' ... yield 'first yield' ... print 'between yields' ... yield 'second yield' ... print 'no yield anymore' ... >>> gen = gen_example() >>> gen.next() ＃ 第一次呼叫next before any yield 'first yield' >>> gen.next() ＃ 第二次呼叫next between yields 'second yield' >>> gen.next() ＃ 第三次呼叫next no yield anymore Traceback (most recent call last): File "<stdin>", line 1, in <module> StopIteratio |
呼叫gen example方法並沒有輸出任何內容，說明函式體的程式碼尚未開始執行。當呼叫generator的next方法，generator會執行到yield 表示式處，返回yield表示式的內容，然後暫停（掛起）在這個地方，所以第一次呼叫next列印第一句並返回“first yield”。 暫停意味著方法的區域性變數，指標資訊，執行環境都儲存起來，直到下一次呼叫next方法恢復。第二次呼叫next之後就暫停在最後一個yield，再次呼叫next()方法，則會丟擲StopIteration異常。
因為for語句能自動捕獲StopIteration異常，所以generator（本質上是任何iterator）較為常用的方法是在迴圈中使用：
|
1 2 3 4 5 6 7 8 |
def generator_example(): yield 1 yield 2 if __name__ == '__main__': for e in generator_example(): print e # output 1 2 |
generator function產生的generator與普通的function有什麼區別呢？
（1）function每次都是從第一行開始執行，而generator從上一次yield開始的地方執行
（2）function呼叫一次返回一個（一組）值，而generator可以多次返回
（3）function可以被無數次重複呼叫，而一個generator例項在yield最後一個值 或者return之後就不能繼續呼叫了
在函式中使用Yield，然後呼叫該函式是生成generator的一種方式。另一種常見的方式是使用generator expression，For example：
|
1 2 3 |
>>> gen = (x * x for x in xrange(5)) >>> print gen <generator object <genexpr> at 0x02655710> |
generator應用
generator基礎應用
為什麼使用generator呢，最重要的原因是可以按需生成並“返回”結果，而不是一次性產生所有的返回值，況且有時候根本就不知道“所有的返回值”。比如對於下面的程式碼：
|
1 2 3 4 5 6 7 8 |
RANGE_NUM = 100 for i in [x*x for x in range(RANGE_NUM)]: # 第一種方法：對列表進行迭代 # do sth for example print i for i in (x*x for x in range(RANGE_NUM)): # 第二種方法：對generator進行迭代 # do sth for example print i |
在上面的程式碼中，兩個for語句輸出是一樣的，程式碼字面上看來也就是中括號與小括號的區別。但這點區別差異是很大的，第一種方法返回值是一個列表，第二個方法返回的是一個generator物件。隨著RANGE_NUM的變大，第一種方法返回的列表也越大，佔用的記憶體也越大；但是對於第二種方法沒有任何區別。
我們再來看一個可以“返回”無窮多次的例子：
|
1 2 3 4 5 |
def fib(): a, b = 1, 1 while True: yield a a, b = b, a+b |
這個generator擁有生成無數多“返回值”的能力，使用者可以自己決定什麼時候停止迭代。
generator高階應用
使用場景一：
Generator可用於產生資料流， generator並不立刻產生返回值，而是等到被需要的時候才會產生返回值，相當於一個主動拉取的過程(pull)，比如現在有一個日誌檔案，每行產生一條記錄，對於每一條記錄，不同部門的人可能處理方式不同，但是我們可以提供一個公用的、按需生成的資料流。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
def gen_data_from_file(file_name): for line in file(file_name): yield line def gen_words(line): for word in (w for w in line.split() if w.strip()): yield word def count_words(file_name): word_map = {} for line in gen_data_from_file(file_name): for word in gen_words(line): if word not in word_map: word_map[word] = 0 word_map[word] += 1 return word_map def count_total_chars(file_name): total = 0 for line in gen_data_from_file(file_name): total += len(line) return total if __name__ == '__main__': print count_words('test.txt'), count_total_chars('test.txt') |
上面的例子來自08年的PyCon一個講座。gen_words gen_data_from_file是資料生產者，而count_words count_total_chars是資料的消費者。可以看到，資料只有在需要的時候去拉取的，而不是提前準備好。另外gen_words中 (w for w in line.split() if w.strip()) 也是產生了一個generator。
使用場景二：
一些程式設計場景中，一件事情可能需要執行一部分邏輯，然後等待一段時間、或者等待某個非同步的結果、或者等待某個狀態，然後繼續執行另一部分邏輯。比如微服務架構中，服務A執行了一段邏輯之後，去服務B請求一些資料，然後在服務A上繼續執行。或者在遊戲程式設計中，一個技能分成分多段，先執行一部分動作（效果），然後等待一段時間，然後再繼續。對於這種需要等待、而又不希望阻塞的情況，我們一般使用回撥（callback）的方式。下面舉一個簡單的例子：
|
1 2 3 4 5 6 |
def do(a): print 'do', a CallBackMgr.callback(5, lambda a = a: post_do(a)) def post_do(a): print 'post_do', a |
這裡的CallBackMgr註冊了一個5s後的時間，5s之後再呼叫lambda函式，可見一段邏輯被分裂到兩個函式，而且還需要上下文的傳遞（如這裡的引數a）。我們用yield來修改一下這個例子，yield返回值代表等待的時間。
|
1 2 3 4 5 |
@yield_dec def do(a): print 'do', a yield 5 print 'post_do', a |
這裡需要實現一個YieldManager， 通過yield_dec這個decrator將do這個generator註冊到YieldManager，並在5s後呼叫next方法。Yield版本實現了和回撥一樣的功能，但是看起來要清晰許多。下面給出一個簡單的實現以供參考：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# -*- coding:utf-8 -*- import sys # import Timer import types import time class YieldManager(object): def __init__(self, tick_delta = 0.01): self.generator_dict = {} # self._tick_timer = Timer.addRepeatTimer(tick_delta, lambda: self.tick()) def tick(self): cur = time.time() for gene, t in self.generator_dict.items(): if cur >= t: self._do_resume_genetator(gene,cur) def _do_resume_genetator(self,gene, cur ): try: self.on_generator_excute(gene, cur) except StopIteration,e: self.remove_generator(gene) except Exception, e: print 'unexcepet error', type(e) self.remove_generator(gene) def add_generator(self, gen, deadline): self.generator_dict[gen] = deadline def remove_generator(self, gene): del self.generator_dict[gene] def on_generator_excute(self, gen, cur_time = None): t = gen.next() cur_time = cur_time or time.time() self.add_generator(gen, t + cur_time) g_yield_mgr = YieldManager() def yield_dec(func): def _inner_func(*args, **kwargs): gen = func(*args, **kwargs) if type(gen) is types.GeneratorType: g_yield_mgr.on_generator_excute(gen) return gen return _inner_func @yield_dec def do(a): print 'do', a yield 2.5 print 'post_do', a yield 3 print 'post_do again', a if __name__ == '__main__': do(1) for i in range(1, 10): print 'simulate a timer, %s seconds passed' % i time.sleep(1) g_yield_mgr.tick() |
注意事項：
（1）Yield是不能巢狀的！
|
1 2 3 4 5 6 7 8 9 10 |
def visit(data): for elem in data: if isinstance(elem, tuple) or isinstance(elem, list): visit(elem) # here value retuened is generator else: yield elem if __name__ == '__main__': for e in visit([1, 2, (3, 4), 5]): print e |
上面的程式碼訪問巢狀序列裡面的每一個元素，我們期望的輸出是1 2 3 4 5，而實際輸出是1 2 5 。為什麼呢，如註釋所示，visit是一個generator function，所以第4行返回的是generator object，而程式碼也沒這個generator例項迭代。那麼改改程式碼，對這個臨時的generator 進行迭代就行了。
|
1 2 3 4 5 6 7 |
def visit(data): for elem in data: if isinstance(elem, tuple) or isinstance(elem, list): for e in visit(elem): yield e else: yield elem |
或者在python3.3中 可以使用yield from，這個語法是在pep380加入的：
|
1 2 3 4 5 6 |
def visit(data): for elem in data: if isinstance(elem, tuple) or isinstance(elem, list): yield from visit(elem) else: yield elem |
（2）generator function中使用return
在python doc中，明確提到是可以使用return的，當generator執行到這裡的時候丟擲StopIteration異常。
|
1 2 3 4 5 6 7 8 9 10 |
def gen_with_return(range_num): if range_num < 0: return else: for i in xrange(range_num): yield i if __name__ == '__main__': print list(gen_with_return(-1)) print list(gen_with_return(1)) |
但是，generator function中的return是不能帶任何返回值的。
|
1 2 3 4 5 6 |
def gen_with_return(range_num): if range_num < 0: return 0 else: for i in xrange(range_num): yield i |
上面的程式碼會報錯：SyntaxError: ‘return’ with argument inside generator
參考
- http://www.dabeaz.com/generators-uk/
- https://www.python.org/dev/peps/pep-0380/
- http://stackoverflow.com/questions/231767/what-does-the-yield-keyword-do
- http://stackoverflow.com/questions/15809296/python-syntaxerror-return-with-argument-inside-generator