從yield 到yield from再到python協程
從yield 到yield from再到python協程
yield 關鍵字
def fib(): a, b = 0, 1 while 1: yield b a, b = b, a+b
yield 是在:PEP 255 -- Simple Generators 這個pep引入的
yield 只能在函式內部使用,包含yield語句的函式稱為生成器函式
當呼叫生成器函式時,並不會執行函式體中的程式碼,而是返回一個生成器物件
每次呼叫生成器物件的next()方法時,才會執行生成器函式中的程式碼,直到遇到yield 或者return 語句。
如果遇到yield 語句, 怎會掛起函式的執行狀態,並將yield 右邊的表示式的值返回給next()的呼叫者, 掛起的時候會儲存所有本地狀態,包括區域性變數,指令指標和內部堆疊資訊,這樣當下次再次呼叫next()時, 看起來yield 部分就像是呼叫了一個外部呼叫一樣,可以接著往下執行
注意:try/ finnally 結構中的try子句中不允許使用yield語句, 問題是因為無法保證生成器被恢復,因此無法保證finally塊將被執行
yield from 關鍵字
yield from關鍵字是在:PEP 380 -- Syntax for Delegating to a Subgenerator 中提出的
用於生成器將其部分操作委託給另外一個生成器,這允許將包含yield的一段程式碼分解出來並放在另外一個生成器中,此外,允許子生成器返回一個值,這個值可供委派生成器使用
上述描述聽起來可能還是不是特別清楚,我們先看一下語法:
yield from <expr>
yield from expr 表示式中,做的第一件事就是呼叫iter(expr) 從中獲取迭代器,因此expr可以是任何可迭代的物件
通過下面的下例子把yield 和yield from 做對比
from collections import namedtuple Result = namedtuple("Result", "count average") li = [40.9, 38.5, 44.3, 42.2, 45.2, 41.7, 44.5, 38.0, 40.6, 44.5] # 子生成器 def averager(): total = 0.0 count = 0 average = None while True: term = yield if term is None: break total += term count += 1 average = total/count return Result(count, average) # 委派生成器 def grouper(result, key): while True: result[key] = yield from averager() # 呼叫方 def main(): results = {} group = grouper(results, "kg") next(group) for value in li: group.send(value) group.send(None) if __name__ == "__main__": main()
yield from的主要功能是開啟雙向通道,把最外層的呼叫方與最內層的子生成器連線起來,這樣二者可以直接傳送和產出值,還可以直接傳入異常
yield from 的六個重要意義
關於yield from 六點重要的說明:
- 子生成器產出的值都直接傳給委派生成器的呼叫方(即客戶端程式碼)
- 使用send()方法傳送給委派生成器的值都直接傳給子生成器。如果傳送的值為None,那麼會給委派呼叫子生成器的__next__()方法。如果傳送的值不是None,那麼會呼叫子生成器的send方法,如果呼叫的方法丟擲StopIteration異常,那麼委派生成器恢復執行,任何其他異常都會向上冒泡,傳給委派生成器
- 生成器退出時,生成器(或子生成器)中的return expr表示式會出發StopIteration(expr)異常丟擲
- yield from表示式的值是子生成器終止時傳給StopIteration異常的第一個引數。yield from 結構的另外兩個特性與異常和終止有關。
- 傳入委派生成器的異常,除了GeneratorExit之外都傳給子生成器的throw()方法。如果呼叫throw()方法時丟擲StopIteration異常,委派生成器恢復執行。StopIteration之外的異常會向上冒泡,傳給委派生成器
- 如果把GeneratorExit異常傳入委派生成器,或者在委派生成器上呼叫close()方法,那麼在子生成器上呼叫clsoe()方法,如果它有的話。如果呼叫close()方法導致異常丟擲,那麼異常會向上冒泡,傳給委派生成器,否則委派生成器丟擲GeneratorExit異常
python協程
Python的生成器函式和python的協程非常接近 ,但並不完全 - 因為生成器然允許暫停執行以生成值,但是不提供在執行恢復時傳遞的值或異常。
並且生成器不允許在try / finally塊的try部分中暫停執行,因此使中止的協程很難在其自身之後進行清理。
- 將yield重新定義為表示式,而不是語句。當前的yield語句將成為一個yield值表示式,其值將被丟棄。每當通過正常的next()呼叫恢復生成器時,yield表示式的值為None
- 為generator-iterators 添加了一個新的方法send(), 它可以恢復生成器併發送給生成一個值,該值稱為yield - expression的結果,send()方法返回生成器產生的下一個值,如果生成器退出而不產生另一個值,則引發StopIteration。
- 為generator-iterators 添加了一個新的方法throw(), 它在生成器暫停時引發異常,並返回生成器產生的下一個值,如果生成器退出而不產生另一個值,則引發StopIteration(如果生成器沒有捕獲傳入的異常,或者引發另外的一個異常,那麼該異常會傳播給呼叫者)
- 為generator-iterators 添加了一個新的方法close(), 在生成器暫停的位置引發一個GeneratorExit 異常,如果一個生成器引發了StopIteration 異常或者GeneratorExit 異常, close()方法將返回給它的呼叫者,如果生成是yield 一個值,會引發RuntimeError 異常。如果一個生成器引發了任何其他異常,則會傳給他的呼叫者 ,如果生成器,由於異常退出或者已經正常退出,那麼close()不執行任何操作。
- 確保了當生成器被垃圾回收的時候執行close()
- 因為垃圾回收或者clsoe被呼叫將允許允許yield在try / finally塊中使用。
send方法
send方法只有一個引數,就是傳送值到生成器,呼叫send(None)相當於呼叫生成器的next()方法
因為我們開始執行生成器函式的時候,並沒有實際執行生成器函式中的程式碼而是返回一個生成器物件,所以我們需要呼叫next()或者send(None)來啟用協程
與next()方法一樣,send()方法返回generator-iterator產生的下一個值,如果生成器正常退出或已經退出,則引發StopIteration。如果生成器引發未捕獲的異常,它將傳播到send()的呼叫者
throw方法
讓生成器在被掛起的位置丟擲指定的異常,如果生成器捕獲了異常並且返回的另外一個值,那麼這個值就是g.throw()返回的值
如果生成器沒有捕獲異常,那麼throw()將會引發傳遞相同的異常,如果生成器引發了另外一個異常,throw呼叫將引發異常,總之throw()的行為類似next()或者send()
除了它在掛起的時候引發異常。如果生成器已經處於關閉狀態,throw() 只會引發它傳遞的異常,而不執行任何生成器的程式碼
generator.throw:會讓生成器在暫停的yield表示式處丟擲指定的異常,如果生成器處理了丟擲的異常,程式碼會向前執行到下一個yield表示式,而產出的值會成為呼叫generator.throw方法程式碼的返回值。如果生成器沒有處理丟擲的異常,異常會向上冒泡,傳到呼叫方的上下文中。
generator.close:會讓生成器在暫停的yield表示式處丟擲GeneratorExit異常。如果生成器沒有處理這個異常,或者丟擲了StopIteration異常,呼叫方不會報錯,如果收到GeneratorExit異常,生成器一定不能產出值,否則直譯器會丟擲RuntimeError異常。生成器丟擲的異常會向上冒泡,傳給呼叫方。
早期的python協程,語法上協程和生成器看起來也非常類似,也是通過yield關鍵字如:num = yield
def simple_coroutine(): print("coroutine start") x = yield print("coroutine receive [%s]" %x) coroutine = simple_coroutine() print(coroutine) next(coroutine) coroutine.send(888)
上面的例子中yield 的右邊沒有表示式,所以預設產出的值為None,通過之前將yield 關鍵字的時候我們已經知道當我們執行函式的時候
並不會執行生成器函式中的程式碼,而是返回一個生成器物件,所以我們需要通過呼叫next(...)來啟用協程,這個時候開始執行生成器函式,
當執行到x = yield的時候,yield的右邊如果有表示式,則會先進行右邊表示式的計算,然後再進行賦值,所以當上面函式執行next()之後,
程式會停在yield那裡,當我們呼叫send方法後yield會收到這個值並賦值給x,而當程式執行到協程定義體的末尾時和用生成器的時候一樣會丟擲StopIteration異常
如果協程沒有通過next(...)啟用(同樣我們可以通過send(None)的方式啟用),但是我們直接send,則會出錯
關於呼叫next(...)函式這一步通常稱為”預激(prime)“協程,即讓協程向前執行到第一個yield表示式,準備好作為活躍的協程使用
協程在執行過程中有四個狀態:
- GEN_CREATE:等待開始執行
- GEN_RUNNING:直譯器正在執行,這個狀態一般看不到
- GEN_SUSPENDED:在yield表示式處暫停
- GEN_CLOSED:執行結束
所有的努力都值得期許,每一份夢想都應該灌溉!