了解Python装饰器

一 装饰器是什么 装饰器是一个用于封装函数或者类的代码工具，显式地将封装器作用于函数或者类上，达到程序运行时动态增加功能的目的。对于函数运行前处理常见前置条件(常见的web登陆授权验证)，或者在函数执行之后做善后工作(比如异常处理，记录log 等等)。 二 如何使用装饰器 装饰器本质上就是一个可用接受调用也可以返回调用的高阶函数。该函数以被装饰的函数为参数(还可以加上其他值作为参数)。在装饰器内进行装饰器的逻辑处理，执行被装饰函数，并返回一个装饰过的函数，听起来是不是有点绕,Talk is cheap,show me the code . 本文使用函数now 和函数add作为例子，

1. import datetime
2. def now():
3. print 'now is ', datetime.datetime.today()
4. def add(x, y):
5. ret = x + y
6. print '{x} + {y} = {retval}'.format(x=x,y=y,retval=ret)

2.1 装饰器语法 有两种方式显示调用装饰器的方法。 方法一:func = deco(func) 方法二:Python 2.5之后 为装饰器引入了特殊的语法 @ --语法糖，在装饰器名称前使用@ 符号，添加在被装饰的函数定义之前。

1. @deco
2. def now():
3. print 'now is ', datetime.datetime.today()
4. # 调用now
5. now()

本文将从 参数这个角度来由浅入深介绍装饰器，函数有不带参数和带参数的两种情况，装饰器也有带参数和不带参数的两种情况，装饰器对处理带参数和不带参数的情况也会有锁不同。 2.2 不带参数的情况 我们需要在调用函数 now 之前和之后加上调用记录。

1. def deco(func):
2. print 'begin call %s():' % (func.__name__)
3. func()
4. print 'end call %s():' % (func.__name__)
5. return func #装饰器的参数是被装饰的函数对象，返回原函数的对象。
6. yangyiDBA:test yangyi$ python 1.py
7. begin call now():
8. now is 2017-05-01 14:40:57.309836
9. end call now():
10. now is 2017-05-01 14:40:57.309868

但是从上面的例子看 结果输出了两次now 时间，明显不符合我们的要求，因为装饰器必须返回被调用函数，return func的时候发生了第二次。后面我们会解决这个问题。 2.3 带参数的情况

因为函数的参数个数是不确定的 ，我们需要借助(*args, **kwargs)，自动适应变参和命名参数。

1. #!/usr/bin/env python
2. # coding:utf-8
3. import datetime
4. import functools
5. def deco(func):
6. @functools.wraps(func) #
7. def wrapper(*args, **kw):
8. print 'begin call %s():' % (func.__name__)
9. result=func(*args, **kw) # 如果函数无返回值 ，可以直接使用func(*args, **kw)
10. print 'end call %s():' % (func.__name__)
11. return result #这里 result 是为了func 有返回值,
12. return wrapper
13. @deco
14. def add(x, y):
15. ret = x + y
16. print '{x} + {y} = {retval}'.format(x=x,y=y,retval=ret)
17. @deco
18. def now():
19. print 'now is ', datetime.datetime.today()
20. add(2,5)
21. now()

上面的装饰器做了如下事情 1 函数func作为参数传给 deco()。 2 functool.wraps 将func 的属性复制给 warper。 3 执行函数func前后执行某些动作。 4 返回结果。 5 返回wrapper 函数对象。 这里特别说明functool.wraps的作用，由于装饰器导致解释器认为函数本身发生了改变，在某些情况下可能会导致一些问题。Python通过functool.wraps解决了这个问题: 在编写装饰器时，在实现前加入 @functools.wraps(func) 可以保证装饰器不会对被装饰函数造成影响。 特别说明其他要使用装饰器的时候会有其他的写法 比如直接返回被装饰的函数。

1. def deco(func):
2. @functools.wraps(func) #
3. def wrapper(*args, **kw):
4. print 'begin call %s():' % (func.__name__)
5. return func(*args, **kw)
6. return wrapper

输出

1. yangyiDBA:test yangyi$ python 1.py
2. begin call add():
3. 2 + 5 = 7
4. end call add():
5. begin call now():
6. now is 2017-05-01 15:20:51.597859
7. end call now():

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

1. #!/usr/bin/env python
2. # coding:utf-8
3. import datetime
4. import functools
5. def deco(text):
6. def _deco(func):
7. def wrapper(*args, **kw):
8. print '%s, begin call %s():' % (text,func.__name__)
9. result=func(*args, **kw) # 如果函数无返回值 ，可以直接使用func(*args, **kw)
10. print '%s, end call %s():' % (text,func.__name__)
11. return result #这里 result 是为了func 有返回值,
12. return wrapper
13. return _deco
14. @deco
15. def add(x, y):
16. ret = x + y
17. print '{x} + {y} = {retval}'.format(x=x,y=y,retval=ret)
18. @deco
19. def now():
20. print 'now is ', datetime.datetime.today()
21. add(2,5)
22. now()

测试结果:

1. yangyiDBA:test yangyi$ python 2.py
2. yangyi, begin call add():
3. 2 + 5 = 7
4. yangyi, end call add():
5. youzan, begin call now():
6. now is 2017-05-01 18:47:54.728296
7. youzan, end call now():

2.5 Python内置装饰器 在Python中有三个内置的装饰器，都是跟class相关的：staticmethod、classmethod 和property。 staticmethod 是类静态方法，其跟成员方法的区别是没有 self 参数，并且可以在类不进行实例化的情况下调用 classmethod 与成员方法的区别在于所接收的第一个参数不是 self （类实例的指针），而是cls（当前类的具体类型） property 是属性的意思，表示可以通过通过类实例直接访问的信息 2.6 跨文件调用，因为装饰器本质是一个函数。在工程实现里我们可以通过创建一个公用的decorator，作为基础装饰器供其他函数调用。 三 小结 Python一切皆对象，函数也是，也可以赋值给其他变量，理解这点再去理解装饰器就容易多了。刚刚研究装饰器，总结的可能比较浅显，想要深入学习装饰器的可以看看下面的 参考文章。 四 参考文章 1 《Python高级编程》 第一章装饰器 2 《装饰器》 3 Python装饰器学习（九步入门） 4 《详解Python的装饰器》