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 不关闭控制台的实现方法
Oct 23 Python
Python黑魔法Descriptor描述符的实例解析
Jun 02 Python
python对离散变量的one-hot编码方法
Jul 11 Python
python 实现查找文件并输出满足某一条件的数据项方法
Jun 12 Python
python flask 如何修改默认端口号的方法步骤
Jul 12 Python
python使用Matplotlib改变坐标轴的默认位置
Oct 18 Python
Python中bisect的使用方法
Dec 31 Python
利用setuptools打包python程序的方法步骤
Jan 18 Python
pycharm激活码快速激活及使用步骤
Mar 12 Python
解决python cv2.imread 读取中文路径的图片返回为None的问题
Jun 02 Python
如何在 Matplotlib 中更改绘图背景的实现
Nov 26 Python
python - asyncio异步编程
Apr 06 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小型企业库存管理系统的设计与实现代码
2011/05/16 PHP
解析php session_set_save_handler 函数的用法(mysql)
2013/06/29 PHP
Thinkphp模板中截取字符串函数简介
2014/06/17 PHP
PHP四种基本排序算法示例
2015/04/09 PHP
Yii2框架dropDownList下拉菜单用法实例分析
2016/07/18 PHP
ThinkPHP5.1表单令牌Token失效问题的解决
2019/03/22 PHP
jquery实现控制表格行高亮实例
2013/06/05 Javascript
jquery库或JS文件在eclipse下报错问题解决方法
2014/04/17 Javascript
简介JavaScript中POSITIVE_INFINITY值的使用
2015/06/05 Javascript
Bootstrap fileinput文件上传组件使用详解
2017/06/06 Javascript
nodejs中密码加密处理操作详解
2018/03/20 NodeJs
Vue.JS实现垂直方向展开、收缩不定高度模块的JS组件
2018/06/19 Javascript
通过webpack引入第三方库的方法
2018/07/20 Javascript
基于Nodejs的Tcp封包和解包的理解
2018/09/19 NodeJs
Node.js实现用户评论社区功能(体验前后端开发的乐趣)
2019/05/09 Javascript
JQuery实现折叠式菜单的详细代码
2020/06/03 jQuery
vue 单页应用和多页应用的优劣
2020/10/22 Javascript
python和pyqt实现360的CLable控件
2014/02/21 Python
python Django批量导入数据
2016/03/25 Python
利用Celery实现Django博客PV统计功能详解
2017/05/08 Python
Python实现购物程序思路及代码
2017/07/24 Python
Python简单获取二维数组行列数的方法示例
2018/12/21 Python
django的ORM模型的实现原理
2019/03/04 Python
使用python对多个txt文件中的数据进行筛选的方法
2019/07/10 Python
python如何删除文件中重复的字段
2019/07/16 Python
用Python写一个自动木马程序
2019/09/17 Python
python如何将图片转换素描画
2020/09/08 Python
网站设计师的岗位职责
2013/11/21 职场文书
协议书范本
2014/04/23 职场文书
节约用水演讲稿
2014/05/21 职场文书
社会发展项目建议书
2014/08/25 职场文书
共青团员自我评价范文
2014/09/14 职场文书
党员承诺书格式范文
2015/04/28 职场文书
《伯牙绝弦》教学反思
2016/02/16 职场文书
apache基于端口创建虚拟主机的示例
2021/04/24 Servers
详解JS ES6编码规范
2021/05/07 Javascript