一文完全搞懂Python可迭代(Iterable)、迭代器(Iterator)和生成器(Generator)的概念

在Python中可迭代(Iterable)、迭代器(Iterator)和生成器(Generator)這幾個概念是常常用到的，初學時對這幾個概念也是常常混淆，如今是時候把這幾個概念搞清楚了。

0x00 可迭代(Iterable)

簡單的說，一個對象(在Python裏面一切都是對象)只要實現了只要實現了__iter__()方法，那麼用isinstance()函數檢查就是Iterable對象；

例如

class IterObj:
    
    def __iter__(self):
        # 這裏簡單地返回自身
        # 但實際狀況可能不會這麼寫
        # 而是經過內置的可迭代對象來實現
        # 下文的列子中將會展現
        return self 
複製代碼

上面定義了一個類IterObj並實現了__iter__()方法，這個就是一個可迭代(Iterable)對象

it = IterObj()
    print(isinstance(it, Iterable))  # true
    print(isinstance(it, Iterator))  # false
    print(isinstance(it, Generator)) # false
複製代碼

記住這個類，下文咱們還會看到這個類的定義。

常見的可迭代對象

在Python中有哪些常見的可迭代對象呢？

1. 集合或序列類型（如list、tuple、set、dict、str）
2. 文件對象
3. 在類中定義了__iter__()方法的對象，能夠被認爲是 Iterable對象，但自定義的可迭代對象要能在for循環中正確使用，就須要保證__iter__()實現必須是正確的（便可以經過內置iter()函數轉成Iterator對象。關於Iterator下文還會說明，這裏留下一個坑，只是記住iter()函數是可以將一個可迭代對象轉成迭代器對象，而後在for中使用）
4. 在類中實現了若是隻實現__getitem__()的對象能夠經過iter()函數轉化成迭代器但其自己不是可迭代對象。因此當一個對象可以在for循環中運行，但不必定是Iterable對象。

關於第一、2點咱們能夠經過如下來驗證

print(isinstance([], Iterable))  # true list 是可迭代的
    print(isinstance({}, Iterable))  # true 字典是可迭代的
    print(isinstance((), Iterable))  # true 元組是可迭代的
    print(isinstance(set(), Iterable))  # true set是可迭代的
    print(isinstance('', Iterable))  # true 字符串是可迭代的
    
    currPath = os.path.dirname(os.path.abspath(__file__))
    with open(currPath+'/model.py') as file:
        print(isinstance(file, Iterable)) # true
複製代碼

咱們再來看第3點，

print(hasattr([], "__iter__")) # true
    print(hasattr({}, "__iter__")) # true
    print(hasattr((), "__iter__")) # true
    print(hasattr('', "__iter__")) # true
複製代碼

這些內置集合或序列對象都有__iter__屬性，即他們都實現了同名方法。但這個可迭代對象要在for循環中被使用，那麼它就應該可以被內置的iter()函數調用並轉化成Iterator對象。
例如，咱們看內置的可迭代對象

print(iter([])) # <list_iterator object at 0x110243f28>
    print(iter({})) # <dict_keyiterator object at 0x110234408>
    print(iter(())) # <tuple_iterator object at 0x110243f28>
    print(iter('')) # <str_iterator object at 0x110243f28>
複製代碼

它們都相應的轉成了對應的迭代器(Iterator)對象。
如今回過頭再看看一開始定義的那個IterObj類

class IterObj:
    
    def __iter__(self):
        return self 
        
it = IterObj()
print(iter(it))
複製代碼

咱們使用了iter()函數，這時候將再控制檯上打印出如下信息：

Traceback (most recent call last):
  File "/Users/mac/PycharmProjects/iterable_iterator_generator.py", line 71, in <module>
    print(iter(it))
TypeError: iter() returned non-iterator of type 'IterObj'
複製代碼

出現了類型錯誤，意思是iter()函數不能將‘非迭代器’類型轉成迭代器。

那如何才能將一個可迭代(Iterable)對象轉成迭代器(Iterator)對象呢？ 咱們修改一下IterObj類的定義

class IterObj:

    def __init__(self):
        self.a = [3, 5, 7, 11, 13, 17, 19]

    def __iter__(self):
        return iter(self.a)
複製代碼

咱們在構造方法中定義了一個名爲a的列表，而後還實現了__iter__()方法。

修改後的類是能夠被iter()函數調用的，即也能夠在for循環中使用

it = IterObj()
    print(isinstance(it, Iterable)) # true
    print(isinstance(it, Iterator)) # false
    print(isinstance(it, Generator)) # false
    print(iter(it)) # <list_iterator object at 0x102007278>
    for i in it:
        print(i) # 將打印三、五、七、十一、1三、1七、19元素
複製代碼

所以在定義一個可迭代對象時，咱們要很是注意__iter__()方法的內部實現邏輯，通常狀況下，是經過一些已知的可迭代對象（例如，上文提到的集合、序列、文件等或其餘正肯定義的可迭代對象）來輔助咱們來實現

關於第4點說明的意思是iter()函數能夠將一個實現了__getitem__()方法的對象轉成迭代器對象，也能夠在for循環中使用，可是若是用isinstance()方法來檢測時，它不是一個可迭代對象。

