python 装饰器功能与用法案例详解

本文实例讲述了python 装饰器功能与用法。分享给大家供大家参考，具体如下：

1、必备

1. #### 第一波 ####
2. def foo():
3. print 'foo'
4.  
5. foo #表示是函数
6. foo() #表示执行foo函数
7.  
8. #### 第二波 ####
9. def foo():
10. print 'foo'
11.  
12. foo = lambda x: x + 1
13. foo() # 执行下面的lambda表达式，而不再是原来的foo函数，因为函数 foo 被重新定义了
14.  

2、需求来了

初创公司有N个业务部门，1个基础平台部门，基础平台负责提供底层的功能，如：数据库操作、redis调用、监控API等功能。业务部门使用基础功能时，只需调用基础平台提供的功能即可。如下：

1. ############### 基础平台提供的功能如下 ###############
2. def f1():
3. print 'f1'
4.  
5. def f2():
6. print 'f2'
7.  
8. def f3():
9. print 'f3'
10.  
11. def f4():
12. print 'f4'
13.  
14. ############### 业务部门A 调用基础平台提供的功能 ###############
15. f1()
16. f2()
17. f3()
18. f4()
19.  
20. ############### 业务部门B 调用基础平台提供的功能 ###############
21. f1()
22. f2()
23. f3()
24. f4()
25.  

目前公司有条不紊的进行着，但是，以前基础平台的开发人员在写代码时候没有关注验证相关的问题，即：基础平台的提供的功能可以被任何人使用。现在需要对基础平台的所有功能进行重构，为平台提供的所有功能添加验证机制，即：执行功能前，先进行验证。

老大把工作交给 Low B，他是这么做的：

跟每个业务部门交涉，每个业务部门自己写代码，调用基础平台的功能之前先验证。诶，这样一来基础平台就不需要做任何修改了。

当天Low B 被开除了...

老大把工作交给 Low BB，他是这么做的：

只对基础平台的代码进行重构，让N业务部门无需做任何修改

1. ############### 基础平台提供的功能如下 ###############
2.  
3. def f1():
4. # 验证1
5. # 验证2
6. # 验证3
7. print 'f1'
8.  
9. def f2():
10. # 验证1
11. # 验证2
12. # 验证3
13. print 'f2'
14.  
15. def f3():
16. # 验证1
17. # 验证2
18. # 验证3
19. print 'f3'
20.  
21. def f4():
22. # 验证1
23. # 验证2
24. # 验证3
25. print 'f4'
26. ############### 业务部门不变 ###############
27. ### 业务部门A 调用基础平台提供的功能###
28.  
29. f1()
30. f2()
31. f3()
32. f4()
33.  
34. ### 业务部门B 调用基础平台提供的功能 ###
35.  
36. f1()
37. f2()
38. f3()
39. f4()
40.  

过了一周 Low BB 被开除了...

老大把工作交给 Low BBB，他是这么做的：

只对基础平台的代码进行重构，其他业务部门无需做任何修改

1. ############### 基础平台提供的功能如下 ###############
2.  
3. def check_login():
4. # 验证1
5. # 验证2
6. # 验证3
7. pass
8.  
9. def f1():
10.  
11. check_login()
12.  
13. print 'f1'
14.  
15. def f2():
16.  
17. check_login()
18.  
19. print 'f2'
20.  
21. def f3():
22.  
23. check_login()
24.  
25. print 'f3'
26.  
27. def f4():
28.  
29. check_login()
30.  
31. print 'f4'
32.  

老大看了下Low BBB 的实现，嘴角漏出了一丝的欣慰的笑，语重心长的跟Low BBB聊了个天：

老大说：

写代码要遵循开发封闭原则，虽然在这个原则是用的面向对象开发，但是也适用于函数式编程，简单来说，它规定已经实现的功能代码不允许被修改，但可以被扩展，即：

封闭：已实现的功能代码块
开放：对扩展开发

如果将开放封闭原则应用在上述需求中，那么就不允许在函数 f1 、f2、f3、f4的内部进行修改代码，老板就给了Low BBB一个实现方案：

1. def w1(func):
2. def inner():
3. # 验证1
4. # 验证2
5. # 验证3
6. return func()
7. return inner
8.  
9. @w1
10. def f1():
11. print 'f1'
12. @w1
13. def f2():
14. print 'f2'
15. @w1
16. def f3():
17. print 'f3'
18. @w1
19. def f4():
20. print 'f4'
21.  

对于上述代码，也是仅仅对基础平台的代码进行修改，就可以实现在其他人调用函数 f1 f2 f3 f4 之前都进行【验证】操作，并且其他业务部门无需做任何操作。

Low BBB心惊胆战的问了下，这段代码的内部执行原理是什么呢？

老大正要生气，突然Low BBB的手机掉到地上，恰恰屏保就是Low BBB的女友照片，老大一看一紧一抖，喜笑颜开，交定了Low BBB这个朋友。详细的开始讲解了：

单独以f1为例：

1. def w1(func):
2. def inner():
3. # 验证1
4. # 验证2
5. # 验证3
6. return func()
7. return inner
8. @w1
9. def f1():
10. print 'f1'
11.  

当写完这段代码后（函数未被执行、未被执行、未被执行），python解释器就会从上到下解释代码，步骤如下：

1. def w1(func): ==>将w1函数加载到内存
2. @w1
3.  

