[Python]生成器generator，可迭代Iterable和迭代器Iterator

---

原創文章，歡迎轉載。轉載請註明：轉載自 祥的博客
原文鏈接：https://blog.csdn.net/humanking7/article/details/97794005

---

[Python]生成器generator，可迭代Iterable和迭代器Iterator

Python文檔整理目錄： https://blog.csdn.net/humanking7/article/details/80757533

0. 環境

• Python 3.6

1. 生成器 generator

1.1. 什麼是生成器？

通過列表生成式，我們可以直接創建一個列表，但是受到內存限制，列表容量肯定是有限的，而且創建一個包含100萬個元素的列表，不僅佔用很大的存儲空間，如果我們僅僅需要訪問前面幾個元素，那後面絕大多數元素佔用的空間都白白浪費了。

所以，如果列表元素可以按照某種算法推算出來，那我們是否可以在循環的過程中不斷推算出後續的元素呢？這樣就不必創建完整的list，從而節省大量的空間，在Python中，這種一邊循環一邊計算的機制，稱爲生成器：generator

生成器是一個特殊的程序，可以被用作控制循環的迭代行爲，Python中生成器是迭代器的一種，使用yield返回值函數，每次調用yield會暫停，而可以使用next()函數和send()函數恢復生成器。

生成器類似於返回值爲數組的一個函數，這個函數可以接受參數，可以被調用，但是，不同於一般的函數會一次性返回包括了所有數值的數組，生成器一次只能產生一個值，這樣消耗的內存數量將大大減小，而且允許調用函數可以很快的處理前幾個返回值，因此生成器看起來像是一個函數，但是表現得卻像是迭代器。

1.2. 創建生成器

要創建一個generator，有很多種方法。

方法1：用生成器表達式，[]改爲()

第1種方法很簡單，只要把一個列表生成式的[]改成()，就創建了一個generator：

In [1]: L = [x*x for x in range(5)]

In [2]: L
Out[2]: [0, 1, 4, 9, 16]

In [3]: g = (x*x for x in range(5))

In [4]: g
Out[4]: <generator object <genexpr> at 0x000000000466EA98>

In [5]: type(g)
Out[5]: generator

創建L和g的區別僅在於最外層的[]和()，L是一個list，而g是一個generator。

我們可以直接打印出list的每一個元素，但我們怎麼打印出generator的每一個元素呢？

如果要一個一個打印出來，可以通過next()函數獲得generator的下一個返回值：

In [6]: next(g)
Out[6]: 0

In [7]: next(g)
Out[7]: 1

In [8]: next(g)
Out[8]: 4

In [9]: next(g)
Out[9]: 9

In [10]: next(g)
Out[10]: 16

In [11]: next(g)
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-11-e734f8aca5ac> in <module>()
----> 1 next(g)

StopIteration:

我們講過，generator保存的是算法，每次調用next(g)，就計算出g的下一個元素的值，直到計算到最後一個元素，沒有更多的元素時，拋出StopIteration的錯誤。

當然，上面這種不斷調用next(g)不方便，正確的方法是使用for循環，因爲generator也是可迭代對象：

In [13]: g = (x*x for x in range(5))

In [14]: for n in g:
    ...:     print(n)
    ...:
0
1
4
9
16

所以，我們創建了一個generator後，基本上永遠不會調用next()，而是通過for循環來迭代它，並且不需要關心StopIteration的錯誤。

方法2：用生成器函數，使用關鍵字 yield

generator非常強大。如果推算的算法比較複雜，用類似列表生成式的for循環無法實現的時候，還可以用函數來實現。

比如，著名的斐波拉契數列（Fibonacci），除第一個和第二個數外，任意一個數都可由前兩個數相加得到：

1, 1, 2, 3, 5, 8, 13, 21, 34, …

斐波拉契數列用列表生成式寫不出來，但是，用函數把它打印出來卻很容易：

def fib_print(max):
    n, a, b = 0, 0, 1
    while n < max:
        print(b, end=' ')
        a, b = b, a + b
        n = n + 1
    print('\n')
    return 'done'

In [18]: fib_print(8)
1 1 2 3 5 8 13 21

Out[18]: 'done'

仔細觀察，可以看出，fib_print()函數實際上是定義了斐波拉契數列的推算規則，可以從第一個元素開始，推算出後續任意的元素，這種邏輯其實非常類似generator。

也就是說，上面的函數和generator僅一步之遙。要把fib_print()函數變成generator，只需要把print(b, end=' ')改爲yield b就可以了：

