Python学习记录——8.列表生成式，迭代器，生成器，装饰器

文章目录

• ​​1.列表生成式​​
• ​​2.迭代器​​
• ​​3.生成器​​
• ​​4.装饰器​​

1.列表生成式

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

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

>>> list(range(1, 11))
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

但如果要生成​​[1x1, 2x2, 3x3, ..., 10x10]​​怎么做？方法一是循环：

>>> L = []
>>> for x in range(1, 11):
...    L.append(x * x)
...
>>> L
[1, 4, 9, 16, 25, 36, 49, 64, 81, 100]

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

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

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

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

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

还可以使用两层循环，可以生成全排列：

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

三层和三层以上的循环就很少用到了。

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

>>> import os # 导入os模块，模块的概念后面讲到
>>> [d for d in os.listdir('.')] # os.listdir可以列出文件和目录
['.emacs.d', '.ssh', '.Trash', 'Adlm', 'Applications', 'Desktop', 'Documents', 'Downloads', 'Library', 'Movies', 'Music', 'Pictures', 'Public', 'VirtualBox VMs', 'Workspace', 'XCode']

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

>>> d = {'x': 'A', 'y': 'B', 'z': 'C' }
>>> for k, v in d.items():
...     print(k, '=', v)
...
y = B
x = A
z =

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

>>> d = {'x': 'A', 'y': 'B', 'z': 'C' }
>>> [k + '=' + v for k, v in d.items()]
['y=B', 'x=A', 'z=C']

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

>>> L = ['Hello', 'World', 'IBM', 'Apple']
>>> [s.lower() for s in L]
['hello', 'world', 'ibm', 'apple']

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

2.迭代器

可以直接作用于​​for​​循环的数据类型有以下几种：

一类是集合数据类型，如​​list​​​、​​tuple​​​、​​dict​​​、​​set​​​、​​str​​等；

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

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

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

>>> from collections import Iterable
>>> isinstance([], Iterable)
True
>>> isinstance({}, Iterable)
True
>>> isinstance('abc', Iterable)
True
>>> isinstance((x for x in range(10)), Iterable)
True
>>> isinstance(100, Iterable)
False

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

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

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

>>> from collections import Iterator
>>> isinstance((x for x in range(10)), Iterator)
True
>>> isinstance([], Iterator)
False
>>> isinstance({}, Iterator)
False
>>> isinstance('abc', Iterator)
False

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

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

>>> isinstance(iter([]), Iterator)
True
>>> isinstance(iter('abc'), Iterator)
True

你可能会问，为什么​​list​​​、​​dict​​​、​​str​​​等数据类型不是​​Iterator​​？

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

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

总结

凡是可作用于​​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

3.生成器

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

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

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

