深入理解Python的yield from語法

Python程式設計時光發表於2018-07-03


作者:MING
個人公眾號:Python程式設計時光
個人微信:mrbensonwon

大家好,併發程式設計 進入第八篇。

:本系列已在微信公眾號更新完成。檢視最新文章,請關注公眾號獲取。


直到上一篇,我們終於迎來了Python併發程式設計中,最高階、最重要、當然也是最難的知識點之一(協程)。

當你看到這一篇的時候,請確保你對生成器的知識,有一定的瞭解。當然不瞭解,也沒有關係,你只要花個幾分鐘的時間,來看下我上一篇文章,就能夠讓你認識生成器,入門協程了。

再次提醒
本系列所有的程式碼均在Python3下編寫,也建議大家儘快投入到Python3的懷抱中來。


為什麼要使用協程

在上一篇中,我們從生成器的基本認識與使用,成功過渡到了協程。

但一定有許多人,只知道協程是個什麼東西,但並不知道為什麼要用協程?換句話來說,並不知道在什麼情況下用協程?
它相比多執行緒來說,有哪些過人之處呢?

在開始講yield from 之前,我想先解決一下這個給很多人帶來困惑的問題。

舉個例子。
假如我們做一個爬蟲。我們要爬取多個網頁,這裡簡單舉例兩個網頁(兩個spider函式),獲取HTML(耗IO耗時),然後再對HTML對行解析取得我們感興趣的資料。

我們的程式碼結構精簡如下:

def spider_01(url):
    html = get_html(url)
    ...
    data = parse_html(html)

def spider_02(url):
    html = get_html(url)
    ...
    data = parse_html(html)
複製程式碼

我們都知道,get_html()等待返回網頁是非常耗IO的,一個網頁還好,如果我們爬取的網頁資料極其龐大,這個等待時間就非常驚人,是極大的浪費。

聰明的程式設計師,當然會想如果能在get_html()這裡暫停一下,不用傻乎乎地去等待網頁返回,而是去做別的事。等過段時間再回過頭來到剛剛暫停的地方,接收返回的html內容,然後還可以接下去解析parse_html(html)

利用常規的方法,幾乎是沒辦法實現如上我們想要的效果的。所以Python想得很周到,從語言本身給我們實現了這樣的功能,這就是yield語法。可以實現在某一函式中暫停的效果。

試著思考一下,假如沒有協程,我們要寫一個併發程式。可能有以下問題

1)使用最常規的同步程式設計要實現非同步併發效果並不理想,或者難度極高。
2)由於GIL鎖的存在,多執行緒的執行需要頻繁的加鎖解鎖,切換執行緒,這極大地降低了併發效能;

而協程的出現,剛好可以解決以上的問題。它的特點有

  1. 協程是在單執行緒裡實現任務的切換的
  2. 利用同步的方式去實現非同步
  3. 不再需要鎖,提高了併發效能


yield from的用法詳解

yield from 是在Python3.3才出現的語法。所以這個特性在Python2中是沒有的。

yield from 後面需要加的是可迭代物件,它可以是普通的可迭代物件,也可以是迭代器,甚至是生成器。

. 簡單應用:拼接可迭代物件

我們可以用一個使用yield和一個使用yield from的例子來對比看下。

使用yield

# 字串
astr='ABC'
# 列表
alist=[1,2,3]
# 字典
adict={"name":"wangbm","age":18}
# 生成器
agen=(i for i in range(4,8))

def gen(*args, **kw):
    for item in args:
        for i in item:
            yield i

new_list=gen(astr, alist, adict, agen)
print(list(new_list))
# ['A', 'B', 'C', 1, 2, 3, 'name', 'age', 4, 5, 6, 7]
複製程式碼

使用yield from

# 字串
astr='ABC'
# 列表
alist=[1,2,3]
# 字典
adict={"name":"wangbm","age":18}
# 生成器
agen=(i for i in range(4,8))

def gen(*args, **kw):
    for item in args:
        yield from item

new_list=gen(astr, alist, adict, agen)
print(list(new_list))
# ['A', 'B', 'C', 1, 2, 3, 'name', 'age', 4, 5, 6, 7]
複製程式碼

由上面兩種方式對比,可以看出,yield from後面加上可迭代物件,他可以把可迭代物件裡的每個元素一個一個的yield出來,對比yield來說程式碼更加簡潔,結構更加清晰。

