迭代器模式：一种惰性获取数据项的方式，即按需一次获取一个数据项。

关于迭代器和生成器的区别：

在Python社区中，大多数时候把迭代器和生成器视为同一概念。

如果需要细分的话，那么迭代器用于从集合中取出数据，而生成器用于凭空生成元素。

一、序列

所有序列都是可以迭代的。我们接下来要实现一个 Sentence（句子）类，我们向这个类的构造方法传入包含一些文本的字符串，然后可以逐个单词迭代。

sentence.py

import re
import reprlib

RE_WORD = re.compile('\w+')


class Sentence:
    def __init__(self, text):
        self.text = text
        self.words = RE_WORD.findall(text)  # re.findall 函数返回一个字符串列表

    def __getitem__(self, index):
        return self.words[index]

    def __len__(self):
        return len(self.words)

    def __repr__(self):
        return 'Sentence(%s)' % reprlib.repr(self.text)  # reprlib.repr 函数用于生成大型数据结构的简略字符串表示形式

接下来测试 Sentence 实例能否迭代

In [11]: s = sentence.Sentence("'winter is coming!', he said.")

In [12]: s
Out[12]: Sentence("'winter is c...g!', he said.")

In [13]: for word in s:
    ...:     print(word)
    ...:     
winter
is
coming
he
said

In [14]: list(s)
Out[14]: ['winter', 'is', 'coming', 'he', 'said']

序列可以迭代的原因：

iter()

解释器需要迭代对象 x 时，会自动调用iter(x)。

内置的 iter 函数有以下作用：

1. 检查对象是否实现了__iter__方法，如果实现了就调用他，获取一个迭代器。
2. 如果没有实现__iter__方法，但是实现了__getitem__方法，Python会创建一个迭代器，尝试按顺序（从索引 0 开始）获取元素。
3. 如果尝试失败，Python 抛出 TypeError 异常，通常会提示"XXX object is not iterable"，其中 XXX 是目标对象所属的类。

由于序列都实现了__getitem__方法，所以都可以迭代。

从 Python3.4 开始，检查对象 x 能否迭代，最准确的方式是调用 iter(x)，如果不可迭代，再处理 TypeError 异常，这比使用 isistance(x, abc.Iterable)更准确，因为iter(x)函数会考虑__getitem__方法。

二、可迭代对象与迭代器的对比

可迭代对象：使用内置函数 iter() 可以获取迭代器的对象。

与迭代器的关系：Python 从可迭代对象中获取迭代器。

下面用for循环迭代一个字符串，这里字符串 'abc' 是可迭代的对象，用 for 循环迭代时是有生成器，只是 Python 隐藏了。

In [19]: s = 'abc'

In [20]: for char in s:
    ...:     print(char)
    ...:     
    ...:     
a
b
c

如果没有 for 语句，使用 while 循环模拟，要写成下面这样：

In [21]: s = 'abc'

In [22]: it = iter(s)  # 使用可迭代对象构建迭代器

In [23]: while True:
    ...:     try:
    ...:         print(next(it)) # 在迭代器上不断调用 next() 获取下一个字符
    ...:     except StopIteration: # 如果没有字符了，迭代器会抛出 StopIteration 异常
    ...:         del it # 释放对 it 的引用，即废弃迭代器对象
    ...:         break
    ...:     
a
b
c

Python 内部会处理 for 循环和其他迭代上下文（如列表推导，元组拆包等等）中的 StopIteration 异常。

标准的迭代器接口有两个方法：

__next__：返回下一个可用的元素，如果没有元素了，抛出 StopIteration 异常。

__iter__：返回 self，以便在需要使用可迭代对象的地方使用迭代器，如 for 循环中。

迭代器：实现了无参数的__next__方法，返回序列中的下一个元素；如果没有元素了，那么抛出 StopIteration 异常。Python 中的迭代器还实现了__iter__方法，因此迭代器也可以迭代。

接下来使用迭代器模式实现 Sentence 类：

sentence_iter.py

import re
import reprlib

RE_WORD = re.compile('\w+')



# 可迭代对象类
class Sentence:
    def __init__(self, text):
        self.text = text
        self.words = RE_WORD.findall(text)

    def __repr__(self):
        return 'Sentence(%s)' % reprlib.repr(self.text)

    def __iter__(self):
        # 实例化一个新的迭代器
        return SentenceIterator(self.words)

   
# 迭代器类
class SentenceIterator:
    def __init__(self, words):
        self.words = words
        self.index = 0

    # 实现 __next__ 返回单个元素
    def __next__(self):
        try:
            word = self.words[self.index]
        except IndexError:
            raise StopIteration()
        self.index += 1
        return word
    
    # 实现 __iter__ 返回自身
    def __iter__(self):
        return self

注意，不要在 Sentence 类中实现 __next__ 方法，让 Sentence 实例既是可迭代对象，也是自身的迭代器。

迭代器模式可用来：

