1. 技术文章
  2. Python装饰器简介

Python装饰器简介

由 ＊爱你＆永不变心＊ 提交于 2019-11-29 06:50:59

装饰器引入

初期及问题诞生

假如现在在一个公司，有A B C三个业务部门，还有S一个基础服务部门，目前呢，S部门提供了两个函数，供其他部门调用，函数如下：

  1. def f1():
  2.     print('f1 called')
  3.  
  4.  
  5. def f2():
  6.     print('f2 called')

在初期，其他部门这样调用是没有问题的，随着公司业务的发展，现在S部门需要对函数调用假如权限验证，如果有权限的话，才能进行调用，否则调用失败。考虑一下，如果是我们，该怎么做呢？

方案集合

  1. 让调用方也就是ABC部门在调用的时候，先主动进行权限验证
  2. S部门在对外提供的函数中，首先进行权限认证，然后再进行真正的函数操作

问题

  1. 方案一，将本不该暴露给外层的权限认证，暴露在使用方面前，同时如果有多个部门呢，要每个部门每个人都要周知到，你还不缺定别人一定会这么做，不靠谱。。。

  2. 方案二，看似看行，可是当S部门对外提供更多的需要进行权限验证方法时，每个函数都要调用权限验证，同样也实在费劲，不利于代码的维护性和扩展性

那么，有没有一种方法能够遵循代码的开放闭合原则，来完美的解决此问题呢？

装饰器引入

答案肯定是有的，不然真的是弱爆了。先看代码

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

输出结果为

  1. ...验证权限...
  2. f1 called
  3. ...验证权限...
  4. f2 called

可以通过代码及输出看到，在调用f1 f2 函数时，成功进行了权限验证，那么是怎么做到的呢？其实这里就使用到了装饰器，通过定义一个闭包函数w1，在我们调用函数上通过关键词@w1，这样就对f1 f2函数完成了装饰。

装饰器原理
首先，开看我们的装饰器函数w1，该函数接收一个参数func，其实就是接收一个方法名，w1内部又定义一个函数inner，在inner函数中增加权限校验，并在验证完权限后调用传进来的参数func，同时w1的返回值为内部函数inner，其实就是一个闭包函数。

然后，再来看一下，在f1上增加@w1，那这是什么意思呢？当python解释器执行到这句话的时候，会去调用w1函数，同时将被装饰的函数名作为参数传入(此时为f1)，根据闭包一文分析，在执行w1函数的时候，此时直接把inner函数返回了，同时把它赋值给f1，此时的f1已经不是未加装饰时的f1了，而是指向了w1.inner函数地址。

接下来，在调用f1()的时候，其实调用的是w1.inner函数，那么此时就会先执行权限验证，然后再调用原来的f1()，该处的f1就是通过装饰传进来的参数f1。

这样下来，就完成了对f1的装饰，实现了权限验证。

装饰器知识点

执行时机

了解了装饰器的原理后，那么它的执行时机是什么样呢，接下来就来看一下。 国际惯例，先上代码。

  1. def w1(fun):
  2.     print('...装饰器开始装饰...')
  3.  
  4.     def inner():
  5.         print('...验证权限...')
  6.         fun()
  7.  
  8.     return inner
  9.  
  10.  
  11. @w1
  12. def test():
  13.     print('test')
  14.  
  15. test()

输出结果为

  1. ...装饰器开始装饰...
  2. ...验证权限...
  3. test

由此可以发现，当python解释器执行到@w1时，就开始进行装饰了，相当于执行了如下代码：

test = w1(test)

两个装饰器执行流程和装饰结果

当有两个或两个以上装饰器装饰一个函数时，那么执行流程和装饰结果是什么样的呢？同样，还是以代码来说明问题。

  1. def makeBold(fun):
  2.     print('----a----')
  3.  
  4.     def inner():
  5.         print('----1----')
  6.         return '<b>' + fun() + '</b>'
  7.  
  8.     return inner
  9.  
  10.  
  11. def makeItalic(fun):
  12.     print('----b----')
  13.  
  14.     def inner():
  15.         print('----2----')
  16.         return '<i>' + fun() + '</i>'
  17.  
  18.     return inner
  19.  
  20.  
  21. @makeBold
  22. @makeItalic
  23. def test():
  24.     print('----c----')
  25.     print('----3----')
  26.     return 'hello python decorator'
  27.  
  28.  
  29. ret = test()
  30. print(ret)

输出结果为

  1. ----b----
  2. ----a----
  3. ----1----
  4. ----2----
  5. ----c----
  6. ----3----
  7. <b><i>hello python decorator</i></b>

可以发现，先用第二个装饰器(makeItalic)进行装饰，接着再用第一个装饰器(makeBold)进行装饰，而在调用过程中，先执行第一个装饰器(makeBold)，接着再执行第二个装饰器(makeItalic)。

为什么呢，分两步来分析一下。

  1. 装饰时机 通过上面装饰时机的介绍，我们可以知道，在执行到@makeBold的时候，需要对下面的函数进行装饰，此时解释器继续往下走，发现并不是一个函数名，而又是一个装饰器，这时候，@makeBold装饰器暂停执行，而接着执行接下来的装饰器@makeItalic，接着把test函数名传入装饰器函数，从而打印’b’，在makeItalic装饰完后，此时的test指向makeItalic的inner函数地址，这时候有返回来执行@makeBold，接着把新test传入makeBold装饰器函数中，因此打印了’a’。
  2. 在调用test函数的时候，根据上述分析，此时test指向makeBold.inner函数，因此会先打印‘1‘，接下来，在调用fun()的时候，其实是调用的makeItalic.inner()函数，所以打印‘2‘，在makeItalic.inner中，调用的fun其实才是我们最原声的test函数，所以打印原test函数中的‘c‘，‘3‘，所以在一层层调完之后，打印的结果为<b><i>hello python decorator</i></b> 。

对无参函数进行装饰

上面例子中的f1 f2都是对无参函数的装饰，不再单独举例

对有参函数进行装饰

在使用中，有的函数可能会带有参数，那么这种如何处理呢？ 
代码优先：

  1. def w_say(fun):
  2.     """
  3.     如果原函数有参数，那闭包函数必须保持参数个数一致，并且将参数传递给原方法
  4.     """
  5.  
  6.     def inner(name):
  7.         """
  8.         如果被装饰的函数有行参，那么闭包函数必须有参数
  9.         :param name:
  10.         :return:
  11.         """
  12.         print('say inner called')
  13.         fun(name)
  14.  
  15.     return inner
  16.  
  17.  
  18. @w_say
  19. def hello(name):
  20.     print('hello ' + name)
  21.  
  22.  
  23. hello('wangcai')

输出结果为

  1. say inner called
  2. hello wangcai

具体说明代码注释已经有了，就不再单独说明了。 
此时，也许你就会问了，那是一个参数的，如果多个或者不定长参数呢，该如何处理呢？看看下面的代码你就秒懂了。

  1. def w_add(func):
  2.     def inner(*args, **kwargs):
  3.         print('add inner called')
  4.         func(*args, **kwargs)
  5.  
  6.     return inner
  7.  
  8.  
  9. @w_add
  10. def add(a, b):
  11.     print('%d + %d = %d' % (a, b, a + b))
  12.  
  13.  
  14. @w_add
  15. def add2(a, b, c):
  16.     print('%d + %d + %d = %d' % (a, b, c, a + b + c))
  17.  
  18.  
  19. add(2, 4)
  20. add2(2, 4, 6)

输出结果为

  1. add inner called
  2. 2 + 4 = 6
  3. add inner called
  4. 2 + 4 + 6 = 12

利用python的可变参数轻松实现装饰带参数的函数。

对带返回值的函数进行装饰

下面对有返回值的函数进行装饰，按照之前的写法，代码是这样的

  1. def w_test(func):
  2.     def inner():
  3.         print('w_test inner called start')
  4.         func()
  5.         print('w_test inner called end')
  6.     return inner
  7.  
  8.  
  9. @w_test
  10. def test():
  11.     print('this is test fun')
  12.     return 'hello'
  13.  
  14.  
  15. print('ret value is %s' % test)

输出结果为

  1. w_test inner called start
  2. this is test fun
  3. w_test inner called end
  4. ret value is None

可以发现，此时，并没有输出test函数的‘hello’,而是None，那是为什么呢，可以发现，在inner函数中对test进行了调用，但是没有接受不了返回值，也没有进行返回，那么默认就是None了，知道了原因，那么来修改一下代码：

  1. def w_test(func):
  2.     def inner():
  3.         print('w_test inner called start')
  4.         str = func()
  5.         print('w_test inner called end')
  6.         return str
  7.  
  8.     return inner
  9.  
  10.  
  11. @w_test
  12. def test():
  13.     print('this is test fun')
  14.     return 'hello'
  15.  
  16.  
  17. print('ret value is %s' % test)

输出结果为

  1. w_test inner called start
  2. this is test fun
  3. w_test inner called end
  4. ret value is hello

这样就达到预期，完成对带返回值参数的函数进行装饰。

带参数的装饰器

介绍了对带参数的函数和有返回值的函数进行装饰，那么有没有带参数的装饰器呢，如果有的话，又有什么用呢？ 
答案肯定是有的，接下来通过代码来看一下吧。

  1. def func_args(pre='xiaoqiang'):
  2.     def w_test_log(func):
  3.         def inner():
  4.             print('...记录日志...visitor is %s' % pre)
  5.             func()
  6.  
  7.         return inner
  8.  
  9.     return w_test_log
  10.  
  11.  
  12. # 带有参数的装饰器能够起到在运行时，有不同的功能
  13.  
  14. # 先执行func_args('wangcai')，返回w_test_log函数的引用
  15. # @w_test_log
  16. # 使用@w_test_log对test_log进行装饰
  17. @func_args('wangcai')
  18. def test_log():
  19.     print('this is test log')
  20.  
  21.  
  22. test_log()

输出结果为

  1. ...记录日志...visitor is wangcai
  2. this is test log

简单理解，带参数的装饰器就是在原闭包的基础上又加了一层闭包，通过外层函数func_args的返回值w_test_log就看出来了，具体执行流程在注释里已经说明了。 
好处就是可以在运行时，针对不同的参数做不同的应用功能处理。

通用装饰器

介绍了这么多，在实际应用中，如果针对没个类别的函数都要写一个装饰器的话，估计就累死了，那么有没有通用万能装饰器呢，答案肯定是有的，废话不多说，直接上代码。

  1. def w_test(func):
  2.     def inner(*args, **kwargs):
  3.         ret = func(*args, **kwargs)
  4.         return ret
  5.  
  6.     return inner
  7.  
  8.  
  9. @w_test
  10. def test():
  11.     print('test called')
  12.  
  13.  
  14. @w_test
  15. def test1():
  16.     print('test1 called')
  17.     return 'python'
  18.  
  19.  
  20. @w_test
  21. def test2(a):
  22.     print('test2 called and value is %d ' % a)
  23.  
  24.  
  25. test()
  26. test1()
  27. test2(9)

输出结果为

  1. test called
  2. test1 called
  3. test2 called and value is 9

把上面几种示例结合起来，就完成了通用装饰器的功能，原理都同上，就不过多废话了。

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

类装饰器

装饰器函数其实是一个接口约束，它必须接受一个callable对象作为参数，然后返回一个callable对象。 
在python中，一般callable对象都是函数，但是也有例外。比如只要某个对象重写了call方法，那么这个对象就是callable的。

当创建一个对象后，直接去执行这个对象，那么是会抛出异常的，因为他不是callable，无法直接执行，但进行修改后，就可以直接执行调用了，如下
 

  1. class Test(object):
  2.     def __call__(self, *args, **kwargs):
  3.         print('call called')
  4.  
  5.  
  6. t = Test()
  7. print(t())

输出结果为

call called

下面，引入正题，看一下如何用类装饰函数。

  1. class Test(object):
  2.     def __init__(self, func):
  3.         print('test init')
  4.         print('func name is %s ' % func.__name__)
  5.         self.__func = func
  6.  
  7.     def __call__(self, *args, **kwargs):
  8.         print('装饰器中的功能')
  9.         self.__func()
  10.  
  11.  
  12. @Test
  13. def test():
  14.     print('this is test func')
  15.  
  16.  
  17. test()

输出结果为

  1. test init
  2. func name is test 
  3. 装饰器中的功能
  4. this is test func

和之前的原理一样，当python解释器执行到到@Test时，会把当前test函数作为参数传入Test对象，调用init方法，同时将test函数指向创建的Test对象，那么在接下来执行test()的时候，其实就是直接对创建的对象进行调用，执行其call方法。

 

装饰器引入

标签
python装饰器
python函数
python
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!