. 複雜應用:生成器的巢狀

如果你認為只是 yield from 僅僅只有上述的功能的話,那你就太小瞧了它,它的更強大的功能還在後面。

yield from 後面加上一個生成器後,就實現了生成的巢狀。

當然實現生成器的巢狀,並不是一定必須要使用yield from,而是使用yield from可以讓我們避免讓我們自己處理各種料想不到的異常,而讓我們專注於業務程式碼的實現。

如果自己用yield去實現,那隻會加大程式碼的編寫難度,降低開發效率,降低程式碼的可讀性。既然Python已經想得這麼周到,我們當然要好好利用起來。

講解它之前,首先要知道這個幾個概念

1、呼叫方:呼叫委派生成器的客戶端(呼叫方)程式碼
2、委託生成器:包含yield from表示式的生成器函式
3、子生成器:yield from後面加的生成器函式

你可能不知道他們都是什麼意思,沒關係,來看下這個例子。

這個例子,是實現實時計算平均值的。
比如,第一次傳入10,那返回平均數自然是10.
第二次傳入20,那返回平均數是(10+20)/2=15
第三次傳入30,那返回平均數(10+20+30)/3=20

# 子生成器
def average_gen():
    total = 0
    count = 0
    average = 0
    while True:
        new_num = yield average
        count += 1
        total += new_num
        average = total/count

# 委託生成器
def proxy_gen():
    while True:
        yield from average_gen()

# 呼叫方
def main():
    calc_average = proxy_gen()
    next(calc_average)            # 預激下生成器
    print(calc_average.send(10))  # 列印:10.0
    print(calc_average.send(20))  # 列印:15.0
    print(calc_average.send(30))  # 列印:20.0

if __name__ == '__main__':
    main()
複製程式碼

認真閱讀以上程式碼,你應該很容易能理解,呼叫方、委託生成器、子生成器之間的關係。我就不多說了

委託生成器的作用是:在呼叫方與子生成器之間建立一個雙向通道

所謂的雙向通道是什麼意思呢?
呼叫方可以通過send()直接傳送訊息給子生成器,而子生成器yield的值,也是直接返回給呼叫方。

你可能會經常看到有些程式碼,還可以在yield from前面看到可以賦值。這是什麼用法?

你可能會以為,子生成器yield回來的值,被委託生成器給攔截了。你可以親自寫個demo執行試驗一下,並不是你想的那樣。
因為我們之前說了,委託生成器,只起一個橋樑作用,它建立的是一個雙向通道,它並沒有權利也沒有辦法,對子生成器yield回來的內容做攔截。

為了解釋這個用法,我還是用上述的例子,並對其進行了一些改造。新增了一些註釋,希望你能看得明白。

按照慣例,我們還是舉個例子。

# 子生成器
def average_gen():
    total = 0
    count = 0
    average = 0
    while True:
        new_num = yield average
        if new_num is None:
            break
        count += 1
        total += new_num
        average = total/count

    # 每一次return,都意味著當前協程結束。
    return total,count,average

# 委託生成器
def proxy_gen():
    while True:
        # 只有子生成器要結束(return)了,yield from左邊的變數才會被賦值,後面的程式碼才會執行。
        total, count, average = yield from average_gen()
        print("計算完畢!!\n總共傳入 {} 個數值, 總和:{},平均數:{}".format(count, total, average))

# 呼叫方
def main():
    calc_average = proxy_gen()
    next(calc_average)            # 預激協程
    print(calc_average.send(10))  # 列印:10.0
    print(calc_average.send(20))  # 列印:15.0
    print(calc_average.send(30))  # 列印:20.0
    calc_average.send(None)      # 結束協程
    # 如果此處再呼叫calc_average.send(10),由於上一協程已經結束,將重開一協程

if __name__ == '__main__':
    main()
複製程式碼

執行後,輸出

10.0
15.0
20.0
計算完畢!!
總共傳入 3 個數值, 總和:60,平均數:20.0
複製程式碼


為什麼要使用yield from

學到這裡,我相信你肯定要問,既然委託生成器,起到的只是一個雙向通道的作用,我還需要委託生成器做什麼?我呼叫方直接呼叫子生成器不就好啦?

高能預警~~~

下面我們來一起探討一下,到底yield from 有什麼過人之處,讓我們非要用它不可。