def fib_g(max):
    n, a, b = 0, 0, 1
    while n < max:
        yield b
        a, b = b, a + b
        n = n + 1
    return 'done'

這就是定義generator的另一種方法。如果一個函數定義中包含yield關鍵字，那麼這個函數就不再是一個普通函數，而是一個generator：

In [20]: fg = fib_g(8)

In [21]: fg
Out[21]: <generator object fib_g at 0x000000000466E830>

這裏，最難理解的就是generator和函數的執行流程不一樣。函數是順序執行，遇到return語句或者最後一行函數語句就返回。而變成generator的函數，在每次調用next()的時候執行，遇到yield語句返回，再次執行時從上次返回的yield語句處繼續執行。

舉個簡單的例子，定義一個generator，依次返回數字1，3，5：

def odd():
    print('==== step 1 ====')
    yield 1
    print('==== step 2 ====')
    yield(3)
    print('==== step 3 ====')
    yield(5)

調用該generator時，首先要生成一個generator對象，然後用next()函數不斷獲得下一個返回值：

In [23]: og = odd()

In [24]: next(og)
==== step 1 ====
Out[24]: 1

In [25]: next(og)
==== step 2 ====
Out[25]: 3

In [26]: next(og)
==== step 3 ====
Out[26]: 5

In [27]: next(og)
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-27-7e59cec5e8f1> in <module>()
----> 1 next(og)

StopIteration:

可以看到，odd不是普通函數，而是generator，在執行過程中，遇到yield就中斷，下次又繼續執行。執行3次yield後，已經沒有yield可以執行了，所以，第4次調用next(o)就報錯。

回到fib_g()的例子，我們在循環過程中不斷調用yield，就會不斷中斷。當然要給循環設置一個條件來退出循環，不然就會產生一個無限數列出來。

同樣的，把函數改成generator後，我們基本上從來不會用next()來獲取下一個返回值，而是直接使用for循環來迭代：

In [28]: for n in fib_g(8):
    ...: ...     print(n, end=' ')
    ...:
1 1 2 3 5 8 13 21

但是用for循環調用generator時，發現拿不到generator的return語句的返回值。如果想要拿到返回值，必須捕獲StopIteration錯誤，返回值包含在StopIteration的value中：

In [30]: g = fib_g(6)

In [31]: while True:
    ...:      try:
    ...:          x = next(g)
    ...:          print('g:', x)
    ...:      except StopIteration as e:
    ...:          print('Generator return value:', e.value)
    ...:          break
    ...:
g: 1
g: 1
g: 2
g: 3
g: 5
g: 8
Generator return value: done

1.3. 例子

寫一個楊輝三角

          1
         / \
        1   1
       / \ / \
      1   2   1
     / \ / \ / \
    1   3   3   1
   / \ / \ / \ / \
  1   4   6   4   1
 / \ / \ / \ / \ / \
1   5   10  10  5   1

把每一行看做一個list，試寫一個generator，不斷輸出下一行的list：

def triangles():
    l = [1]
    while True:
        yield(l)
        l = [1] + [l[x] + l[x+1] for x in range(len(l)-1)] + [1]

測試：

In [33]: tg = triangles()

In [34]: tg
Out[34]: <generator object triangles at 0x000000000466EE60>

In [35]: next(tg)
Out[35]: [1]

In [36]: next(tg)
Out[36]: [1, 1]

In [37]: next(tg)
Out[37]: [1, 2, 1]

In [38]: next(tg)
Out[38]: [1, 3, 3, 1]

In [39]: next(tg)
Out[39]: [1, 4, 6, 4, 1]

In [40]: next(tg)
Out[40]: [1, 5, 10, 10, 5, 1]

2. 迭代器 Iterator

2.1. 可迭代 Iterable

可以直接作用於for循環的數據類型有以下幾種：

• 一類是集合數據類型，如list、tuple、dict、set、str等；

• 一類是generator，包括生成器和帶yield的generator function。

這些可以直接作用於for循環的對象統稱爲可迭代對象：Iterable。

注意：

Iterable是可迭代，不一定是迭代器。

可以使用isinstance()判斷一個對象是否是Iterable對象：

In [1]: from collections import Iterable

In [2]: isinstance([], Iterable)
Out[2]: True

In [3]: isinstance({}, Iterable)
Out[3]: True

In [4]: isinstance('123abc', Iterable)
Out[4]: True