>>> L = [x * x for x in range(10)]
>>> L
[0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
>>> g = (x * x for x in range(10))
>>> g
<generator object <genexpr> at 0x1022ef630>

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

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

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

>>> next(g)
0
>>> next(g)
1
>>> next(g)
4
>>> next(g)
9
>>> next(g)
16
>>> next(g)
25
>>> next(g)
36
>>> next(g)
49
>>> next(g)
64
>>> next(g)
81
>>> next(g)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>

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

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

>>> g = (x * x for x in range(10))
>>> 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 = n + 1
    return 'done'

注意，赋值语句：

a, b = b, a +

相当于：

t = (b, a + b) # t是一个tuple
a = t[0]
b = t[1]

但不必显式写出临时变量t就可以赋值。

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

>>> fib(6)
1
1
2
3
5
8
'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 = n + 1
    return 'done'

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

>>> f = fib(6)
>>> f
<generator object fib at 0x104feaaa0>

这里，最难理解的就是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()​​函数不断获得下一个返回值：

>>> o = odd()
>>> next(o)
step 1
1
>>> next(o)
step 2
3
>>> next(o)
step 3
5
>>> next(o)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>

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

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

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

>>> for n in fib(6):
...     print(n)
...
1
1
2
3
5
8

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

>>> g = fib(6)
>>> 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:

总结

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

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

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

>>> r = abs(6)
>>> r
6

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

>>> g = fib(6)
>>> g
<generator object fib at 0x1022ef948>

4.装饰器

由于函数也是一个对象，而且函数对象可以被赋值给变量，所以，通过变量也能调用该函数。

>>> def now():
...     print('2015-3-25')
...
>>> f = now
>>> f()
2015-3-25

函数对象有一个​​__name__​​属性，可以拿到函数的名字：

>>> now.__name__
'now'
>>> f.__name__
'now'

现在，假设我们要增强​​now()​​​函数的功能，比如，在函数调用前后自动打印日志，但又不希望修改​​now()​​函数的定义，这种在代码运行期间动态增加功能的方式，称之为“装饰器”（Decorator）。

本质上，decorator就是一个返回函数的高阶函数。所以，我们要定义一个能打印日志的decorator，可以定义如下：

def log(func):
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return

观察上面的​​log​​，因为它是一个decorator，所以接受一个函数作为参数，并返回一个函数。我们要借助Python的@语法，把decorator置于函数的定义处：

@log
def now():
    print('2015-3-25')

调用​​now()​​​函数，不仅会运行​​now()​​​函数本身，还会在运行​​now()​​函数前打印一行日志：

>>> now()
call now():
2015-3-25

把​​@log​​​放到​​now()​​函数的定义处，相当于执行了语句：

now = log(now)

由于​​log()​​​是一个decorator，返回一个函数，所以，原来的​​now()​​​函数仍然存在，只是现在同名的​​now​​​变量指向了新的函数，于是调用​​now()​​​将执行新函数，即在​​log()​​​函数中返回的​​wrapper()​​函数。

​​wrapper()​​​函数的参数定义是​​(*args, **kw)​​​，因此，​​wrapper()​​​函数可以接受任意参数的调用。在​​wrapper()​​函数内，首先打印日志，再紧接着调用原始函数。

如果decorator本身需要传入参数，那就需要编写一个返回decorator的高阶函数，写出来会更复杂。比如，要自定义log的文本：

def log(text):
    def decorator(func):
        def wrapper(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper
    return

这个3层嵌套的decorator用法如下：

@log('execute')
def now():
    print('2015-3-25')

执行结果如下：

>>> now()
execute now():
2015-3-25

和两层嵌套的decorator相比，3层嵌套的效果是这样的：

>>> now = log('execute')(now)

我们来剖析上面的语句，首先执行​​log('execute')​​​，返回的是​​decorator​​​函数，再调用返回的函数，参数是​​now​​​函数，返回值最终是​​wrapper​​函数。

以上两种decorator的定义都没有问题，但还差最后一步。因为我们讲了函数也是对象，它有​​__name__​​​等属性，但你去看经过decorator装饰之后的函数，它们的​​__name__​​​已经从原来的​​'now'​​​变成了​​'wrapper'​​：

>>> now.__name__
'wrapper'

因为返回的那个​​wrapper()​​​函数名字就是​​'wrapper'​​​，所以，需要把原始函数的​​__name__​​​等属性复制到​​wrapper()​​函数中，否则，有些依赖函数签名的代码执行就会出错。

不需要编写​​wrapper.__name__ = func.__name__​​​这样的代码，Python内置的​​functools.wraps​​就是干这个事的，所以，一个完整的decorator的写法如下：

import functools

def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
        print('call %s():' % func.__name__)
        return func(*args, **kw)
    return

或者针对带参数的decorator：

import functools

def log(text):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print('%s %s():' % (text, func.__name__))
            return func(*args, **kw)
        return wrapper
    return

​​import functools​​​是导入​​functools​​​模块。模块的概念稍候讲解。现在，只需记住在定义​​wrapper()​​​的前面加上​​@functools.wraps(func)​​即可。

总结

在面向对象（OOP）的设计模式中，decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现，而Python除了能支持OOP的decorator外，直接从语法层次支持decorator。Python的decorator可以用函数实现，也可以用类实现。

decorator可以增强函数的功能，定义起来虽然有点复杂，但使用起来非常灵活和方便。

请编写一个decorator，能在函数调用的前后打印出​​'begin call'​​​和​​'end call'​​的日志。

再思考一下能否写出一个​​@log​​的decorator，使它既支持：

@log
def f():
    pass

又支持：

@log('execute')
def f():
    pass