没错，从表面上看解释器仅仅会解释这两句代码，因为函数在没有被调用之前其内部代码不会被执行。

从表面上看解释器着实会执行这两句，但是 @w1 这一句代码里却有大文章，@函数名 是python的一种语法糖。

如上例@w1内部会执行一下操作：

• 执行w1函数，并将 @w1 下面的 函数 作为w1函数的参数，即：@w1 等价于 w1(f1)
  所以，内部就会去执行：
  1. def inner:
  2. #验证
  3. return f1() # func是参数，此时 func 等于 f1
  4. return inner # 返回的 inner，inner代表的是函数，非执行函数
• 其实就是将原来的 f1 函数塞进另外一个函数中
• 将执行完的 w1 函数返回值赋值给@w1下面的函数的函数名
  w1函数的返回值是：
     def inner:
          #验证
          return 原来f1()  # 此处的 f1 表示原来的f1函数
  然后，将此返回值再重新赋值给 f1，即：
  新f1 = def inner:
              #验证
              return 原来f1() 
  所以，以后业务部门想要执行 f1 函数时，就会执行 新f1 函数，在 新f1 函数内部先执行验证，再执行原来的f1函数，然后将 原来f1 函数的返回值 返回给了业务调用者。
  如此一来， 即执行了验证的功能，又执行了原来f1函数的内容，并将原f1函数返回值 返回给业务调用着

Low BBB 你明白了吗？要是没明白的话，我晚上去你家帮你解决吧！！！

先把上述流程看懂，之后还会继续更新...

3、问答时间

问题：被装饰的函数如果有参数呢？

一个参数：

1. def w1(func):
2. def inner(arg):
3. # 验证1
4. # 验证2
5. # 验证3
6. return func(arg)
7. return inner
8.  
9. @w1
10. def f1(arg):
11. print 'f1'
12.  

两个参数：

1. def w1(func):
2. def inner(arg1,arg2):
3. # 验证1
4. # 验证2
5. # 验证3
6. return func(arg1,arg2)
7. return inner
8.  
9. @w1
10. def f1(arg1,arg2):
11. print 'f1'
12.  

三个参数：

1. def w1(func):
2. def inner(arg1,arg2,arg3):
3. # 验证1
4. # 验证2
5. # 验证3
6. return func(arg1,arg2,arg3)
7. return inner
8.  
9. @w1
10. def f1(arg1,arg2,arg3):
11. print 'f1'
12.  

问题：可以装饰具有处理n个参数的函数的装饰器？

1. def w1(func):
2. def inner(*args,**kwargs):
3. # 验证1
4. # 验证2
5. # 验证3
6. return func(*args,**kwargs)
7. return inner
8.  
9. @w1
10. def f1(arg1,arg2,arg3):
11. print 'f1'
12.  

问题：一个函数可以被多个装饰器装饰吗？

1. def w1(func):
2. def inner(*args,**kwargs):
3. # 验证1
4. # 验证2
5. # 验证3
6. return func(*args,**kwargs)
7. return inner
8.  
9. def w2(func):
10. def inner(*args,**kwargs):
11. # 验证1
12. # 验证2
13. # 验证3
14. return func(*args,**kwargs)
15. return inner
16.  
17. @w1
18. @w2
19. def f1(arg1,arg2,arg3):
20. print 'f1'
21.  

问题：还有什么更吊的装饰器吗？

1. #!/usr/bin/env python
2. #coding:utf-8
3.  
4. def Before(request,kargs):
5. print 'before'
6.  
7. def After(request,kargs):
8. print 'after'
9.  
10.  
11. def Filter(before_func,after_func):
12. def outer(main_func):
13. def wrapper(request,kargs):
14.  
15. before_result = before_func(request,kargs)
16. if(before_result != None):
17. return before_result;
18.  
19. main_result = main_func(request,kargs)
20. if(main_result != None):
21. return main_result;
22.  
23. after_result = after_func(request,kargs)
24. if(after_result != None):
25. return after_result;
26.  
27. return wrapper
28. return outer
29.  
30. @Filter(Before, After)
31. def Index(request,kargs):
32. print 'index'
33.  

4、functools.wraps

上述的装饰器虽然已经完成了其应有的

功能，即：装饰器内的函数代指了原函数，注意其只是代指而非相等，原函数的元信息没有被赋值到装饰器函数内部。例如：函数的注释信息

无元信息：

1. def outer(func):
2. def inner(*args, **kwargs):
3. print(inner.__doc__) # None
4. return func()
5. return inner
6.  
7. @outer
8. def function():
9. """
10. asdfasd
11. :return:
12. """
13. print('func')

如果使用@functools.wraps装饰装饰器内的函数，那么就会代指元信息和函数。

含元信息：

1. def outer(func):
2. @functools.wraps(func)
3. def inner(*args, **kwargs):
4. print(inner.__doc__) # None
5. return func()
6. return inner
7.  
8. @outer
9. def function():
10. """
11. asdfasd
12. :return:
13. """
14. print('func')
15.  

更多关于Python相关内容感兴趣的读者可查看本站专题：《Python面向对象程序设计入门与进阶教程》、《Python数据结构与算法教程》、《Python函数使用技巧总结》、《Python字符串操作技巧汇总》、《Python编码操作技巧总结》及《Python入门与进阶经典教程》

希望本文所述对大家Python程序设计有所帮助。