Python中的迭代器,生成器,模块和包

Posted by JustDoDT on January 4, 2018

1. 迭代

1.1 迭代的简介

如果给定一个list 或者 tuple,我们可以通过for 循环来遍历这个list 或 tuple ,这种遍历我们称为迭代(Iteration)。

在Python中,迭代是通过for … in来完成的,而很多语言比如C语言,迭代list是通过下标完成的,比如Java代码:

for (i=0; i<list.length; i++) {
    n = list[i];
}

可以看出,Python的for循环抽象程度要高于C的for循环,因为Python的for循环不仅可以用在list或tuple上,还可以作用在其他可迭代对象上。

list这种数据类型虽然有下标,但很多其他数据类型是没有下标的,但是,只要是可迭代对象,无论有无下标,都可以迭代,比如dict就可以迭代:

In [1]: d = {'a':1,'b':2,'c':3}

In [2]: for key in d:
   ...:     print(key)
   ...:     
a
b
c

因为dict的存储不是按照list的方式顺序排列,所以,迭代出的结果顺序很可能不一样。

默认情况下,dict迭代的是key。如果要迭代value,可以用for value in d.values(),如果要同时迭代key和value,可以用for k, v in d.items()。

由于字符串也是可迭代对象,因此,也可以作用于for循环:

In [3]: for ch in 'ABC':
   ...:     print(ch)
   ...:     
A
B
C

所以,当我们使用for循环时,只要作用于一个可迭代对象,for循环就可以正常运行,而我们不太关心该对象究竟是list还是其他数据类型。

1.2 判断对象是否可迭代

那么,如何判断一个对象是可迭代对象呢?方法是通过collections模块的Iterable类型判断:

In [5]: from collections import Iterable

In [6]: isinstance('abvc',Iterable)  # str 是否可迭代
Out[6]: True

In [7]: isinstance([1,2,3],Iterable) # list 是否可迭代
Out[7]: True

In [8]: isinstance((1,2,3),Iterable) # tuple 是否可迭代
Out[8]: True

In [9]: isinstance({'a':1,'b':2},Iterable) # dict 是否可迭代
Out[9]: True

In [11]: isinstance(set([1,2,3]),Iterable) # set 是否可迭代
Out[11]: True
    
In [12]: isinstance(123,Iterable) # 整数是否可迭代
Out[12]: False  

1.3 怎么实现Java 那样的下标循环?

Python内置的enumerate函数可以把一个list变成索引-元素对,这样就可以在for循环中同时迭代索引和元素本身:

In [13]: for i, value in enumerate(['a','b','c']):
    ...:     print(i,value)
    ...:     
0 a
1 b
2 c

上面的for循环里,同时引用了两个变量,在Python里是很常见的,比如下面的代码:

In [14]: for x,y in [(1,1),(2,4),(3,9)]:
    ...:     print(x,y)
    ...:     
1 1
2 4
3 9

1.4 习题

请使用迭代查找一个list中最小和最大值,并返回一个tuple:

def findMinAndMax(L):
    if not bool(L):
        return (None,None)
    min = max = L[0]
    for value in L:
        if value > max:
            max = value
        if value < min:
            min = value
    return min,max
print(findMinAndMax([1,2,34,0]))

运行以上代码的结果为:

(0, 34)

1.5 小结

任何可迭代对象都可以作用于for循环,包括我们自定义的数据类型,只要符合迭代条件,就可以使用for循环。

2. 列表生成式

2.1 简介

列表生成式即List Comprehensions,是Python内置的非常简单却强大的可以用来创建list的生成式。

举个例子,要生成list [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]可以用list(range(1, 11)):

In [15]: list(range(1,11))
Out[15]: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

但如果要生成[1x1, 2x2, 3x3, …, 10x10]怎么做?

方法一是循环:

In [20]: L = []

In [21]: for x in range(1,11):
    ...:     L.append(x * x)
    ...:     

In [22]: L
Out[22]: [1, 4, 9, 16, 25, 36, 49, 64, 81, 100]

方法二是列表生成式:

但是循环太繁琐,而列表生成式则可以用一行语句代替循环生成上面的list:

In [24]: [x * x for x in range(1,11)]
Out[24]: [1, 4, 9, 16, 25, 36, 49, 64, 81, 100]

写列表生成式时,把要生成的元素x * x放到前面,后面跟for循环,就可以把list创建出来,十分有用,多写几次,很快就可以熟悉这种语法。

2.2 for循环后面加上if判断

for循环后面还可以加上if判断,这样我们就可以筛选出仅偶数的平方:

In [25]: [x * x for x in range(1,11) if x % 2 ==0]
Out[25]: [4, 16, 36, 64, 100]

2.3 两层for循环

还可以使用两层循环,可以生成全排列:

In [26]: [m + n for m in 'ABC' for n in 'XYZ']
Out[26]: ['AX', 'AY', 'AZ', 'BX', 'BY', 'BZ', 'CX', 'CY', 'CZ']

运用列表生成式,可以写出非常简洁的代码。例如,列出当前目录下的所有文件和目录名,可以通过一行代码实现:

In [1]: import os

In [2]: [d for d in os.listdir(r'/home/pyvip/tmp/pycharm_project_90')]
Out[2]: 
['View.py',
 'function1.py',
 'MultiplicationTable.py',
 '.cache',
 'hahha.py',
 'test.txt',
 '__init__.py',
 'test1.txt',
 '1.py',
 'Class.py',
 '23']

2.4 for循环同时使用两个甚至多个变量

for循环其实可以同时使用两个甚至多个变量,比如dict的items()可以同时迭代key和value:

In [3]: d = {'x':1,'y':2,'z':3}

In [4]: for key ,value in d.items():
   ...:     print(key,'=',value)
   ...:     
x = 1
y = 2
z = 3

因此,列表生成式也可以使用两个变量来生成list:

In [9]: d = {'x':'1','y':'2','z':'3'}

In [10]: [key + '=' + value for key,value in d.items()]
Out[10]: ['x=1', 'y=2', 'z=3']

最后把一个list中所有的字符串变成小写:

In [11]: L = ['Hello','World','China','Python']

In [12]: [s.lower() for s in L]
Out[12]: ['hello', 'world', 'china', 'python']

2.5 练习

如果list中既包含字符串,又包含整数,由于非字符串类型没有lower()方法,所以列表生成式会报错:

In [13]: L = ['Hello','World','China','Python',20,None]

In [14]: [s.lower() for s in L]
---------------------------------------------------------------------------
AttributeError                            Traceback (most recent call last)
<ipython-input-14-daa7212a8c07> in <module>()
----> 1 [s.lower() for s in L]

<ipython-input-14-daa7212a8c07> in <listcomp>(.0)
----> 1 [s.lower() for s in L]

AttributeError: 'int' object has no attribute 'lower'

可以使用内建的isinstance函数可以判断一个变量是不是字符串:

In [20]: L = ['Hello','World','China','Python',20,None]

In [21]: [s.lower() for s in L if isinstance(s,str)]
Out[21]: ['hello', 'world', 'china', 'python']

2.6 小结

运用列表生成式,可以快速生成list,可以通过一个list推导出另一个list,而代码却十分简洁。

3. 生成器

通过列表生成式,我们可以直接创建一个列表。但是,受到内存限制,列表容量肯定是有限的。而且,创建一个包含100万个元素的列表,不仅占用很大的存储空间,如果我们仅仅需要访问前面几个元素,那后面绝大多数元素占用的空间都白白浪费了。

所以,如果列表元素可以按照某种算法推算出来,那我们是否可以在循环的过程中不断推算出后续的元素呢?这样就不必创建完整的list,从而节省大量的空间。在Python中,这种一边循环一边计算的机制,称为生成器:generator。

3.1 创建生成器的方法

方法一:

要创建一个generator,有很多种方法。第一种方法很简单,只要把一个列表生成式的[]改成(),就创建了一个generator:

In [22]: L = [x * x for x in range(10)]

In [23]: L
Out[23]: [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]

In [24]: g = (x * x for x in range(10))

In [25]: g
Out[25]: <generator object <genexpr> at 0x7fbb04448518>

创建L和g的区别仅在于最外层的[]和(),L是一个list,而g是一个generator。

我们可以直接打印出list的每一个元素,但我们怎么打印出generator的每一个元素呢?

如果要一个一个打印出来,可以通过next()函数获得generator的下一个返回值:

In [26]: next(g)
Out[26]: 0

In [27]: next(g)
Out[27]: 1

In [28]: next(g)
Out[28]: 4

In [29]: next(g)
Out[29]: 9

In [30]: next(g)
Out[30]: 16

In [31]: next(g)
Out[31]: 25

In [32]: next(g)
Out[32]: 36

In [33]: next(g)
Out[33]: 49

In [34]: next(g)
Out[34]: 64

In [35]: next(g)
Out[35]: 81

In [36]: next(g)
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-36-e734f8aca5ac> in <module>()
----> 1 next(g)

StopIteration: 

