搞定三大神器之 Python 装饰器

开发 后端
装饰器,几乎各大Python框架中都能看到它的身影,足以表明它的价值!它有动态改变函数或类功能的魔力!

装饰器,几乎各大Python框架中都能看到它的身影,足以表明它的价值!它有动态改变函数或类功能的魔力!

[[344466]]

1. 什么是装饰器

对于受到封装的原函数比如f来说,装饰器能够在f函数执行前或者执行后分别运行一些代码。

2. 装饰器的结构

装饰器也是一个函数,它装饰原函数f或类cls后,再返回一个函数g

装饰一个函数:

  1. def decorator(f): 
  2.   # 定义要返回的函数 
  3.   def g(): 
  4.     print('函数f执行前的动作') 
  5.     f() 
  6.     print('函数f执行后的动作') 
  7.   return g 

装饰一个类:

  1. def decorator(cls): 
  2.   # 定义要返回的函数 
  3.   def g(): 
  4.     print('类cls执行前的动作') 
  5.     f() 
  6.     print('类cls执行后的动作') 
  7.   return g 

使用装饰器很简单,@+自定义装饰器 装饰要想装饰的函数。

3. 为什么要这样

要想理解装饰器为什么要有这种结构,要首先想明白装饰器的目标是什么。

它的价值在于为原函数f增加一些行为,前提必须不能破坏函数f,所以肯定不能改变f的内部结构,所以只能在调用f前后定义一些行为。

同时,装饰器函数decorator返回值又是什么?你可以思考下,返回一个函数是再好不过的了,它包装了原函数f.

4. 装饰一个函数

printStar函数接收一个函数f,返回值也是一个函数,所以满足装饰器的结构要求,所以printStar是一个装饰器。

  1. def printStar(f): 
  2.     def g(): 
  3.         print('*'*20) 
  4.         f() 
  5.         print('*'*20) 
  6.     return g 

printStar装饰器实现f函数执行前、后各打印20个*字符。

使用printStar:

  1. @printStar 
  2. def f(): 
  3.     print('hello world') 

调用:

  1. if __name__ == '__main__': 
  2.    ### 改变函数功能 
  3.    f() 

打印结果:

  1. ******************** 
  2. hello world 
  3. ******************** 

可以很方便的装饰要想装饰的其他函数,如下:

  1. @printStar 
  2. def g(): 
  3.     print('welcome to Python') 

5. 装饰一个类

除了可以装饰函数f外,还可以装饰类cls,两者原理都是一样的。

下面给出一个装饰器实现单例模式的例子,所谓单例就是类只有唯一实例,不能有第二个。

  1. def singleton(cls): 
  2.    instance = {} 
  3.  
  4.    def get_instance(*args, **kwargs): 
  5.        if cls not in instance: 
  6.            instance[cls] = cls(*args, **kwargs) 
  7.        return instance[cls] 
  8.    return get_instance 

定义字典instance,键值对分别为类和实例,这样确保只cls()一次。

使用装饰器singleton修饰类:

  1. @singleton 
  2. class CorePoint: 
  3.    pass 

测试:

  1. if __name__ == '__main__': 
  2.    ### 改变类的功能 
  3.    c1 = CorePoint() 
  4.    c2 = CorePoint() 
  5.    print(c1 is c2) # True 

6. 装饰器层叠

上面原函数f不仅能被一个装饰器修饰,还能被n多个装饰器修饰。

下面再定义一个装饰器printLine,被修饰函数执行前后打印20个:

  1. def printLine(f): 
  2.     def g(): 
  3.         print('-'*20) 
  4.         f() 
  5.         print('-'*20) 
  6.     return g 

使用上文定义好的printStar和printLine同时装饰函数f:

  1. @printStar 
  2. @printLine 
  3. def f(): 
  4.     print('hello world') 

此时再调用函数f:

  1. if __name__ == '__main__': 
  2.    ### 改变函数功能 
  3.    f() 

打印结果:

  1. ******************** 
  2. -------------------- 
  3. hello world 
  4. -------------------- 
  5. ******************** 

f被装饰后,先打印*,再打印 -

层叠多一层,原函数f就变强大一层。使用装饰器,还能实现功能抽离,进一步实现松耦合。

7. 温馨提醒

打印原函数f的名字__name__,结果为f

  1. In [1]: def f():  
  2.    ...:     pass  
  3.  
  4. In [4]: f.__name__                                                               
  5. Out[4]: 'f' 

但是,被装饰后函数名字f变为g,这不是我们希望的!

  1. @printStar 
  2. def f(): 
  3.   pass 
  4.  
  5. f() 
  6. f.__name__ # g 

Python提供的解决方案:使用functools模块中的wraps装饰器:

  1. from functools import wraps 
  2.  
  3. def printStar(f): 
  4.     @wraps(f) 
  5.     def g(): 
  6.         print('*'*20) 
  7.         f() 
  8.         print('*'*20) 
  9.     return g 

此时再打印被装饰后f的名字,显示f,正常!

 

责任编辑:赵宁宁 来源: Python与算法社区
相关推荐

2018-06-08 10:18:22

Python装饰器迭代器

2022-11-27 08:12:11

RocketMQ源码工具类

2023-12-13 13:28:16

装饰器模式Python设计模式

2016-09-13 19:21:07

CTO管理技术

2023-12-06 07:36:27

前端开发

2023-02-07 07:47:52

Python装饰器函数

2010-02-01 17:50:32

Python装饰器

2021-09-13 09:28:10

PuppeteerNode 库DevTools 协议

2021-05-27 12:10:42

前端puppeteer代码

2023-09-04 13:14:00

装饰器设计模式

2021-01-31 20:51:55

PuppeteerNode核心

2022-09-19 23:04:08

Python装饰器语言

2019-07-01 08:46:37

AI 数据人工智能

2016-11-01 09:24:38

Python装饰器

2010-06-04 09:08:56

2012-02-08 13:52:30

云计算

2021-03-23 09:06:34

下载神器文件下载插件

2023-05-05 07:12:09

GPT产品主题

2023-12-11 15:51:00

Python装饰器代码

2021-06-01 07:19:58

Python函数装饰器
点赞
收藏

51CTO技术栈公众号