77百科网
当前位置: 首页 生活百科

如何开发python装饰器(干货一文讲清楚Python之装饰器)

时间:2023-05-21 作者: 小编 阅读量: 1 栏目名: 生活百科

最基本的理念来自于一种被称为“装饰模式”的设计模式。没错,这个符号正是使用装饰器的标识,也是正经的Python语法。通常来说使用语法糖能够增加程序的可读性,从而减少程序代码出错的机会。此外,装饰函数有且只能有一个参数,即要被修饰的原函数。同时对于原函数本身又不会有影响。这也是“装饰”二字的含义。因此这样的行为没有任何意义。

概念介绍

装饰器(decorator),又称“装饰函数”,即一种返回值也是函数的函数,可以称之为“函数的函数”。其目的是在不对现有函数进行修改的情况下,实现额外的功能。最基本的理念来自于一种被称为“装饰模式”的设计模式。

在 Python 中,装饰器属于纯粹的“语法糖”,不使用也没关系,但是使用的话能够大大简化代码,使代码更加易读——当然,是对知道这是怎么回事儿的人而言。

想必经过一段时间的学习,大概率已经在 Python 代码中见过@这个符号。没错,这个符号正是使用装饰器的标识,也是正经的 Python 语法。

语法糖:指计算机语言中添加的某种语法,这种语法对语言的功能并没有影响,但是更方便程序员使用。通常来说使用语法糖能够增加程序的可读性,从而减少程序代码出错的机会。

运行机制

简单来说,下面两段代码在语义上是可以划等号的(当然具体过程还是有一点微小区别的):

def IAmDecorator(foo):'''我是一个装饰函数'''pass@IAmDecoratordef tobeDecorated(...):'''我是被装饰函数'''pass

与:

def IAmDecorator(foo):'''我是一个装饰函数'''passdef tobeDecorated(...):'''我是被装饰函数'''passtobeDecorated = IAmDecorator(tobeDecorated)

可以看到,使用装饰器的@语法,就相当于是将具体定义的函数作为参数传入装饰器函数,而装饰器函数则经过一系列操作,返回一个新的函数,然后再将这个新的函数赋值给原先的函数名。

最终得到的是一个与我们在代码中显式定义的函数同名异质的新函数。

而装饰函数就好像为原来的函数套了一层壳。如图所示,最后得到的组合函数即为应用装饰器产生的新函数:

这里要注意一点,上述两段代码在具体执行上还是存在些微的差异。在第二段代码中,函数名tobeDecorated实际上是先指向了原函数,在经过装饰器修饰之后,才指向了新的函数;但第一段代码的执行就没有这个中间过程,直接得到的就是名为tobeDecorated的新函数。

此外,装饰函数有且只能有一个参数,即要被修饰的原函数。

用法

Python 中,装饰器分为两种,分别是“函数装饰器”和“类装饰器”,其中又以“函数装饰器”最为常见,“类装饰器”则用得很少。

函数装饰器

对装饰函数的定义大致可以总结为如图所示的模板,即:

由于要求装饰函数返回值也为一个函数的缘故,为了在原函数的基础上对功能进行扩充,并且使得扩充的功能能够以函数的形式返回,因此需要在装饰函数的定义中再定义一个内部函数,在这个内部函数中进一步操作。最后return的对象就应该是这个内部函数对象,也只有这样才能够正确地返回一个附加了新功能的函数。

如图一的动图所示,装饰函数就像一个“包装”,将原函数装在了装饰函数的内部,从而通过在原函数的基础上附加功能实现了扩展,装饰函数再将这个新的整体返回。同时对于原函数本身又不会有影响。这也是“装饰”二字的含义。

这个地方如果不定义“内部函数”行不行呢?

答案是“不行”。

关于结构的解释

让我们来看看下面这段代码:

>>> def IAmFakeDecorator(fun):...print("我是一个假的装饰器")...return fun...>>> @IAmFakeDecorator... def func():...print("我是原函数")...我是一个假的装饰器

有点奇怪,怎么刚一定义,装饰器扩展的操作就执行了呢?

再来调用一下新函数:

>>> func()我是原函数

诶呦奇了怪了,扩展功能哪儿去了呀?

不要着急,我们来分析一下上面的代码。在装饰函数的定义中,我们没有另外定义一个内部函数,扩展操作直接放在装饰函数的函数体中,返回值就是传入的原函数。

在定义新函数的时候,下面两段代码又是等价的:

>>> @IAmFakeDecorator... def func():...print("我是原函数")...我是一个假的装饰器

>>> def func():...print("我是原函数")...>>> func = IAmFakeDecorator(func)我是一个假的装饰器

审视一下后一段代码,我们可以发现,装饰器只在定义新函数的同时调用一次,之后新函数名引用的对象就是装饰器的返回值了,与装饰器没有半毛钱关系。

换句话说,装饰器本身的函数体中的操作都是当且仅当函数定义时,才会执行一次,以后再以新函数名调用函数,执行的只会是内部函数的操作。所以到实际调用新函数的时候,得到的效果跟原函数没有任何区别。