• 访问一个聚合对象的内容而无需暴露它的内部表示
• 支持对聚合对象的多种遍历
• 为遍历不同的聚合结构提供一个统一的接口（即支持多台迭代）

为了“支持多种遍历”，必须能从同一个可迭代的实例中获取多个独立的迭代器，而且各个迭代器要能维护自身的内部状态，因此这一模式正确的实现方式是，每次调用 iter(my_iterable) 都新建一个独立的迭代器。

所以总结下来就是：

• 可迭代对象一定不能是自身的迭代器，也就是说，可迭代对象必须实现 __iter__方法，但是不能实现__next__方法
• 迭代器应该一直可以迭代，而且他的__iter__方法应该返回自身。

三、生成器

实现相同功能，但却符合 Python 习惯的方式是，用生成器函数代替 SentenceIteror 类。

sentence_gen.py

import re
import reprlib

RE_WORD = re.compile('\w+')


class Sentence:
    def __init__(self, text):
        self.text = text
        self.words = RE_WORD.findall(text)

    def __repr__(self):
        return 'Sentence(%s)' % reprlib.repr(self.text)
    
    # 是一个生成器函数，调用时会构建一个实现了迭代器接口的生成器对象，因此不用再定义 SentenceIterator类了。
    def __iter__(self):
        for word in self.words:
            yield word

只要 Python 函数的定义体中有 yield 关键字，该函数就是生成器函数。调用生成器函数，就会返回一个生成器对象。

生成器函数会创建一个生成器对象，包装生成器函数的定义体，把生成器传给 next(...) 函数时，生成器函数会向前，执行函数定义体中的下一个 yield 语句，返回产出的值，并在函数定义体的当前位置暂停，。最终，函数的定义体返回时，外层的生成器对象会抛出 StopIteration 异常，这一点与迭代器协议一致。

注意，我说的是产出或生成值。调用生成器函数返回生成器，生成器产出或生成值。生成器不会以常规的方式“返回”值，生成器函数定义体中的 return 语句会触发生成器对象抛出 StopIteration 异常。（Python3.3 之前有 return 语句会报错）

关于 for 循环：

for 循环会隐式的调用 next()，而且在使用 for 循环到生成器函数定义体的末尾时，for 循环会捕获异常，因此循环终止时没有报错。

如今这一版 Sentence 类相较之前简短多了，但是还不够慵懒。惰性，是如今人们认为最好的特质。惰性实现是指尽可能延后生成值，这样做能节省内存，或许还能避免做无用的处理。

四、惰性实现

目前实现的几版 Sentence 类都不具有惰性，因为 __init__方法急迫的构建好了文本中的单词列表，然后将其绑定到 self.words 属性上。这样就得处理整个文本，列表使用的内存量可能与文本本身一样多（或许更多，取决于文本中有多少非单词字符）。

re.finditer 函数是 re.findall函数的惰性版本，返回的是一个生成器，按需生成 re.MatchObject 实例。我们可以使用这个函数来让 Sentence 类变得懒惰，即只在需要时才生成下一个单词。

sentence_gen2.py


import re
import reprlib

RE_WORD = re.compile('\w+')


class Sentence:
    def __init__(self, text):
        self.text = text

    def __repr__(self):
        return "Sentence(%s)" % reprlib.repr(self.text)

    def __iter__(self):
        for match in RE_WORD.finditer(self.text):
            yield match.group() # match.group()方法从 MatchObject 实例中提取匹配正则表达式的具体文本。

五、标准库中的生成器函数

标准库提供了很多生成器函数，有用于逐行迭代纯文本文件的对象，还有出色的 os.walk 函数等等。本节专注于通用的函数：参数为任意的可迭代对象，返回值是生成器，用于生成选中的、计算出的和重新排列的元素。

第一组是用于过滤的生成器函数：从输入的可迭代对象中产出元素的子集，而且不修改元素本身。这种函数大多数都接受一个断言参数(predicate)，这个参数是个布尔函数，有一个参数，会应用到输入中的每个元素上，用于判断元素是否包含在输出中。

以下为这些函数的演示：

>>> def vowel(c):
...     return c.lower() in 'aeiou'
... 
>>> list(filter(vowel, 'Aardvark'))
['A', 'a', 'a']
>>> import itertools
>>> list(itertools.filterfalse(vowel, 'Aardvark'))
['r', 'd', 'v', 'r', 'k']
>>> list(itertools.dropwhile(vowel, 'Aardvark'))
['r', 'd', 'v', 'a', 'r', 'k'] # 不再进一步检查，即相同真值只跳过一次
>>> list(itertools.takewhile(vowel, 'Aardvark'))
['A', 'a'] # 同上，不再进一步检查
>>> list(itertools.compress('Aardvark', (1, 0, 1, 1, 0, 1)))
['A', 'r', 'd', 'a'] # selector_it 是(1, 0, 1, 1, 0, 1)，所以'Aardvark'中位置对应1的生成出来了。
>>> list(itertools.islice('Aardvark', 4))
['A', 'a', 'r', 'd']
>>> list(itertools.islice('Aardvark', 4, 7))
['v', 'a', 'r']
>>> list(itertools.islice('Aardvark', 1, 7, 2))
['a', 'd', 'a']

