python yield generator 詳解

　　本文將由淺入深詳細介紹yield以及generator，包括如下內容：什麼generator，生成generator的方法，generator的特色，generator基礎及高級應用場景，generator使用中的注意事項。本文不包括enhanced generator即pep342相關內容，這部份內容在以後的博文介紹。

generator基礎

　　在python的函數（function）定義中，只要出現了yield表達式（Yield expression），那麼事實上定義的是一個generator function， 調用這個generator function返回值是一個generator。這根普通的函數調用有所區別，For example：

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接口
• 能過屢次進入、屢次返回，可以暫停函數體中代碼的執行

　　下面看一下測試代碼：

>>> 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 def generator_example():
2     yield 1
3     yield 2
4 
5 if __name__ == '__main__':
6     for e in generator_example():
7         print e
8         # 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：
　　>>> gen = (x * x for x in xrange(5))
　　>>> print gen
　　<generator object <genexpr> at 0x02655710>
　　

generator應用

generator基礎應用　　

　　爲何使用generator呢，最重要的緣由是能夠按需生成並「返回」結果，而不是一次性產生全部的返回值，何況有時候根本就不知道「全部的返回值」。好比對於下面的代碼　　

1     RANGE_NUM = 100
2     for i in [x*x for x in range(RANGE_NUM)]: # 第一種方法：對列表進行迭代
3         # do sth for example
4         print i
5 
6     for i in (x*x for x in range(RANGE_NUM)): # 第二種方法：對generator進行迭代
7         # do sth for example
8         print i

　　在上面的代碼中，兩個for語句輸出是同樣的，代碼字面上看來也就是中括號與小括號的區別。但這點區別差別是很大的，第一種方法返回值是一個列表，第二個方法返回的是一個generator對象。隨着RANGE_NUM的變大，第一種方法返回的列表也越大，佔用的內存也越大；可是對於第二種方法沒有任何區別。

　　咱們再來看一個能夠「返回」無窮屢次的例子：

def fib():
    a, b = 1, 1
    while True:
        yield a
        a, b = b, a+b 

這個generator擁有生成無數多「返回值」的能力，使用者能夠本身決定何時中止迭代

 

generator高級應用

使用場景一：　　

　　Generator可用於產生數據流， generator並不馬上產生返回值，而是等到被須要的時候纔會產生返回值，至關於一個主動拉取的過程(pull)，好比如今有一個日誌文件，每行產生一條記錄，對於每一條記錄，不一樣部門的人可能處理方式不一樣，可是咱們能夠提供一個公用的、按需生成的數據流。

 1 def gen_data_from_file(file_name):
 2     for line in file(file_name):
 3         yield line
 4 
 5 def gen_words(line):
 6     for word in (w for w in line.split() if w.strip()):
 7         yield word
 8 
 9 def count_words(file_name):
10     word_map = {}
11     for line in gen_data_from_file(file_name):
12         for word in gen_words(line):
13             if word not in word_map:
14                 word_map[word] = 0
15             word_map[word] += 1
16     return word_map
17 
18 def count_total_chars(file_name):
19     total = 0
20     for line in gen_data_from_file(file_name):
21         total += len(line)
22     return total
23     
24 if __name__ == '__main__':
25     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 def do(a):
2     print 'do', a
3     CallBackMgr.callback(5, lambda a = a: post_do(a))
4 
5 def post_do(a):
6     print 'post_do', a

　　這裏的CallBackMgr註冊了一個5s後的時間，5s以後再調用lambda函數，可見一段邏輯被分裂到兩個函數，並且還須要上下文的傳遞（如這裏的參數a）。咱們用yield來修改一下這個例子，yield返回值表明等待的時間。

1 @yield_dec
2 def do(a):
3     print 'do', a
4     yield 5
5     print 'post_do', a

　　這裏須要實現一個YieldManager， 經過yield_dec這個decrator將do這個generator註冊到YieldManager，並在5s後調用next方法。Yield版本實現了和回調同樣的功能，可是看起來要清晰許多。下面給出一個簡單的實現以供參考：

 　　

# -*- 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 def visit(data):
 2     for elem in data:
 3         if isinstance(elem, tuple) or isinstance(elem, list):
 4             visit(elem) # here value retuened is generator
 5         else:
 6             yield elem
 7             
 8 if __name__ == '__main__':
 9     for e in visit([1, 2, (3, 4), 5]):
10         print e

　　上面的代碼訪問嵌套序列裏面的每個元素，咱們指望的輸出是1 2 3 4 5，而實際輸出是1  2  5 。爲何呢，如註釋所示，visit是一個generator function，因此第4行返回的是generator object，而代碼也沒這個generator實例迭代。那麼改改代碼，對這個臨時的generator 進行迭代就好了。

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 def visit(data):
2     for elem in data:
3         if isinstance(elem, tuple) or isinstance(elem, list):
4             yield from visit(elem)
5         else:
6             yield elem

 

（2）generator function中使用return

　　在python doc中，明確提到是可使用return的，當generator執行到這裏的時候拋出StopIteration異常。

 1 def gen_with_return(range_num):
 2     if range_num < 0:
 3         return
 4     else:
 5         for i in xrange(range_num):
 6             yield i
 7 
 8 if __name__ == '__main__':
 9     print list(gen_with_return(-1))
10     print list(gen_with_return(1))

　　可是，generator function中的return是不能帶任何返回值的

1 def gen_with_return(range_num):
2     if range_num < 0:
3         return 0
4     else:
5         for i in xrange(range_num):
6             yield i

　　上面的代碼會報錯：SyntaxError: 'return' with argument inside generator

 

References：

http://www.dabeaz.com/generators-uk/https://www.python.org/dev/peps/pep-0380/http://stackoverflow.com/questions/231767/what-does-the-yield-keyword-dohttp://stackoverflow.com/questions/15809296/python-syntaxerror-return-with-argument-inside-generator