一文搞懂Python可迭代、迭代器和生成器的概念

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

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

0x00 可迭代(Iterable)

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

例如

class IterObj:

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

上面定義了一個(gè)類IterObj并實(shí)現(xiàn)了__iter__()方法，這個(gè)就是一個(gè)可迭代(Iterable)對(duì)象

    it = IterObj()
    print(isinstance(it, Iterable))  # true
    print(isinstance(it, Iterator))  # false
    print(isinstance(it, Generator)) # false

記住這個(gè)類，下文我們還會(huì)看到這個(gè)類的定義。

常見的可迭代對(duì)象

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

1. 集合或序列類型（如list、tuple、set、dict、str）
2. 文件對(duì)象
3. 在類中定義了__iter__()方法的對(duì)象，可以被認(rèn)為是 Iterable對(duì)象，但自定義的可迭代對(duì)象要能在for循環(huán)中正確使用，就需要保證__iter__()實(shí)現(xiàn)必須是正確的（即可以通過內(nèi)置iter()函數(shù)轉(zhuǎn)成Iterator對(duì)象。關(guān)于Iterator下文還會(huì)說明，這里留下一個(gè)坑，只是記住iter()函數(shù)是能夠?qū)⒁粋€(gè)可迭代對(duì)象轉(zhuǎn)成迭代器對(duì)象，然后在for中使用）
4. 在類中實(shí)現(xiàn)了如果只實(shí)現(xiàn)__getitem__()的對(duì)象可以通過iter()函數(shù)轉(zhuǎn)化成迭代器但其本身不是可迭代對(duì)象。所以當(dāng)一個(gè)對(duì)象能夠在for循環(huán)中運(yùn)行，但不一定是Iterable對(duì)象。

關(guān)于第1、2點(diǎn)我們可以通過以下來驗(yàn)證

    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點(diǎn)，

    print(hasattr([], "__iter__")) # true
    print(hasattr({}, "__iter__")) # true
    print(hasattr((), "__iter__")) # true
    print(hasattr('', "__iter__")) # true

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

    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>

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

class IterObj:

    def __iter__(self):
        return self 

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

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

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'

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

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

class IterObj:

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

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

我們在構(gòu)造方法中定義了一個(gè)名為a的列表，然后還實(shí)現(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)) # <list_iterator object at 0x102007278>
    for i in it:
        print(i) # 將打印3、5、7、11、13、17、19元素

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

關(guān)于第4點(diǎn)說明的意思是iter()函數(shù)可以將一個(gè)實(shí)現(xiàn)了__getitem__()方法的對(duì)象轉(zhuǎn)成迭代器對(duì)象，也可以在for循環(huán)中使用，但是如果用isinstance()方法來檢測時(shí)，它不是一個(gè)可迭代對(duì)象。

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) # 將打印出3、5、7、11、13、17、19

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

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

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

0x01 迭代器(Iterator)

上文很多地方都提到了Iterator,現(xiàn)在我們把這個(gè)坑填上。
當(dāng)我們對(duì)可迭代的概念了解后，對(duì)于迭代器就比較好理解了。
一個(gè)對(duì)象實(shí)現(xiàn)了__iter__()和__next__()方法，那么它就是一個(gè)迭代器對(duì)象。 例如

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ù)中定義了一個(gè)列表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)上文提到的
集合和序列對(duì)象是可迭代的但不是迭代器

    print(isinstance([], Iterator)) # false
    print(isinstance({}, Iterator)) # false
    print(isinstance((), Iterator)) # false
    print(isinstance(set(), Iterator)) # false
    print(isinstance('', Iterator)) # false

而文件對(duì)象是迭代器

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

一個(gè)迭代器(Iterator)對(duì)象不僅可以在for循環(huán)中使用，還可以通過內(nèi)置函數(shù)next()函數(shù)進(jìn)行調(diào)用。 例如

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

0x02 生成器(Generator)

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

定義生成器有兩種方式：

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)存來生成一個(gè)巨大的列表，只有在需要數(shù)據(jù)的時(shí)候才會(huì)進(jìn)行計(jì)算。
再看第2種情況

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

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

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

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)  # 啟動(dòng)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é)程實(shí)現(xiàn)了CPU在兩個(gè)函數(shù)之間進(jìn)行切換從而實(shí)現(xiàn)并發(fā)的效果。

0x04 引用

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