Python装饰器使用你可能不知道的几种姿势


Posted in Python onOctober 25, 2019

前言

在Python中,装饰器是一种十分强大并且好用的语法,一些重复的代码使用装饰器语法的话能够使代码更容易理解及阅读。

因此在这里简单总结了一下Python中装饰器的几种用法以及需要注意的事情。

一、在装饰器中获取被装饰函数的参数

假设我们在开发web的时候,需要做反爬。要判断接口的访问来源我们就可以通过下面装饰器的方法来实现:

def mydecorator(func):
 def wrapped(*args, **kwargs):
  print("进入装饰器")
  if args[0]['header'] == 'spider':
   print("code: 400")
   return

  result = func(*args, **kwargs)
  return result

 return wrapped
@mydecorator
def request_page(request):
 print("一个访问请求")
 print("返回了response")
if __name__ == '__main__':
 request = {
  'data': 100,
  'header': 'spider'
 }
 request_page(request)

在这个装饰器中,我们在装饰器中获取了request中的header参数,如果判断访问来源于爬虫,那么便给它返回一个400。
使用装饰器的写法等同于下面不使用装饰器的写法

def mydecorator(*args, **kwargs):
 print("进入函数")
 if args[0]['header'] == 'spider':
  print("code: 400")
  return False
 return True
def request_page(request):
 if not mydecorator(request):
  return
 print("访问一个网页")
 print("得到了response")
if __name__ == '__main__':
 request = {
  'data': 100,
  'header': 'spider'
 }
 request_page(request)

在只需要装饰一个函数的时候后面一种写法可能更优于装饰器的写法,但是在需要装饰很多个函数的时候,使用装饰器明显是更好的选择。

二、在装饰器获取函数的返回值

有的时候我们需要对函数的返回值做出判断,但又不想直接将判断写在函数里的时候,我们也可以使用装饰器来实现:

def mydecorator(func):
 def wrapped(*args, **kwargs):
  print("进入装饰器")
  result = func(*args, **kwargs)
  if result == 400:
   print("response is 400!")
   return False
  return True
 return wrapped

@mydecorator
def request_page():
 print("访问一个网页")
 print("得到了response")
 return 200

if __name__ == '__main__':
 print(request_page())

三、给装饰器传入参数

在实际应用中,我们有时需要根据函数的执行状态来重复执行。例如在编写爬虫的时候,可能由于网络的原因会导致一些页面访问失败,这时我们就需要根据爬虫的返回结果进行重复请求。

def retry(MAXRETRY=3):
 def decorator(func):
  def wrapped(*args, **kwargs):
   print("进入装饰器")

   result = 0
   retry = 1
   while result != 200 and retry <= MAXRETRY:
    result = func(*args, **kwargs)
    print("重试第%s次" % retry)
    retry += 1

   return result

  return wrapped

 return decorator
 
@retry(5)
def request_page():
 print("访问一个网页")
 print("得到了response")
 return 400

在这里我们假设访问一个网页得到400的时候便重新请求。我们在retry装饰器里传了一个5,这表示我们希望重试的最大次数为5次,如果不传入这个值,那么它的默认重试次数则为3次。

在熟悉了基本装饰器的写法后,传参装饰器的写法也十分的好理解了。就是在外面多加了一层函数,用于传入参数。

四、装饰器文档的问题

我们都知道通过魔术方法__doc__可以获取我们写在代码中的文档,那么你是否知道使用装饰器后,会造成被包装函数的文档被装饰器的文档覆盖的问题呢。

def request_page():
 '''
 request_page 函数文档
 :return:
 '''
 print("访问一个网页")
 print("得到了response")

if __name__ == '__main__':
 print(request_page.__doc__)

在上面对上面未使用装饰的代码使用__doc__方法的时候,我们得到的结果是:

In[3]: request_page.__doc__
Out[3]: '\n  request_page 函数文档\n  :return:\n  '

这是我们理想中的结果!

但是当我们将上述函数使用装饰器装饰后:

def decorator(func):
  def wrapped(*args, **kwargs):
    '''
    装饰器文档
    :param args:
    :param kwargs:
    :return:
    '''
    print("进入装饰器")
    result = func(*args, **kwargs)
    return result

  return wrapped


@decorator
def request_page():
  '''
  request_page 函数文档
  :return:
  '''
  print("访问一个网页")
  print("得到了response")

我们再一次运行__doc__魔术方法的时候,得到的结果却是装饰器的内部文档:

In[4]: request_page.__doc__
Out[4]: '\n    装饰器文档\n    :param args:\n    :param kwargs:\n    :return:\n    '
In[5]: request_page.__name__
Out[5]: 'wrapped'

这个问题会使得我们的调试变得困难,也会使许多自动文档生成工具失去效果。

解决这个问题的最好办法就是使用 functools包的wraps()模块来将装饰器进行一个包装。

from functools import wraps
def decorator(func):

  @wraps(func)
  def wrapped(*args, **kwargs):
    '''
    装饰器
    :param args:
    :param kwargs:
    :return:
    '''
    print("进入装饰器")
    result = func(*args, **kwargs)
    return result
  return wrapped

@decorator
def request_page():
  '''
  request_page 函数文档
  :return:
  '''
  print("访问一个网页")
  print("得到了response")

