Python装饰器使用你可能不知道的几种姿势
作者:麦麦麦造 发布时间:2023-01-23 23:56:09
前言
在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里比较高级的一种语法,这里只是介绍了它的几种使用技巧,以及需要注意的问题。借用金庸先生的话,“武功无高低,修为有深浅”。想要更加灵活的使用装饰器,深入理解它的原理,我们在平时还是需要加强基本功的学习!
好了,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对脚本之家的支持。
来源:https://juejin.im/post/5db06acaf265da4d3c071abf
猜你喜欢
- DDPDistributed Data Parallel 简称 DDP,是 PyTorch 框架下一种适用于单机多卡、多机多卡任务的数据并行
- 女朋友是一个软件测试人员,在工作中经常会遇到需要录屏记录自己操作,方便后续开发同学定位。因为录屏软件动不动就开始收费,所以她经常更换录屏软件
- 最近遇到一个头疼的问题,用socket接收到一个字符串格式如下:{“trade_status”: {“desc”: “\u30106\u30
- https://discuss.pytorch.org/t/how-to-modify-the-final-fc-layer-based-o
- 本文实例为大家分享了wxPython绘图模块wxPyPlot实现数据可视化的具体代码,供大家参考,具体内容如下#-*- coding: ut
- 1、Python 条件语句Python 条件语句是通过一条或多条语句的执行结果来决定执行的代码块。Python 编程中 if 语句用于控制程
- asp函数实现把数字格式化为每3个数字时以逗号间隔的数字见下:<%Function Comma(str)If No
- 关于__dict__和dir()的区别和作用请参考这篇文章:基于Python __dict__与dir()的区别详解说下我当时遇到的问题:c
- 一、定义正则表达式是对字符串操作的一种逻辑公式,就是用事先定义好的一些特定字符、及这些特定字符的组合,组成一个“规则字符串”,这个“规则字符
- 这篇文章主要介绍了通过实例解析python描述符原理作用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的
- SQL Server 2000使得以XML导出数据变得更加简单,但在SQL Server 2000中导入XML数据并对其进行处理则有些麻烦。
- with语句会设置一个临时的上下文,交给上下文管理器对象控制,并且负责清理上下问题。这样做能避免错误并减少样板代码,因此API能更安全,更易
- pytorch中尝试用多进程加载训练数据集,源码如下:trainloader = torch.utils.data.DataLoader(t
- django中的超链接,在template中可以用{% url 'app_name:url_name' param%}其中a
- TensorFlow里面的padding只有两个选项也就是valid和samepytorch里面的padding么有这两个选项,它是数字0,
- pandas读取、写入csv数据非常方便,但是有时希望通过excel画个简单的图表看一下数据质量、变化趋势并保存,这时候csv格式的数据就略
- 查询语言通过在查询表格中键入单词或短语,然后单击按钮执行查询,就可以在 Web 站点中搜索任意的单词或短语(例如,查询表格示例
- import介绍import语句作用就是用来导入模块的,它可以出现在程序中的任何位置。import语句语法使用import语句导入模块,im
- 直方图处理直方图从图像内部灰度级的角度对图像进行表述从直方图的角度对图像进行处理,可以达到增强图像显示效果的目的。直方图的含义直方图是图像内
- Python实现AES算法密码学课程老师留的作业,我觉得用python实现更简单,就用python写了一个加解密的程序。程序分成三个部分,一