如果不定义内部函数,单纯返回传入的原函数当然也是可以的,也符合装饰器的要求;但却得不到我们预期的结果,对原函数扩展的功能无法复用,只是一次性的。因此这样的行为没有任何意义。

这个在装饰函数内部定义的用于扩展功能的函数可以随意取名,但一般约定俗成命名为wrapper,即“包装”之意。

正确的装饰器定义应如下所示:

>>> def IAmDecorator(fun):...def wrapper(*args, **kw):...print("我真的是一个装饰器")...return fun(*args, **kw)...return wrapper...

参数设置的问题

内部函数参数设置为(*args, **kw)的目的是可以接收任意参数,关于如何接收任意参数的内容在前面的函数参数部分已经介绍过。

之所以要让wrapper能够接收任意参数,是因为我们在定义装饰器的时候并不知道会用来装饰什么函数,具体函数的参数又是什么情况;定义为“可以接收任意参数”能够极大增强代码的适应性。

另外,还要注意给出参数的位置。

要明确一个概念:除了函数头的位置,其他地方一旦给出了函数参数,表达式的含义就不再是“一个函数对象”,而是“一次函数调用”。

因此,我们的装饰器目的是返回一个函数对象,返回语句的对象一定是不带参数的函数名;在内部函数中,我们是需要对原函数进行调用,因此需要带上函数参数,否则,如果内部函数的返回值还是一个函数对象,就还需要再给一组参数才能够调用原函数。Show code:

>>> def IAmDecorator(fun):...def wrapper(*args, **kw):...print("我真的是一个装饰器")...return fun...return wrapper...>>> @IAmDecorator... def func(h):...print("我是原函数")...>>> func()我真的是一个装饰器<function func at 0x000001FF32E66950>

原函数没有被成功调用,只是得到了原函数对应的函数对象。只有进一步给出了下一组参数,才能够发生正确的调用(为了演示参数的影响,在函数func的定义中增加了一个参数h):

>>> func()(h=1)我真的是一个装饰器我是原函数

只要明白了带参数和不带参数的区别,并且知道你想要的到底是什么效果,就不会在参数上犯错误了。并且也完全不必拘泥上述规则,也许你要的就是一个未经调用的函数对象呢?

把握住这一点,嵌套的装饰器、嵌套的内部函数这些也就都不是问题了。

函数属性

还应注意的是,经过装饰器的修饰,原函数的属性也发生了改变。

>>> def func():...print("我是原函数")...>>> func.__name__'func'

正常来说,定义一个函数,其函数名称与对应的变量应该是一致的,这样在一些需要以变量名标识、索引函数对象时才能够避免不必要的问题。但是事情并不是那么顺利:

>>> @IAmDecorator... def func():...print("我是原函数")...>>> func.__name__'wrapper'

变量名还是那个变量名,原函数还是那个原函数,但是函数名称却变成了装饰器中内部函数的名称。

在这里我们可以使用 Python 内置模块functools中的wraps工具,实现“在使用装饰器扩展函数功能的同时,保留原函数属性”这一目的。这里functools.wraps本身也是一个装饰器。运行效果如下:

>>> import functools>>> # 定义保留原函数属性的装饰器... def IAmDecorator(fun):...@functools.wraps(fun)...def wrapper(*args, **kw):...print("我真的是一个装饰器")...return fun(*args, **kw)...return wrapper...>>> @IAmDecorator... def func():...print("我是原函数")...>>> func.__name__'func'

大功告成!

类装饰器

类装饰器的概念与函数装饰器类似,使用上语法也差不多:

@ClassDecoratorclass Foo:pass

等价于

class Foo:passFoo = ClassDecorator(Foo)

在定义类装饰器的时候,要保证类中存在__init__和__call__两种方法。其中__init__方法用以接收原函数或类,__call__方法用以实现装饰逻辑。

简单来讲,__init__方法负责在初始化类实例的时候,将传入的函数或类绑定到这个实例上;而__call__方法则与一般的函数装饰器差不多,连构造都没什么两样,可以认为__call__方法就是一个函数装饰器,因此不再赘述。

多个装饰器的情况

多个装饰器可以嵌套,具体情况可以理解为从下往上结合的复合函数;或者也可以理解为下一个装饰器的值是前一个装饰器的参数。

举例来说,下面两段代码是等价的:

@f1(arg)@f2def func():pass

def func():passfunc = f1(arg)(f2(func))

理解了前面的内容,这种情况也很容易掌握。

总结