第二组是用于映射的生成器函数：在输入的单个/多个可迭代对象中的各个元素上做计算，然后返回结果。

以下为这些函数的用法：

>>> sample = [5, 4, 2, 8, 7, 6, 3, 0, 9, 1]
>>> import itertools
>>> list(itertools.accumulate(sample))
[5, 9, 11, 19, 26, 32, 35, 35, 44, 45]
>>> import operator
>>> list(itertools.accumulate(range(1, 11), operator.mul)) # 1! 到 10!的阶乘
[1, 2, 6, 24, 120, 720, 5040, 40320, 362880, 3628800] 
>>> list(map(operator.mul, range(11), range(11)))
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81, 100]
>>> list(map(operator.mul, range(11), [2, 4, 8]))
[0, 4, 16]
>>> list(itertools.starmap(operator.mul, enumerate('albatroz', 1))) # 从 1 开始，根据字母所在位置，把字母重复相应的次数
['a', 'll', 'bbb', 'aaaa', 'ttttt', 'rrrrrr', 'ooooooo', 'zzzzzzzz']

第三组是用于合并的生成器函数，这些函数都可以从输入的多个可迭代对象中产出元素。

以下为演示：

>>> list(itertools.chain('ABC', range(2)))
['A', 'B', 'C', 0, 1]
>>> list(itertools.chain.from_iterable(enumerate('ABC')))
[0, 'A', 1, 'B', 2, 'C']
>>> list(zip('ABC', range(5)))
[('A', 0), ('B', 1), ('C', 2)]
>>> list(itertools.zip_longest('ABC', range(5), fillvalue='?'))
[('A', 0), ('B', 1), ('C', 2), ('?', 3), ('?', 4)]
>>> list(itertools.product('ABC', range(2)))
[('A', 0), ('A', 1), ('B', 0), ('B', 1), ('C', 0), ('C', 1)]

第四组是从一个元素中产出多个值，扩展输入的可迭代对象。

以下为演示：

>>> ct = itertools.count()
>>> next(ct), next(ct), next(ct)
(0, 1, 2)
>>> list(itertools.islice(cy, 7))
['A', 'B', 'C', 'A', 'B', 'C', 'A']
>>> list(itertools.repeat(7, 4))
[7, 7, 7, 7]
>>> list(map(operator.mul, range(11), itertools.repeat(5))) # repeat 常见用途：为 map 函数提供固定参数
[0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50]
>>> list(itertools.combinations('ABC', 2)) # 'ABC'中每两个元素的各种组合，元素顺序无意义，不含相同元素的组合
[('A', 'B'), ('A', 'C'), ('B', 'C')]
>>> list(itertools.combinations_with_replacement('ABC', 2)) # 'ABC'中每两个元素的各种组合，元素顺序无意义，含相同元素的组合
[('A', 'A'), ('A', 'B'), ('A', 'C'), ('B', 'B'), ('B', 'C'), ('C', 'C')]
>>> list(itertools.permutations('ABC',2)) # 'ABC'中每两个元素的各种排列，元素的顺序有意义
[('A', 'B'), ('A', 'C'), ('B', 'A'), ('B', 'C'), ('C', 'A'), ('C', 'B')]

第五组生成器函数用于产出输入的可迭代对象中的全部元素，不过会以某种方式重新排列。

>>> import itertools
>>> list(itertools.groupby('LLLAAAXXXX'))
[('L', <itertools._grouper object at 0x7f467ea946a0>), ('A', <itertools._grouper object at 0x7f467ea946d8>), ('X', <itertools._grouper object at 0x7f467ea94710>)]
>>> for char, group in itertools.groupby('LLLAAAXXXX'):
...     print(char, '->', list(group))
... 
L -> ['L', 'L', 'L']
A -> ['A', 'A', 'A']
X -> ['X', 'X', 'X', 'X']
>>> words = ['x','ss','zzz','dsas','xs']
>>> words.sort(key=len) # 使用 groupby 时需要先进行排序或进行分组
>>> words
['x', 'ss', 'xs', 'zzz', 'dsas']
>>> for length, group in itertools.groupby(words, len):
...     print(length, '->', list(group))
... 
1 -> ['x']
2 -> ['ss', 'xs']
3 -> ['zzz']
4 -> ['dsas']

>>> g1, g2 = itertools.tee('ABC')
>>> next(g1)
'A'
>>> next(g1)
'B'
>>> next(g2)
'A'
>>> list(g2)
['B', 'C']

六、可迭代的归约函数

下面的函数都接受一个可迭代的对象，然后返回单个结果，这种函数叫“归约函数”，“合拢函数”或“累加函数”，其实，这些内置函数都可以用 functools.reduce 函数实现，但内置更加方便，而且还有一些优点。

参考教程：
《流畅的python》 P330 - 363