Python itertools模块：生成迭代器（案例分析）

itertools模块主要包含一些生成迭代器的函数。首先在Python交互式解释器中导入itertools模块，然后输入[e for e in dir(itertools) if not e.startswith('_')]命令，可以看到模块中包含的所有属性和函数：

>>> [e for e in dir(itertools) if not e.startswith('_')]
['accumulate', 'chain', 'combinations', 'combinations_with_replacement', 'compress', 'count', 'cycle', 
'dropwhile', 'filterfalse', 'groupby', 'islice', 'permutations', 'product', 'repeat', 'starmap', 'takewhile',
 'tee', 'zip_longest']

从上面的输出可以看出，itertools模块中的很多函数都可以用来生成迭代器。

先看 itertools 模块中三个生成迭代器的函数：

count(start, [step])：生成start的迭代器，start+step，start+2*step，...，其中step默认为1。例如count(10)生成的迭代器包含：10， 11、12、13、14、……

cycle(p)：为循环p0,p1,...,p0,p1,...的序列p生成一个迭代器。例如cycle('ABCD')生成的迭代器包含：A,B,C ,D,A,B,C,D,....

repeat(elem [,n])：生成一个重复elem元素的迭代器。如果指定了参数 n，则只会生成 n 个 elem 元素。例如repeat(10, 3)生成的生成器包含：10,10,10。

下面的程序演示了使用以上三个函数生成迭代器：

import itertools as it
# count(10, 3)生成10、13、16……迭代器
for e in it.count(10, 3):
    print(e)
    # 用于跳出循环
    if e > 20:
        break
print('---------')
my_counter = 0
# cycle用于对序列生成循环的迭代器
for e in it.cycle(['Python', 'Kotlin', 'Swift']):
    print(e)
    # 用于跳出循环
    my_counter += 1
    if my_counter > 7:
        break
print('---------')
# repeat用于生成n个元素重复的迭代器
for e in it.repeat('Python', 3):
    print(e)

itertools模块中也有一些常用的迭代器函数，如下：

accumulate(p[,func])：默认生成一个迭代器，按照序列p个元素累加，p0,p0+p1,p0+p1+p2,...序列，如果指定func函数，使用func 函数计算一个元素的值。

chain(p, q, ...)：将多个序列里的元素“链”在一起生成新的序列。

compress(data, selectors)：根据选择器序列的值过滤数据序列的元素。如果selector[0]为真，则保留data[0]；如果 selector[1] 为真，则保留 data[1]...等等。

dropwhile(pred, seq)：使用pred函数过滤seq序列，从seq中第一个被pred函数判断为False的元素开始，保留从该元素开始到序列末尾的所有元素。

takewhile(pred, seq)：这个函数和前面的函数正好相反。使用pred函数过滤seq序列，从seq中第一个使用pred函数求值为False的元素开始，移除从该元素开始到序列末尾的所有元素。

filterfalse(pred, seq)：使用pred函数过滤seq序列，保留seq中使用pred求值为True的元素。例如 filterfalse(lambda x:x%2, range(10)) 得到 0, 2, 4, 6, 8。

islice(seq, [start,] stop [, step])：它的作用类似于sequence的slice方法，其实就是返回seq[start:stop:step]的结果。

starmap(func, seq)：使用func计算seq序列的每一个元素，并将计算结果作为新的序列元素。使用 func 计算序列元素时，支持序列解包。例如seq序列的元素长度为3，那么func可以是一个接收三个参数的函数，该函数会根据这三个参数计算出新序列的元素。

zip_longest(p,q,...)：将序列p、q等中的元素按索引合并成元组，这些元组将作为新序列的元素。

上面这些函数的测试程序如下：

import itertools as it
# 默认使用累加的方式计算下一个元素的值
for e in it.accumulate(range(6)):
    print(e, end=', ') # 0, 1, 3, 6, 10, 15
print('\n---------')
# 使用x*y的方式来计算迭代器下一个元素的值
for e in it.accumulate(range(1, 6), lambda x, y: x * y):
    print(e, end=', ') # 1, 2, 6, 24, 120
print('\n---------')
# 将两个序列“链”在一起，生成新的迭代器
for e in it.chain(['a', 'b'], ['Kotlin', 'Swift']):
    print(e, end=', ') # 'a', 'b', 'Kotlin', 'Swift'