class IterObj:
    
    def __init__(self):
        self.a = [3, 5, 7, 11, 13, 17, 19]
    
    def __getitem__(self, i):
        return self.a[i]
        
it = IterObj()
print(isinstance(it, Iterable)) # false
print(isinstance(it, Iterator)) # false
print(isinstance(it, Generator)) false
print(hasattr(it, "__iter__")) # false
print(iter(it)) # <iterator object at 0x10b231278>

for i in it:
    print(i) # 將打印出三、五、七、十一、1三、1七、19
複製代碼

這個例子說明了能夠在for中使用的對象，不必定是可迭代對象。

如今咱們作個小結：

1. 一個可迭代的對象是實現了__iter__()方法的對象
2. 它要在for循環中使用，就必須知足iter()的調用(即調用這個函數不會出錯，可以正確轉成一個Iterator對象)
3. 能夠經過已知的可迭代對象來輔助實現咱們自定義的可迭代對象。
4. 一個對象實現了__getitem__()方法能夠經過iter()函數轉成Iterator，便可以在for循環中使用，但它不是一個可迭代對象(可用isinstance方法檢測())

0x01 迭代器(Iterator)

上文不少地方都提到了Iterator,如今咱們把這個坑填上。
當咱們對可迭代的概念瞭解後，對於迭代器就比較好理解了。 一個對象實現了__iter__()和__next__()方法，那麼它就是一個迭代器對象。 例如

class IterObj:

    def __init__(self):
        self.a = [3, 5, 7, 11, 13, 17, 19]

        self.n = len(self.a)
        self.i = 0

    def __iter__(self):
        return iter(self.a)

    def __next__(self):
        while self.i < self.n:
            v = self.a[self.i]
            self.i += 1
            return v
        else:
            self.i = 0
            raise StopIteration()
複製代碼

在IterObj中，構造函數中定義了一個列表a,列表長度n,索引i。

it = IterObj()
    print(isinstance(it, Iterable)) # true
    print(isinstance(it, Iterator)) # true
    print(isinstance(it, Generator)) # false
    print(hasattr(it, "__iter__")) # true
    print(hasattr(it, "__next__")) # true
複製代碼

咱們能夠發現上文提到的
集合和序列對象是可迭代的但不是迭代器

print(isinstance([], Iterator)) # false
    print(isinstance({}, Iterator)) # false
    print(isinstance((), Iterator)) # false
    print(isinstance(set(), Iterator)) # false
    print(isinstance('', Iterator)) # false
複製代碼

而文件對象是迭代器

currPath = os.path.dirname(os.path.abspath(__file__))
    with open(currPath+'/model.py') as file:
        print(isinstance(file, Iterator)) # true
複製代碼

一個迭代器(Iterator)對象不只能夠在for循環中使用，還能夠經過內置函數next()函數進行調用。 例如

it = IterObj()
next(it) # 3
next(it) # 5
複製代碼

0x02 生成器(Generator)

如今咱們來看看什麼是生成器？
一個生成器既是可迭代的也是迭代器

定義生成器有兩種方式：

1. 列表生成器
2. 使用yield定義生成器函數

先看第1種狀況

g = (x * 2 for x in range(10)) # 0～18的偶數生成器 
    print(isinstance(g, Iterable)) # true
    print(isinstance(g, Iterator)) # true
    print(isinstance(g, Generator)) # true
    print(hasattr(g, "__iter__")) # true
    print(hasattr(g, "__next__")) # true
    print(next(g)) # 0
    print(next(g)) # 2
複製代碼

列表生成器能夠不須要消耗大量的內存來生成一個巨大的列表，只有在須要數據的時候纔會進行計算。
再看第2種狀況

def gen():
    for i in range(10):
        yield i 
複製代碼

這裏yield的做用就至關於return,這個函數就是順序地返回[0,10)的之間的天然數，能夠經過next()或使用for循環來遍歷。
當程序遇到yield關鍵字時，這個生成器函數就返回了，直到再次執行了next()函數，它就會從上次函數返回的執行點繼續執行，即yield退出時保存了函數執行的位置、變量等信息，再次執行時，就從這個yield退出的地方繼續往下執行。
在Python中利用生成器的這些特色能夠實現協程。協程能夠理解爲一個輕量級的線程，它相對於線程處理高併發場景有不少優點。

看下面一個用協程實現的生產者-消費者模型

def producer(c):
    n = 0
    while n < 5:
        n += 1
        print('producer {}'.format(n))
        r = c.send(n)
        print('consumer return {}'.format(r))


def consumer():
    r = ''
    while True:
        n = yield r
        if not n:
            return
        print('consumer {} '.format(n))
        r = 'ok'


if __name__ == '__main__':
    c = consumer()
    next(c)  # 啓動consumer
    producer(c)
複製代碼

這段代碼執行效果以下

producer 1
consumer 1 
producer return ok
producer 2
consumer 2 
producer return ok
producer 3
consumer 3 
producer return ok
複製代碼

協程實現了CPU在兩個函數之間進行切換從而實現併發的效果。

0x04 引用

1. docs.python.org/3.7/