在Python中如何使用yield

Posted on by

一、生成器

如果在一個方法內，包含瞭 yield 關鍵字，那麼這個函數就是一個「生成器」。

生成器其實就是一個特殊的迭代器，它可以像迭代器那樣，迭代輸出方法內的每個元素。

我們來看一個包含 yield 關鍵字的方法：

# coding: utf8

# 生成器
def gen(n):
    for i in range(n):
        yield i

g = gen(5)      # 創建一個生成器
print(g)        # <generator object gen at 0x10bb46f50>
print(type(g))  # <type 'generator'>

# 迭代生成器中的數據
for i in g:
    print(i)
    
# Output:
# 0 1 2 3 4

註意，在這個例子中，當我們執行 g = gen(5) 時，gen 中的代碼其實並沒有執行，此時我們隻是創建瞭一個「生成器對象」，它的類型是 generator。

然後，當我們執行 for i in g，每執行一次循環，就會執行到 yield 處，返回一次 yield 後面的值。

這個迭代過程是和迭代器最大的區別。

換句話說，如果我們想輸出 5 個元素，在創建生成器時，這個 5 個元素其實還並沒有產生，什麼時候產生呢？隻有在執行for循環遇到 yield 時，才會依次生成每個元素。

此外，生成器除瞭和迭代器一樣實現迭代數據之外，還包含瞭其他方法：

  • generator.__next__()：執行 for 時調用此方法，每次執行到 yield 就會停止，然後返回 yield 後面的值，如果沒有數據可迭代，拋出 StopIterator 異常，for 循環結束
  • generator.send(value)：外部傳入一個值到生成器內部，改變 yield 前面的值
  • generator.throw(type[, value[, traceback]])：外部向生成器拋出一個異常
  • generator.close()：關閉生成器

通過使用生成器的這些方法，我們可以完成很多有意思的功能。

二、next

先來看生成器的 __next__ 方法，我們看下面這個例子。

# coding: utf8

def gen(n):
    for i in range(n):
        print('yield before')
        yield i
        print('yield after')

g = gen(3)      # 創建一個生成器
print(g.__next__())  # 0
print('----')
print(g.__next__())  # 1
print('----')
print(g.__next__())  # 2
print('----')
print(g.__next__())  # StopIteration

# Output:
# yield before
# 0
# ----
# yield after
# yield before
# 1
# ----
# yield after
# yield before
# 2
# ----
# yield after
# Traceback (most recent call last):
#   File "gen.py", line 16, in <module>
#     print(g.__next__())  # StopIteration
# StopIteration

在這個例子中，我們定義瞭 gen 方法，這個方法包含瞭 yield 關鍵字。然後我們執行 g = gen(3) 創建一個生成器，但是這次沒有執行 for 去迭代它，而是多次調用 g.__next__() 去輸出生成器中的元素。

我們看到，當執行 g.__next__()時，代碼就會執行到 yield 處，然後返回 yield 後面的值，如果繼續調用 g.__next__()，註意，你會發現，這次執行的開始位置，是上次 yield 結束的地方，並且它還保留瞭上一次執行的上下文，繼續向後迭代。

這就是使用 yield 的作用，在迭代生成器時，每一次執行都可以保留上一次的狀態，而不是像普通方法那樣，遇到 return 就返回結果，下一次執行隻能再次重復上一次的流程。

生成器除瞭能保存狀態之外，我們還可以通過其他方式，改變其內部的狀態，這就是下面要講的 send 和 throw 方法。

三、send

上面的例子中，我們隻展示瞭在 yield 後有值的情況，其實還可以使用 j = yield i 這種語法，我們看下面的代碼：

# coding: utf8

def gen():
    i = 1
    while True:
        j = yield i
        i *= 2
        if j == -1:
            break

此時如果我們執行下面的代碼：

for i in gen():
    print(i)
    time.sleep(1)

輸出結果會是 1 2 4 8 16 32 64 ... 一直循環下去， 直到我們殺死這個進程才能停止。

這段代碼一直循環的原因在於，它無法執行到 j == -1 這個分支裡 break 出來，如果我們想讓代碼執行到這個地方，如何做呢？

這裡就要用到生成器的 send 方法瞭，send 方法可以把外部的值傳入生成器內部，從而改變生成器的狀態。

g = gen()   # 創建一個生成器
print(g.__next__())  # 1
print(g.__next__())  # 2
print(g.__next__())  # 4
# send 把 -1 傳入生成器內部 走到瞭 j = -1 這個分支
print(g.send(-1))   # StopIteration 迭代停止

當我們執行 g.send(-1) 時，相當於把 -1 傳入到瞭生成器內部，然後賦值給瞭 yield 前面的 j，此時 j = -1，然後這個方法就會 break 出來，不會繼續迭代下去。

四、throw

外部除瞭可以向生成器內部傳入一個值外，還可以傳入一個異常，也就是調用 throw 方法：

# coding: utf8

def gen():
    try:
        yield 1
    except ValueError:
        yield 'ValueError'
    finally:
        print('finally')

g = gen()   # 創建一個生成器
print(g.__next__()) # 1
# 向生成器內部傳入異常 返回ValueError
print(g.throw(ValueError))

# Output：
# 1
# ValueError
# finally