. 因為它可以幫我們處理異常

如果我們去掉委託生成器,而直接呼叫子生成器。那我們就需要把程式碼改成像下面這樣,我們需要自己捕獲異常並處理。而不像使yield from那樣省心。

# 子生成器
def average_gen():
    total = 0
    count = 0
    average = 0
    while True:
        new_num = yield average
        if new_num is None:
            break
        count += 1
        total += new_num
        average = total/count
    return total,count,average

# 呼叫方
def main():
    calc_average = average_gen()
    next(calc_average)            # 預激協程
    print(calc_average.send(10))  # 列印:10.0
    print(calc_average.send(20))  # 列印:15.0
    print(calc_average.send(30))  # 列印:20.0

    # ----------------注意-----------------
    try:
        calc_average.send(None)
    except StopIteration as e:
        total, count, average = e.value
        print("計算完畢!!\n總共傳入 {} 個數值, 總和:{},平均數:{}".format(count, total, average))
    # ----------------注意-----------------

if __name__ == '__main__':
    main()
複製程式碼

此時的你,可能會說,不就一個StopIteration的異常嗎?自己捕獲也沒什麼大不了的。

你要是知道yield from在背後為我們默默無聞地做了哪些事,你就不會這樣說了。

具體yield from為我們做了哪些事,可以參考如下這段程式碼。

#一些說明
"""
_i:子生成器,同時也是一個迭代器
_y:子生成器生產的值
_r:yield from 表示式最終的值
_s:呼叫方通過send()傳送的值
_e:異常物件
"""

_i = iter(EXPR)

try:
    _y = next(_i)
except StopIteration as _e:
    _r = _e.value

else:
    while 1:
        try:
            _s = yield _y
        except GeneratorExit as _e:
            try:
                _m = _i.close
            except AttributeError:
                pass
            else:
                _m()
            raise _e
        except BaseException as _e:
            _x = sys.exc_info()
            try:
                _m = _i.throw
            except AttributeError:
                raise _e
            else:
                try:
                    _y = _m(*_x)
                except StopIteration as _e:
                    _r = _e.value
                    break
        else:
            try:
                if _s is None:
                    _y = next(_i)
                else:
                    _y = _i.send(_s)
            except StopIteration as _e:
                _r = _e.value
                break
RESULT = _r
複製程式碼

以上的程式碼,稍微有點複雜,有興趣的同學可以結合以下說明去研究看看。

  1. 迭代器(即可指子生成器)產生的值直接返還給呼叫者
  2. 任何使用send()方法發給委派生產器(即外部生產器)的值被直接傳遞給迭代器。如果send值是None,則呼叫迭代器next()方法;如果不為None,則呼叫迭代器的send()方法。如果對迭代器的呼叫產生StopIteration異常,委派生產器恢復繼續執行yield from後面的語句;若迭代器產生其他任何異常,則都傳遞給委派生產器。
  3. 子生成器可能只是一個迭代器,並不是一個作為協程的生成器,所以它不支援.throw()和.close()方法,即可能會產生AttributeError 異常。
  4. 除了GeneratorExit 異常外的其他拋給委派生產器的異常,將會被傳遞到迭代器的throw()方法。如果迭代器throw()呼叫產生了StopIteration異常,委派生產器恢復並繼續執行,其他異常則傳遞給委派生產器。
  5. 如果GeneratorExit異常被拋給委派生產器,或者委派生產器的close()方法被呼叫,如果迭代器有close()的話也將被呼叫。如果close()呼叫產生異常,異常將傳遞給委派生產器。否則,委派生產器將丟擲GeneratorExit 異常。
  6. 當迭代器結束並丟擲異常時,yield from表示式的值是其StopIteration 異常中的第一個引數。
  7. 一個生成器中的return expr語句將會從生成器退出並丟擲 StopIteration(expr)異常。

沒興趣看的同學,只要知道,yield from幫我們做了很多的異常處理,而且全面,而這些如果我們要自己去實現的話,一個是編寫程式碼難度增加,寫出來的程式碼可讀性極差,這些我們就不說了,最主要的是很可能有遺漏,只要哪個異常沒考慮到,都有可能導致程式崩潰什麼的。

------------------------------------------------------------------------------------------------

                                 關注公眾號,獲取最新文章
                                              關注公眾號,獲取最新文章


相關文章