print('\n---------')
# 根据第二个序列来筛选第一个序列的元素，
# 由于第二个序列只有中间两个元素为1（True），因此前一个序列只保留中间两个元素
for e in it.compress(['a', 'b', 'Kotlin', 'Swift'], [0, 1, 1, 0]):
    print(e, end=', ') # 只有: 'b', 'Kotlin'
print('\n---------')
# 获取序列中从长度不小于4的元素开始、到结束的所有元素
for e in it.dropwhile(lambda x:len(x)<4, ['a', 'b', 'Kotlin', 'x', 'y']):
    print(e, end=', ') # 只有: 'Kotlin', 'x', 'y'
print('\n---------')
# 去掉序列中从长度不小于4的元素开始、到结束的所有元素
for e in it.takewhile(lambda x:len(x)<4, ['a', 'b', 'Kotlin', 'x', 'y']):
    print(e, end=', ')  # 只有: 'a', 'b'
print('\n---------')
# 只保留序列中从长度不小于4的元素
for e in it.filterfalse(lambda x:len(x)<4, ['a', 'b', 'Kotlin', 'x', 'y']):
    print(e, end=', ') # 只有: 'Kotlin'
print('\n---------')
# 使用pow函数对原序列的元素进行计算，将计算结果作为新序列的元素
for e in it.starmap(pow, [(2,5), (3,2), (10,3)]):
    print(e, end=', ') # 32, 9, 1000
print('\n---------')
# 将'ABCD'、'xy'的元素按索引合并成元组，这些元组作为新序列的元素
# 长度不够的序列元素使用'-'字符代替
for e in it.zip_longest('ABCD', 'xy', fillvalue='-'):
    print(e, end=', ') # ('A', 'x'), ('B', 'y'), ('C', '-'), ('D', '-')

运行上面程序，可以看到如下输出结果：

0, 1, 3, 6, 10, 15,
---------
1, 2, 6, 24, 120,
---------
a, b, Kotlin, Swift,
---------
b, Kotlin,
---------
Kotlin, x, y,
---------
a, b,
---------
Kotlin,
---------
32, 9, 1000,
---------
('A', 'x'), ('B', 'y'), ('C', '-'), ('D', '-'),

在 itertools 模块中还有一些用于生成排列的实用函数：

product(p, q, ...[repeat= 1)]：对序列p, q, ...中的元素进行排列组合，相当于使用嵌套循环组合。

permutations(p[, r])：从序列p中取r个元素组成一个全排列，并将排列得到的元组作为新迭代器的元素。

combinations(p, r)：从序列p中取r个元素组成一个全组合。元素不允许重复，组合得到的元组作为新迭代器的元素。

combinations with_replacement(p, r)，从序列p中取r个元素组成一个全组合，元素允许重复，将组合后的元组作为新迭代器的元素。

如下程序示范了上面 4 个函数的用法：

import itertools as it
# 使用两个序列进行排列组合
for e in it.product('AB', 'CD'):
    print(''.join(e), end=', ') # AC, AD, BC, BD,
print('\n---------')
# 使用一个序列、重复2次进行全排列
for e in it.product('AB', repeat=2):
    print(''.join(e), end=', ') # AA, AB, BA, BB,
print('\n---------')
# 从序列中取2个元素进行排列
for e in it.permutations('ABCD', 2):
    print(''.join(e), end=', ') # AB, AC, AD, BA, BC, BD, CA, CB, CD, DA, DB, DC,
print('\n---------')
# 从序列中取2个元素进行组合、元素不允许重复
for e in it.combinations('ABCD', 2):
    print(''.join(e), end=', ') # AB, AC, AD, BC, BD, CD,
print('\n---------')
# 从序列中取2个元素进行组合、元素允许重复
for e in it.combinations_with_replacement('ABCD', 2):
    print(''.join(e), end=', ') # AA, AB, AC, AD, BB, BC, BD, CC, CD, DD,

上面的程序使用了字符串的join()方法，用于将元组的所有元素连接成一个字符串。运行程序，可以看到如下输出：

AC, AD, BC, BD,
---------
AA, AB, BA, BB,
---------
AB, AC, AD, BA, BC, BD, CA, CB, CD, DA, DB, DC,
---------
AB, AC, AD, BC, BD, CD,
---------
AA, AB, AC, AD, BB, BC, BD, CC, CD, DD,