這個例子創建好生成器後，使用 g.throw(ValueError) 的方式，向生成器內部傳入瞭一個異常，走到瞭生成器異常處理的分支邏輯。

五、close

生成器的 close 方法也比較簡單，就是手動關閉這個生成器，關閉後的生成器無法再進行操作。

>>> g = gen()
>>> g.close() # 關閉生成器
>>> g.__next__() # 無法迭代數據
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
StopIteration

close 方法我們在開發中使用得比較少，瞭解一下就好。

六、使用場景

瞭解瞭 yield 和生成器的使用方式，那麼 yield 和生成器一般用在哪些業務場景中呢？

下面我介紹幾個例子，分別是大集合的生成、簡化代碼結構、協程與並發，你可以參考這些使用場景來使用 yield。

大集合的生成

如果你想生成一個非常大的集合，如果使用 list 創建一個集合，這會導致在內存中申請一個很大的存儲空間，例如想下面這樣：

# coding: utf8

def big_list():
    result = []
    for i in range(10000000000):
        result.append(i)
    return result

# 一次性在內存中生成大集合 內存占用非常大
for i in big_list():
    print(i)

這種場景，我們使用生成器就能很好地解決這個問題。

因為生成器隻有在執行到 yield 時才會迭代數據，這時隻會申請需要返回元素的內存空間，代碼可以這樣寫：

# coding: utf8

def big_list():
    for i in range(10000000000):
        yield i

# 隻有在迭代時 才依次生成元素 減少內存占用
for i in big_list():
    print(i)

簡化代碼結構

我們在開發時還經常遇到這樣一種場景，如果一個方法要返回一個 list，但這個 list 是多個邏輯塊組合後才能產生的，這就會導致我們的代碼結構變得很復雜：

# coding: utf8

def gen_list():
    # 多個邏輯塊 組成生成一個列表
    result = []
    for i in range(10):
        result.append(i)
    for j in range(5):
        result.append(j * j)
    for k in [100, 200, 300]:
        result.append(k)
    return result
    
for item in gen_list():
    print(item)

這種情況下，我們隻能在每個邏輯塊內使用 append 向 list 中追加元素，代碼寫起來比較囉嗦。

此時如果使用 yield 來生成這個 list，代碼就簡潔很多：

# coding: utf8

def gen_list():
    # 多個邏輯塊 使用yield 生成一個列表
    for i in range(10):
        yield i
    for j in range(5):
        yield j * j
    for k in [100, 200, 300]:
        yield k
        
for item in gen_list():
    print(i)

使用 yield 後，就不再需要定義 list 類型的變量，隻需在每個邏輯塊直接 yield 返回元素即可，可以達到和前面例子一樣的功能。

我們看到，使用 yield 的代碼更加簡潔，結構也更清晰，另外的好處是隻有在迭代元素時才申請內存空間，降低瞭內存資源的消耗。

七、協程與並發

還有一種場景是 yield 使用非常多的，那就是「協程與並發」。

如果我們想提高程序的執行效率，通常會使用多進程、多線程的方式編寫程序代碼，最常用的編程模型就是「生產者-消費者」模型，即一個進程 / 線程生產數據，其他進程 / 線程消費數據。

在開發多進程、多線程程序時，為瞭防止共享資源被篡改，我們通常還需要加鎖進行保護，這樣就增加瞭編程的復雜度。

在 Python 中，除瞭使用進程和線程之外，我們還可以使用「協程」來提高代碼的運行效率。

什麼是協程？

簡單來說，由多個程序塊組合協作執行的程序，稱之為「協程」。

而在 Python 中使用「協程」，就需要用到 yield 關鍵字來配合。

可能這麼說還是太好理解，我們用 yield 實現一個協程生產者、消費者的例子：

# coding: utf8

def consumer():
    i = None
    while True:
        # 拿到 producer 發來的數據
        j = yield i 
        print('consume %s' % j)

def producer(c):
    c.__next__()
    for i in range(5):
        print('produce %s' % i)
        # 發數據給 consumer
        c.send(i)
    c.close()

c = consumer()
producer(c)

# Output:
# produce 0
# consume 0
# produce 1
# consume 1
# produce 2
# consume 2
# produce 3
# consume 3
...

這個程序的執行流程如下：

1.c = consumer() 創建一個生成器對象

2.producer(c) 開始執行，c.__next()__會啟動生成器 consumer 直到代碼運行到 j = yield i 處，此時 consumer 第一次執行完畢，返回

3.producer 函數繼續向下執行，直到 c.send(i)處，這裡利用生成器的 send 方法，向 consumer 發送數據

4.consumer 函數被喚醒，從 j = yield i 處繼續開始執行，並且接收到 producer 傳來的數據賦值給 j，然後打印輸出，直到再次執行到 yield 處，返回

5.producer 繼續循環執行上面的過程，依次發送數據給 cosnumer，直到循環結束

6.最終 c.close() 關閉 consumer 生成器，程序退出

在這個例子中我們發現，程序在 producer 和 consumer 這 2 個函數之間來回切換執行，相互協作，完成瞭生產任務、消費任務的業務場景，最重要的是，整個程序是在單進程單線程下完成的。

到此這篇關於在Python中如何使用yield的文章就介紹到這瞭,更多相關yield的用法內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：