本文介绍了 Python 中的装饰器这一特性,详细讲解了装饰器的实际原理和使用方式,能够大大帮助学习者掌握有关装饰器的知识,减小读懂 Python 代码的阻力,写出更加 pythonic 的代码。

    推荐阅读
  • 如何立足岗位发挥好示范引领作用(如何发挥好岗位的示范和引领作用)

    跟着小编一起来看一看吧!如何立足岗位发挥好示范引领作用首先要做实践的模范。要忠实履行政协会议的各种决议,自觉遵守各项工作制度,正确行使自己的民主权力。中共党员中的政协委员,不论是在政协组织的活动中,还是在日常工作生活中,都要积极地进行调查研究,了解最新动态,了解社会各方面的真实情况,了解群众的情绪、困难和诉求,充分反映他们的要求和呼声,使党委和政府能及时采纳他们对党和政府工作的意见建议。

  • 海底捞 摄像头(海底捞包间内安装摄像头遭质疑)

    对于安装摄像头是否会侵犯隐私,网友各执一词。安装了摄像头的门店也表示,安装主要是为了防止客人丢失东西,方便找回。不过,北青报记者进一步采访其安装摄像头的必要性时,截至发稿时,海底捞方面暂时没有回应。图像信息系统在营业期间应当正常运行,不得中断。在这一规定中,包间并未罗列其中。此前曾有调查称,在30家火锅店中,有19家在包间装有摄像头;在14家非火锅店中,也有2家的包间装有摄像头。

  • 讯飞智能语音服务(IQEQ齐上阵讯鸟软件打造更有)

    讯飞智能语音服务埃森哲调研显示:多达75%的高管表示,自己的组织将在未来三年积极部署某种人工智能技术,AI将作为一名同事、合作者和值得信赖的顾问,在企业中与人类并肩协作。智能客服语音机器人能够支持语音情感三分类、四分类和六分类,在各类应用场景下识别率均超过85%,在成熟的业务场景下识别准确率可高达95%。

  • 提高fps的方法csgo(FPS游戏CSGO之身位控制)

    FPS游戏CSGO之身位控制​高手与菜鸟最大的差距也许还不是枪法,而是存活率同样的一个点位,菜鸟去看点,永远是拉一个大身位,同时暴露在复数架枪点的准星内,所以死亡率奇高无比高手的身法多变,身位控制良好,知道适当切换行进节奏与路线。

  • 怎么用微信支付(用微信支付的方法介绍)

    怎么用微信支付?最简单的,看到各个超市或者别的地方的收银台都会贴有一张二维码图片,上面写着微信支付,就可以使用手机微信来支付了,打开手机微信,右上角有一个的标志,点击它,下面我们就来聊聊关于怎么用微信支付?接下来我们就一起去了解一下吧!这是把商家的二维码放到相机前,就可以自动扫描了,扫描出来后,可以看到要付款的别人的微信名称,可以核对一下,没问题就输入金额,完成付款。

  • 白萝卜多久能煮熟(白萝卜怎么煮)

    下面更多详细答案一起来看看吧!白萝卜多久能煮熟通常情况下,白萝卜水只要煮十五到二十分钟就差不多了。白萝卜煮水的做法非常简单,我们平时如果想要喝白萝卜水的话都可以自己在家里制作。制作它首先要把准备好的白萝卜清洗干净并切成片状或是块状,注意这里是不需要给萝卜去皮的。在白萝卜处理好之后,我们就可以准备一口锅并往里面倒入适量的清水加热。

  • 键盘和电脑怎么清洁(干货清洁电脑屏幕)

    键盘和电脑怎么清洁DTECH帝特,传递精彩画面,分享快乐时光!这种情况,我们可以购买专用液晶屏幕清洁剂进行清洁,价格大概在20~50元之间,通常专用清洁剂都有详细的使用说明。以上几个清洁方法都需要有规则地轻轻擦拭屏幕,不可以用力按着擦,否则容易给屏幕造成坏点。

  • 茉莉飘雪茶的功效与作用(关于茉莉飘雪茶的功效与作用)

    茉莉飘雪茶的功效与作用茉莉花茶是花茶中的典型,茉莉飘雪花茶能够帮助人体降血脂,有利于人体内脂肪的分解,还有一定的清除氧自由基作用,所以能够起到抗氧化、防衰老的功效。茉莉飘雪花茶能够起到保肝护肝、美容养颜的作用,同时还有一定杀菌、抗菌、增强机体免疫力的作用,可以预防感染性疾病,因为茉莉花茶中含有的营养物质比较丰富,能够提高机体的免疫力,也能够对抗疾病的发生。

  • 堕仙是指什么意思(堕仙出现在哪位人物身上呢)

    堕仙是指什么意思是指堕落的仙人,也指走火入魔,因为面对让自己万分痛苦的事而无法承受,后变为魔的紫薰上仙。紫薰上仙堕仙成魔是因一直守护她的檀凡上仙为救她而死,紫薰上仙觉得对不起檀凡上仙,又很愤怒于白子画的漠不关心,所以成为堕仙。求而不得,一念成魔。本是仙界的紫薰仙子,五上仙之一,擅长制香,因痴恋白子画而成为堕仙,坠入魔道。后被花千骨感动,放下执念,将所有功力传给白子画,成全白子画与花千骨。

  • 想让学习强国由青铜变成骨灰吗(想让学习强国由青铜变成骨灰吗)

    A、正确B、错误正确答案:A135、我国鼓励各类市场主体在有效保护旅游资源的前提下,依法合理利用旅游资源。A、正确B、错误正确答案:A137、2021年1月22日,我国首部战疫纪录电影上映,影片以平实的语言讲述了武汉人与来自全国各地医疗系统及其他行业的一线人员,一起打响武汉抗击新冠肺炎疫情阻击战。A、50%B、60%C、70%D、80%正确答案: