获取更多文章和更新,请关注我的个人主页:www.leiting6.cn

1 对函数添加装饰器的理解

以廖老师这一节教程后面多层嵌套的代码做例子,中间添加了一些print打印信息帮助理解代码走向,最后today()调用的地方先注释起来

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
def logger(text):
print("--- 进入logger() ---")
def decorator(func):
print("--- 进入decorator() ---")
def wrapper(*args, **kw):
print("--- 进入wrapper() ---")
print('%s %s()' % (text, func.__name__))
return func(*args, **kw)
return wrapper
return decorator

@logger('下面执行: ')
def today():
print("--- 进入today() ---")
print('>> 2015-3-25')

print("today()函数的名字是: " + today.__name__)
#today()

保存上述代码为.py文件并在命令行中执行它,可以看到结果为:

1
2
3
4
D:\Python\test>python 7.py
--- 进入logger() ---
--- 进入decorator() ---
today()函数的名字是: wrapper

稍作分析一下:

  • 装饰器@logger放在today()定义处,即相当于执行了:

    1
    today = logger('下面执行: ')(today)
  • 首先执行(但不完全等价于执行)

    1
    logger('下面执行: ')

对照代码和打印信息,可以看到,程序进入logger()函数,传入字符串”下面执行: “,并在函数末尾返回decorator()函数。

  • 然后执行(但不完全等价于执行)
    1
    today = decorator(today)

依旧对照代码和打印信息可以看到,程序进入decorator()函数,传入上面的字符串以及today()函数共同作为参数,最后返回wrapper()函数赋值给today,此时,today函数已经改变,因为today的name属性值已经变成了wrapper了。

接下来去掉代码最后一样的注释,执行一下,结果为:

1
2
3
4
5
6
7
8
D:\Python\test>python 7.py
--- 进入logger() ---
--- 进入decorator() ---
today()函数的名字是: wrapper
--- 进入wrapper() ---
下面执行: today()
--- 进入today() ---
>> 2015-3-25

再来分析一下…

  • 之前学习过返回函数我们知道,只将wrapper()函数赋值到today,wrapper()函数是不会执行的,只有调用了赋值后的today()函数,它才会执行;

  • 比起加了注释,这一次更进一步,程序进入到wrapper()函数,先执行wrapper()函数本身的内容,就是现实下面即将执行的函数的名字,需要注意的是,这里直接调用形参func的.name属性值,而func还是最初传入的today()函数,所以它的函数名还是today;

  • 执行完了wrapper()函数本身的功能之后,再执行原始函数,即today()函数(看了很多遍廖老师的教程,其实也没找到代码中有调用原始函数的痕迹,暂且这么理解了,应该没错,当然这也是教程中的原话),打印出当前的日期,程序结束。

2 name属性改变

从打印信息看得出来,today()函数添加装饰器之后,其name属性已经发生变化,从today变成了wrapper,怎么让他变回去呢?其实也很简单,手动改变一下重新赋值就好,这里需要引入functools模块。稍改一下代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
import functools

def logger(text):
print("--- 进入logger() ---")
def decorator(func):
print("--- 进入decorator() ---")
@functools.wraps(func)
def wrapper(*args, **kw):
print("--- 进入wrapper() ---")
print('%s %s()' % (text, func.__name__))
return func(*args, **kw)
return wrapper
return decorator

@logger('下面执行: ')
def today():
print("--- 进入today() ---")
print('>> 2015-3-25')

print("today()函数的名字是: " + today.__name__)
today()

执行之后看结果:

1
2
3
4
5
6
7
8
D:\Python\test>python 7.py
--- 进入logger() ---
--- 进入decorator() ---
today()函数的名字是: today
--- 进入wrapper() ---
下面执行: today()
--- 进入today() ---
>> 2015-3-25

today()函数的名字已经不会改变了,这样如果程序有其他地方需要依赖其函数签名来做其他事情的时候就不会出错。其实wraps本身也是一个装饰器,这里在wrapper()函数定义时调用,目的是将原函数对象的指定属性复制给包装函数对象, 默认有module,name,doc,或者通过参数选择。