In [5]: isinstance( (x for x in range(4)), Iterable)
Out[5]: True

In [6]: isinstance( 123, Iterable)
Out[6]: False

2.2. 迭代器 Iterator

而生成器不但可以作用於for循環，還可以被next()函數不斷調用並返回下一個值，直到最後拋出StopIteration錯誤表示無法繼續返回下一個值了。

可以被next()函數調用並不斷返回下一個值的對象稱爲迭代器：Iterator。

可以使用isinstance()判斷一個對象是否是Iterator對象：

In [9]: from collections import Iterator

In [10]: g = (x for x in range(4))  # generator

In [11]: isinstance(g, Iterator)
Out[11]: True

In [12]: isinstance([], Iterator)
Out[12]: False

In [13]: isinstance({}, Iterator)
Out[13]: False

In [14]: isinstance('123abc', Iterator)
Out[14]: False

In [15]: isinstance(123, Iterator)
Out[15]: False

簡言之：

生成器都是Iterator對象，但list、dict、str雖然是Iterable，卻不是Iterator。

把list、dict、str等Iterable變成Iterator可以使用iter()函數：

In [19]: isinstance(iter([]), Iterator)
Out[19]: True

In [21]: isinstance(iter({}), Iterator)
Out[21]: True

In [22]: isinstance(iter('123abc'), Iterator)
Out[22]: True

問題

爲什麼list、dict、str等數據類型不是Iterator？

這是因爲Python的Iterator對象表示的是一個數據流，Iterator對象可以被next()函數調用並不斷返回下一個數據，直到沒有數據時拋出StopIteration錯誤。可以把這個數據流看做是一個有序序列，但我們卻不能提前知道序列的長度，只能不斷通過next()函數實現按需計算下一個數據，所以Iterator的計算是惰性的，只有在需要返回下一個數據時它纔會計算。

Iterator甚至可以表示一個無限大的數據流，例如全體自然數。 而使用list是永遠不可能存儲全體自然數的。

用途決定一切，個人覺得一般情況下非惰性數據類型還是靈活一些。

2.3. 可迭代與迭代器

可迭代：
在Python中如果一個對象有__iter__( )方法或__getitem__( )方法，則稱這個對象是可迭代的（Iterable）；其中__iter__( )方法的作用是讓對象可以用for ... in循環遍歷，__getitem__( )方法是讓對象可以通過“實例名[index]”的方式訪問實例中的元素。換句話說，兩個條件只要滿足一條，就可以說對象是可迭代的。顯然列表List、元組Tuple、字典Dictionary、字符串String等數據類型都是可迭代的。當然因爲Python的**“鴨子類型”**，我們自定義的類中只要實現了__iter__( )方法或__getitem__( )方法，也是可迭代的。

迭代器：
在Python中如果一個對象有__iter__( )方法和__next__( )方法，則稱這個對象是迭代器（Iterator）；其中__iter__( )方法是讓對象可以用for ... in循環遍歷，__next__( )方法是讓對象可以通過next(實例名)訪問下一個元素。

注意：這兩個方法必須同時具備，才能稱之爲迭代器。列表List、元組Tuple、字典Dictionary、字符串String等數據類型雖然是可迭代的，但都不是迭代器，因爲他們都沒有next( )方法。

2.4. 小結

• 凡是可作用於for循環的對象都是Iterable類型；
• 凡是可作用於next()函數的對象都是Iterator類型，它們表示一個惰性計算的序列；
• 生成器generator 一定是迭代器 Iterator；
• 集合數據類型如list、dict、str等是Iterable但不是Iterator，不過可以通過iter()函數獲得一個Iterator對象。

Python的for循環本質上就是通過不斷調用next()函數實現的，例如：

for x in [1, 2, 3, 4, 5]:
    pass

實際上完全等價於：

# 首先獲得Iterator對象:
it = iter([1, 2, 3, 4, 5])
# 循環:
while True:
    try:
        # 獲得下一個值:
        x = next(it)
    except StopIteration:
        # 遇到StopIteration就退出循環
        break

參考文獻

廖雪峯的Python教程：

• https://www.liaoxuefeng.com/wiki/1016959663602400/1017318207388128
• https://www.liaoxuefeng.com/wiki/1016959663602400/1017323698112640

其它教程：

• https://www.cnblogs.com/wj-1314/p/8490822.html
• https://www.jb51.net/article/134844.htm

---

OK！
以上，Enjoy~

---

i