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中装饰器的一个妙用
Feb 08 Python
Python实现的简单文件传输服务器和客户端
Apr 08 Python
实例讲解Python的函数闭包使用中应注意的问题
Jun 20 Python
解决Python requests 报错方法集锦
Mar 19 Python
python中利用xml.dom模块解析xml的方法教程
May 24 Python
Python实现邮件的批量发送的示例代码
Jan 23 Python
python删除本地夹里重复文件的方法
Nov 19 Python
django 将model转换为字典的方法示例
Oct 16 Python
python爬虫 正则表达式解析
Sep 28 Python
Pytorch在dataloader类中设置shuffle的随机数种子方式
Jan 14 Python
利用python实现逐步回归
Feb 24 Python
django教程如何自学
Jul 31 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
初级的用php写的采集程序
2007/03/16 PHP
用PHP读取和编写XML DOM的实现代码
2011/02/03 PHP
sphinx增量索引的一个问题
2011/06/14 PHP
php中文乱码怎么办如何让浏览器自动识别utf-8
2014/01/15 PHP
angularjs创建弹出框实现拖动效果
2020/08/25 Javascript
jQuery实现边框动态效果的实例代码
2016/09/23 Javascript
canvas知识总结
2017/01/25 Javascript
微信小程序 检查接口状态实例详解
2017/06/23 Javascript
实例分析js事件循环机制
2017/12/13 Javascript
浅谈Vue项目骨架屏注入实践
2019/08/05 Javascript
Centos7 安装Node.js10以上版本的方法步骤
2019/10/15 Javascript
vue项目中监听手机物理返回键的实现
2020/01/18 Javascript
简单了解前端渐进式框架VUE
2020/07/20 Javascript
[03:15]2014DOTA2国际邀请赛 专访国士无双信心满满
2014/07/12 DOTA
浅谈Python中函数的参数传递
2016/06/21 Python
从头学Python之编写可执行的.py文件
2017/11/28 Python
python如何读写csv数据
2018/03/21 Python
python3基于OpenCV实现证件照背景替换
2018/07/18 Python
解决Pytorch 训练与测试时爆显存(out of memory)的问题
2019/08/20 Python
使用python 对验证码图片进行降噪处理
2019/12/18 Python
python爬虫基础知识点整理
2020/06/02 Python
django教程如何自学
2020/07/31 Python
CSS3制作皮卡丘动画壁纸的示例
2020/11/02 HTML / CSS
HTML5自定义data-* data(obj)属性和jquery的data()方法的使用
2012/12/13 HTML / CSS
Pure Collection美国官网:来自英国羊绒专家的奢华羊绒
2017/11/19 全球购物
C#中有没有运算符重载?能否使用指针?
2014/05/05 面试题
毕业生自荐信的主要内容
2013/10/29 职场文书
关于运动会的口号
2014/06/07 职场文书
运动会的口号
2014/06/09 职场文书
安全口号大全
2014/06/21 职场文书
2014年预备党员学习新党章思想汇报
2014/09/15 职场文书
公司证明怎么写
2014/09/22 职场文书
领导干部作风建设总结
2014/10/23 职场文书
2015年办公室工作总结范文
2015/03/31 职场文书
MySQL之高可用集群部署及故障切换实现
2021/04/22 MySQL
python中对列表的删除和添加方法详解
2022/02/24 Python