前面讲过,generator保存的是算法,每次调用next(g),就计算出g的下一个元素的值,直到计算到最后一个元素,没有更多的元素时,抛出StopIteration的错误。

当然,上面这种不断调用next(g)实在是太变态了,正确的方法是使用for循环,因为generator也是可迭代对象:

In [37]: g = (x * x for x in range(10))

In [38]: for n in g:
    ...:     print(n)
    ...:     
0
1
4
9
16
25
36
49
64
81

因此,我们创建了一个generator后,基本上永远不会调用next(),而是通过for循环来迭代它,并且不需要关心StopIteration的错误。

generator非常强大。如果推算的算法比较复杂,用类似列表生成式的for循环无法实现的时候,还可以用函数来实现。

比如,著名的斐波拉契数列(Fibonacci),除第一个和第二个数外,任意一个数都可由前两个数相加得到:

1, 1, 2, 3, 5, 8, 13, 21, 34, …

斐波拉契数列用列表生成式写不出来,但是,用函数把它打印出来却很容易:

def fib(max):
    n,a,b = 0 ,0, 1
    while n < max:
        print(b)
        a, b = b,a+b
        n += 1
    return 'done'

注意:赋值语句

a, b = b,a+b
# 相当于
t = (b, a + b) # t是一个tuple
a = t[0]
b = t[1]
#但不必显式写出临时变量t就可以赋值。

上面的函数可以输出斐波那契数列的前N个数:

In [43]: fib(6)
1
1
2
3
5
8
Out[43]: 'done'

仔细观察,可以看出,fib函数实际上是定义了斐波拉契数列的推算规则,可以从第一个元素开始,推算出后续任意的元素,这种逻辑其实非常类似generator。

方法二:

也就是说,上面的函数和generator仅一步之遥。要把fib函数变成generator,只需要把print(b)改为yield b就可以了:

 def fib(max):
    ...:     n,a,b = 0 ,0, 1
    ...:     while n < max:
    ...:          yield b
    ...:          a, b = b,a+b
    ...:          n += 1
    ...:     return 'done'
    ...: 
    ...: 

这就是定义generator的另一种方法。如果一个函数定义中包含yield关键字,那么这个函数就不再是一个普通函数,而是一个generator:

In [45]: fib(6)
Out[45]: <generator object fib at 0x7fbb049797d8>

这里,最难理解的就是generator和函数的执行流程不一样。函数是顺序执行,遇到return语句或者最后一行函数语句就返回。而变成generator的函数,在每次调用next()的时候执行,遇到yield语句返回,再次执行时从上次返回的yield语句处继续执行。

举个简单的例子,定义一个generator,依次返回数字1,3,5:

def odd():
    ...:     print('step 1')
    ...:     yield 1
    ...:     print('step 2')
    ...:     yield 3
    ...:     print('step 3')
    ...:     yield 5

调用该generator时,首先要生成一个generator对象,然后用next()函数不断获得下一个返回值:

In [47]: o = odd()

In [48]: next(o)
step 1
Out[48]: 1

In [49]: next(o)
step 2
Out[49]: 3

In [50]: next(o)
step 3
Out[50]: 5

In [51]: next(o)
---------------------------------------------------------------------------
StopIteration                             Traceback (most recent call last)
<ipython-input-51-ac94be31f4f2> in <module>()
----> 1 next(o)

StopIteration: 

可以看到,odd不是普通函数,而是generator,在执行过程中,遇到yield就中断,下次又继续执行。执行3次yield后,已经没有yield可以执行了,所以,第4次调用next(o)就报错。

回到fib的例子,我们在循环过程中不断调用yield,就会不断中断。当然要给循环设置一个条件来退出循环,不然就会产生一个无限数列出来。

同样的,把函数改成generator后,我们基本上从来不会用next()来获取下一个返回值,而是直接使用for循环来迭代:

In [52]: for n in fib(6):
    ...:     print(n)
    ...:     
1
1
2
3
5
8

但是用for循环调用generator时,发现拿不到generator的return语句的返回值。如果想要拿到返回值,必须捕获StopIteration错误,返回值包含在StopIteration的value中:

In [55]: g = fib(6)

In [56]: while True:
    ...:     try:
    ...:         x = next(g)
    ...:         print('g:',x)
    ...:     except StopIteration as e:
    ...:         print('Generator return value:',e.value)
    ...:         break
    ...:     
g: 1
g: 1
g: 2
g: 3
g: 5
g: 8
Generator return value: done

3.2 练习

杨辉三角定义如下:

把每一行看做一个list,试写一个generator,不断输出下一行的list:

In [64]: def triangles(n):
    ...:     N = [1]
    ...:     while True:
    ...:         yield N
    ...:         N = [1] + [N[i] + N[i + 1] for i in range(len(N) - 1)] + [1]
    ...:         if len(N) > n:
    ...:             break
    ...:            

调用上面的函数,并执行结果

In [65]: m = triangles(6)

In [66]: for i in m:
    ...:     print(i)
    ...:     
[1]
[1, 1]
[1, 2, 1]
[1, 3, 3, 1]
[1, 4, 6, 4, 1]
[1, 5, 10, 10, 5, 1]

3.3 小结

generation 是非常强大的工具,在Python中,可以简单地把列表生成式generation,也可以通过函数实现复杂逻辑的generator。

要理解generator的工作原理,它是在for循环的过程中不断计算出下一个元素,并在适当的条件结束for循环。对于函数改成的generator来说,遇到return语句或者执行到函数体最后一行语句,就是结束generator的指令,for循环随之结束。

请注意区分普通函数和generator函数,普通函数调用直接返回结果:

In [78]: a = abs(6)

In [79]: a
Out[79]: 6

generator函数的“调用”实际返回一个generator对象:

In [80]: g = fib(6)

In [81]: g
Out[81]: <generator object fib at 0x7fbb048c5ca8>

4. 迭代器

4.1 简介

我们已经知道,可以直接作用于for循环的数据类型有以下几种:

一类是集合数据类型,如list、tuple、dict、set、str等;

一类是generator,包括生成器和带yield的generator function。

这些可以直接作用于for循环的对象统称为可迭代对象:Iterable。

可以使用isinstance()判断一个对象是否是Iterable对象:

In [83]: from collections import Iterable

In [84]: isinstance([],Iterable)
Out[84]: True

In [85]: isinstance({},Iterable)
Out[85]: True

In [86]: isinstance('abc',Iterable)
Out[86]: True

In [87]: isinstance((i for i in range(10)),Iterable)
Out[87]: True

In [88]: isinstance(123,Iterable)
Out[88]: False

而生成器不但可以作用于for循环,还可以被next()函数不断调用并返回下一个值,直到最后抛出StopIteration错误表示无法继续返回下一个值了。

可以被next()函数调用并不断返回下一个值的对象称为迭代器:Iterator。

可以使用isinstance()判断一个对象是否是Iterator对象:

In [91]: from collections import Iterator

In [92]: isinstance((x for x in range(10)),Iterator)
Out[92]: True

In [93]: isinstance((),Iterator)
Out[93]: False

In [94]: isinstance([],Iterator)
Out[94]: False

In [95]: isinstance({},Iterator)
Out[95]: False

In [96]: isinstance('abc',Iterator)
Out[96]: False

生成器都是Iterator对象,但list、dict、str虽然是Iterable,却不是Iterator。

把list、dict、str等Iterable变成Iterator可以使用iter()函数:

In [97]: isinstance(iter(()),Iterator)
Out[97]: True

In [98]: isinstance(iter([]),Iterator)
Out[98]: True

In [99]: isinstance(iter({}),Iterator)
Out[99]: True

In [100]: isinstance(iter('abc'),Iterator)
Out[100]: True

为什么list、dict、str等数据类型不是Iterator?

这是因为Python的Iterator对象表示的是一个数据流,Iterator对象可以被next()函数调用并不断返回下一个数据,直到没有数据时抛出StopIteration错误。可以把这个数据流看做是一个有序序列,但我们却不能提前知道序列的长度,只能不断通过next()函数实现按需计算下一个数据,所以Iterator的计算是惰性的,只有在需要返回下一个数据时它才会计算。

Iterator甚至可以表示一个无限大的数据流,例如全体自然数。而使用list是永远不可能存储全体自然数的。

4.2 小结

凡是可作用于for循环的对象都是Iterable类型;

凡是可作用于next()函数的对象都是Iterator类型,它们表示一个惰性计算的序列;

集合数据类型如list、dict、str等是Iterable但不是Iterator,不过可以通过iter()函数获得一个Iterator对象。

Python的for循环本质上就是通过不断调用next()函数实现的,例如:

for x in [1, 2, 3, 4, 5]:
    pass

实际上完全等价于:

# 首先获得Iterator对象:
it = iter([1, 2, 3, 4, 5])
# 循环:
while True:
    try:
        # 获得下一个值:
        x = next(it)
    except StopIteration:
        # 遇到StopIteration就退出循环
        break