關(guān)于我
一個有思想的程序猿，終身學(xué)習(xí)實踐者，目前在一個創(chuàng)業(yè)團隊任team lead，技術(shù)棧涉及Android、Python、Java和Go，這個也是我們團隊的主要技術(shù)棧。
Github：https://github.com/hylinux1024
微信公眾號：終身開發(fā)者(angrycode)

在 Python 中可迭代( Iterable )、迭代器( Iterator )和生成器( Generator )這幾個概念是經(jīng)常用到的，初學(xué)時對這幾個概念也是經(jīng)常混淆，現(xiàn)在是時候把這幾個概念搞清楚了。

0x00 可迭代(Iterable)

簡單的說，一個對象(在Python里面一切都是對象)只要實現(xiàn)了只要實現(xiàn)了 __iter__() 方法，那么用 isinstance() 函數(shù)檢查就是 Iterable 對象；

例如

            
              class IterObj:

    def __iter__(self):
        # 這里簡單地返回自身
        # 但實際情況可能不會這么寫
        # 而是通過內(nèi)置的可迭代對象來實現(xiàn)
        # 下文的列子中將會展示
        return self 
            
          

上面定義了一個類 IterObj 并實現(xiàn)了 __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__() 方法的對象，可以被認(rèn)為是 Iterable 對象，但自定義的可迭代對象要能在 for 循環(huán)中正確使用，就需要保證 __iter__() 實現(xiàn)必須是正確的（即可以通過內(nèi)置 iter() 函數(shù)轉(zhuǎn)成 Iterator 對象。關(guān)于 Iterator 下文還會說明，這里留下一個坑，只是記住 iter() 函數(shù)是能夠?qū)⒁粋€可迭代對象轉(zhuǎn)成迭代器對象，然后在 for 中使用）
4. 在類中實現(xiàn)了如果只實現(xiàn) __getitem__() 的對象可以通過 iter() 函數(shù)轉(zhuǎn)化成迭代器但其本身不是可迭代對象。所以當(dāng)一個對象能夠在 for 循環(huán)中運行，但不一定是 Iterable 對象。

關(guān)于 第1、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
            
          

這些內(nèi)置集合或序列對象都有 __iter__ 屬性，即他們都實現(xiàn)了同名方法。但這個可迭代對象要在 for 循環(huán)中被使用，那么它就應(yīng)該能夠被內(nèi)置的 iter() 函數(shù)調(diào)用并轉(zhuǎn)化成 Iterator 對象。
例如，我們看內(nèi)置的可迭代對象

            
                  print(iter([])) # 
              
                
    print(iter({})) # 
                
                  
    print(iter(())) # 
                  
                    
    print(iter('')) # 
                    
                  
                
              
            
          

它們都相應(yīng)的轉(zhuǎn)成了對應(yīng)的迭代器( Iterator )對象。
現(xiàn)在回過頭再看看一開始定義的那個 IterObj 類

            
              class IterObj:

    def __iter__(self):
        return self 

it = IterObj()
print(iter(it))
            
          

我們使用了 iter() 函數(shù)，這時候?qū)⒃倏刂婆_上打印出以下信息：

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

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

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

            
              class IterObj:

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

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

我們在構(gòu)造方法中定義了一個名為 a 的列表，然后還實現(xiàn)了 __iter__() 方法。

修改后的類是可以被 iter() 函數(shù)調(diào)用的，即也可以在 for 循環(huán)中使用

            
                  it = IterObj()
    print(isinstance(it, Iterable)) # true
    print(isinstance(it, Iterator)) # false
    print(isinstance(it, Generator)) # false
    print(iter(it)) # 
              
                
    for i in it:
        print(i) # 將打印3、5、7、11、13、17、19元素
              
            
          

因此 在定義一個可迭代對象時，我們要非常注意 __iter__() 方法的內(nèi)部實現(xiàn)邏輯，一般情況下，是通過一些已知的可迭代對象（例如，上文提到的集合、序列、文件等或其他正確定義的可迭代對象）來輔助我們來實現(xiàn)

關(guān)于 第4點 說明的意思是 iter() 函數(shù)可以將一個實現(xiàn)了 __getitem__() 方法的對象轉(zhuǎn)成迭代器對象，也可以在 for 循環(huán)中使用，但是如果用 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)) # 
              
                

for i in it:
    print(i) # 將打印出3、5、7、11、13、17、19
              
            
          

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

現(xiàn)在我們做個小結(jié)：

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

0x01 迭代器(Iterator)

上文很多地方都提到了 Iterator ,現(xiàn)在我們把這個坑填上。
當(dāng)我們對可迭代的概念了解后，對于迭代器就比較好理解了。
一個對象實現(xiàn)了 __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 中，構(gòu)造函數(shù)中定義了一個列表 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
            
          

我們可以發(fā)現(xiàn)上文提到的
集合和序列對象是可迭代的但不是迭代器

            
                  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 循環(huán)中使用，還可以通過內(nèi)置函數(shù) next() 函數(shù)進行調(diào)用。 例如

            
              it = IterObj()
next(it) # 3
next(it) # 5
            
          

0x02 生成器(Generator)

現(xiàn)在我們來看看什么是生成器？
一個生成器既是可迭代的也是迭代器

定義生成器有兩種方式：

1. 列表生成器
2. 使用 yield 定義生成器函數(shù)

先看第1種情況

            
                  g = (x * 2 for x in range(10)) # 0～18的偶數(shù)生成器 
    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
            
          

列表生成器可以不需要消耗大量的內(nèi)存來生成一個巨大的列表，只有在需要數(shù)據(jù)的時候才會進行計算。
再看第2種情況

            
              def gen():
    for i in range(10):
        yield i 
            
          

這里 yield 的作用就相當(dāng)于 return ,這個函數(shù)就是順序地返回 [0,10) 的之間的自然數(shù)，可以通過 next() 或使用 for 循環(huán)來遍歷。
當(dāng)程序遇到 yield 關(guān)鍵字時，這個生成器函數(shù)就返回了，直到再次執(zhí)行了 next() 函數(shù)，它就會從上次函數(shù)返回的執(zhí)行點繼續(xù)執(zhí)行，即 yield 退出時保存了函數(shù)執(zhí)行的位置、變量等信息，再次執(zhí)行時，就從這個 yield 退出的地方繼續(xù)往下執(zhí)行。
在 Python 中利用生成器的這些特點可以實現(xiàn)協(xié)程。協(xié)程可以理解為一個輕量級的線程，它相對于線程處理高并發(fā)場景有很多優(yōu)勢。

看下面一個用協(xié)程實現(xiàn)的 生產(chǎn)者-消費者模型

            
              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)
            
          

這段代碼執(zhí)行效果如下

            
              producer 1
consumer 1 
producer return ok
producer 2
consumer 2 
producer return ok
producer 3
consumer 3 
producer return ok
            
          

協(xié)程實現(xiàn)了 CPU 在兩個函數(shù)之間進行切換從而實現(xiàn)并發(fā)的效果。

0x04 引用

1. https://docs.python.org/3.7/