使用wraps将装饰器装饰后,这样我们的函数便能够保存它的一些重要数据了。

In[3]: request_page.__doc__
Out[3]: '\n  request_page 函数文档\n  :return:\n  '
In[3]: request_page.__name__
Out[4]: 'request_page'

五、使用class的写法来编写装饰器

虽然大多数的装饰器都是通过函数的写法来实现的,但同样的可以通过类的写法来实现装饰器。

使用类的写法,我们可以实现一些使用函数写法不太好实现的需求。例如记录一个函数执行的次数

class Decorator():
  def __init__(self,func):
    print('类初始化')
    self.func = func
    self.count = 0
  def __call__(self, *args, **kwargs):
    print('进入装饰器')
    result = self.func(*args,**kwargs)
    self.count += 1

    return result
@Decorator
def request_page():
  '''
  request_page
  :return:
  '''
  print("访问一个网页")
  print("得到了response")

六、总结

装饰器是Python里比较高级的一种语法,这里只是介绍了它的几种使用技巧,以及需要注意的问题。借用金庸先生的话,“武功无高低,修为有深浅”。想要更加灵活的使用装饰器,深入理解它的原理,我们在平时还是需要加强基本功的学习!

好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
Python查看多台服务器进程的脚本分享
Jun 11 Python
python按照多个字符对字符串进行分割的方法
Mar 17 Python
python 中random模块的常用方法总结
Jul 08 Python
Python之Scrapy爬虫框架安装及使用详解
Nov 16 Python
python实现微信跳一跳辅助工具步骤详解
Jan 04 Python
Python+OpenCV实现车牌字符分割和识别
Mar 31 Python
Python使用Pickle库实现读写序列操作示例
Jun 15 Python
Python判断对象是否为文件对象(file object)的三种方法示例
Apr 26 Python
Django 实现Admin自动填充当前用户的示例代码
Nov 18 Python
Django DRF APIView源码运行流程详解
Aug 17 Python
python音频处理的示例详解
Dec 23 Python
用Python实现Newton插值法
Apr 17 Python
win7下 python3.6 安装opencv 和 opencv-contrib-python解决 cv2.xfeatures2d.SIFT_create() 的问题
Oct 24 #Python
Python下应用opencv 实现人脸检测功能
Oct 24 #Python
Python迭代器iterator生成器generator使用解析
Oct 24 #Python
Python 取numpy数组的某几行某几列方法
Oct 24 #Python
Django和Flask框架优缺点对比
Oct 24 #Python
python命令 -u参数用法解析
Oct 24 #Python
使用python制作游戏下载进度条的代码(程序说明见注释)
Oct 24 #Python
You might like
第六节 访问属性和方法 [6]
2006/10/09 PHP
PHP date函数参数详解
2006/11/27 PHP
攻克CakePHP系列一 连接MySQL数据库
2008/10/22 PHP
php Undefined index的问题
2009/06/01 PHP
window+nginx+php环境配置 附配置搭配说明
2010/12/29 PHP
php中通过虚代理实现延迟加载的实现代码
2011/06/10 PHP
Yii2使用小技巧之通过 Composer 添加 FontAwesome 字体资源
2014/06/22 PHP
php设计模式之单例模式实例分析
2015/02/25 PHP
详解Yii2 rules 的验证规则
2016/12/02 PHP
学习YUI.Ext 第四天--对话框Dialog的使用
2007/03/10 Javascript
jQuery的实现原理的模拟代码 -1 核心部分
2010/08/01 Javascript
Dom在ajax技术中的作用说明
2010/10/25 Javascript
js中实现多态采用和继承类似的方法
2014/08/22 Javascript
jQuery中prev()方法用法实例
2015/01/08 Javascript
探究JavaScript函数式编程的乐趣
2015/12/14 Javascript
Vue监听数组变化源码解析
2017/03/09 Javascript
jQuery实现div跟随鼠标移动
2020/08/20 jQuery
vue-router 组件复用问题详解
2018/01/22 Javascript
Node.js API详解之 dns模块用法实例分析
2020/05/15 Javascript
在VUE style中使用data中的变量的方法
2020/06/19 Javascript
详解node.js 事件循环
2020/07/22 Javascript
Python 多进程和数据传递的理解
2017/10/09 Python
Python的SimpleHTTPServer模块用处及使用方法简介
2018/01/22 Python
python opencv 直方图反向投影的方法
2018/02/24 Python
python中如何使用分步式进程计算详解
2019/03/22 Python
在python下使用tensorflow判断是否存在文件夹的实例
2019/06/10 Python
Python数据相关系数矩阵和热力图轻松实现教程
2020/06/16 Python
纯CSS3实现移动端展开和收起效果的示例代码
2020/04/26 HTML / CSS
鲜为人知的HTML5语音合成功能
2019/05/17 HTML / CSS
高二政治教学反思
2014/02/01 职场文书
中药学专业毕业生推荐信
2014/07/10 职场文书
乡村教师党员四风问题对照检查材料思想汇报
2014/10/08 职场文书
2015年教学副校长工作总结
2015/07/22 职场文书
中学生国庆节演讲稿2015
2015/07/30 职场文书
详解TypeScript的基础类型
2022/02/18 Javascript
Go归并排序算法的实现方法
2022/04/06 Golang