装饰器

前言

一个示例

装饰器的作用

如何实现一个装饰器

装饰器传参

类装饰器

保留原函数的元数据最后

018.10.27

前言

最近阅读公司的项目代码,许多地方用到了装饰器。然后就想起年初,那个时候刚刚接触Python,很多东西跟C啊C++不同。一时之间也没搞懂装饰器,跟着示例代码敲过几遍,也成功运行了,然后就像一个“渣男”头也不回的走掉。

真的就是走掉了,我从来没在自己的demo中使用装饰器。既然公司的项目需要,我当然不能说:“对不起不会喔。”

翻出之前做的笔记,居然发现也不难,就一下子会(简单使用 【 如果我不这样说明,万一惹到哪个大神不开森要为难我怎么办 】 )了。

总之,我觉得学习编程(应该也可以扩展到其他方面)不应该死磕,可能暂时领悟不了,那是因为你沉淀得还不够。就像小学时我因为不能背出乘法口诀表而被留堂,最后在同学的帮助下作弊通关,可现在,或许我数学不好,但至少不会不好在“背不出乘法口诀表”上了。

一个示例

昨天公司开周会,研发部所有人出席。我刚到公司不久,需要自我介绍,于是:

这时候老总说不行,你得说你在哪个组,还要说自己做什么呀!OKOK~

“停停停。”老总仍不满意:“得说你有没有女朋友呀,我们这里单身女职员很多呢。”

那好吧:

装饰器的作用

从前面的示例中,我们可以看出:装饰器能在不改变原函数结构的情况下,增添函数的功能。以及装饰器是从上而下的执行顺序(这一点很重要)。

三个代码片都只执行了,却输出三次不同的结果。这就是装饰器的意义所在,它可以让你的代码更优雅,再优雅。当然优雅并不是它的终极目的。

首先,装饰器可以让你的代码高度复用。在每个需要额外介绍职位和说明自己单身的地方,都可以加上装饰器(@single@position)。

其次,装饰器能让你专注地去实现函数的功能(一个函数最好只做一件事儿,而且是它该做的事儿)。

最后,如果你是在维护公司的项目代码,在不破坏原函数封装的同时需要添加额外功能,你应该优先考虑这个功能可不可以通过装饰器实现。

如何实现一个装饰器

到这一步的时候,网上许多文章就要开始说“Python中函数也是一个对象”,balabala。这样说当然没错啦,而且确实应该补充这个知识点,由外向内地去探索装饰器。只不过——

当然仅仅是我的看法,也是我个人学习装饰器的一个经历。我明明是来学习装饰器的,沿路却一直不是我想看的风景。不看了,右上角左键,“哒”。关掉浏览器。

我是很介意也不认可一上来就是各种概念,挠得人头晕目眩。

在前面的第二个代码中:

position()函数中还有一个函数wrapper(),并且position()函数返回的是它内部函数的函数名wrapper。这是一个固定写法,大家可以记住。接下来说说他们参数的意义。

position()中的func接收的就是被修饰函数的函数名,也就是这里的"introduce"(当然不一定要用func,形参名可以自己设计)。而函数wrapper()中的*args,**kwargs表示任意多个参数或关键字参数,它们用来接收调用introduce()时传入的实参。在这里,你可以简单的认为,就是name。有了下面这张图,二者的关系就可以一一对应上了。

需要注意的是,里层函数return出来的结果,其实就是我们需要调用函数的结果。如果原函数没有返回值,可以不写。也可以写,因为Python中函数默认返回None。

装饰器传参

如果是一个女实习生呢?如果也需要她说明单身否,还可以用前面定义的装饰器@single吗?显然不可以,因为她不是“a single man”而是“woman”。这种时候,我们希望装饰器可以通过传参来实现男女通用。

需要注意,这里不再是简单的函数嵌套函数,而是函数嵌套函数再嵌套一个函数。欸?为什么要这样写了呢?好了,得讲一波原理了。

当我们实现一个@single装饰器,用它来装饰一个函数时:

这意思是,将原来的函数扔给了single包装,之后再“吐”出一个introduce,而我们之后调用的introduce就是“吐”来的那个。当装饰器需要传参的时候:

装饰器会先接收它自己的参数(woman),然后返回一个函数,这个函数再接收被装饰的函数(introduce),最后返回一个introduce。这个流程,我应该有阐述清楚吧!

这也就是上面嵌套了三层函数的原因。既然搞懂了这个过程,我们当然也可以用两层嵌套来实现,但需要借助偏函数partial。

在两层嵌套中实现装饰器传参时,一定要关键字传参,如果位置传参会让func来接收man,但我们的意图很明显,希望func接收的是introduce。

所以第一次传入man时,func一定为None,之后会进入if的执行语句中,返回一个绑定了gender参数的single。接下来会调用这个绑定了参数的single,传入的参数是introduce,传入的方式是位置传参。

好了,现在我们可以装饰器传参了。虽然三层嵌套实现的装饰器不必关键字传参,但它也不能通过@single来装饰一个函数,而必须@single()。尽管两层嵌套需要关键字传入,却可以直接使用@single。

类装饰器

同样,把一个类构建成装饰器,在Python中也是允许的。

同时实现__call__和__get__魔法方法的好处是:@Single不但可以装饰普通函数,也可以装饰类方法。

保留原函数的元数据

回到最开始的第二个代码,这一次我增加了注释:

现在我们执行下面的语句:

可以看到,函数名居然不是introduce,也没有文档信息了。但可能有的时候我们需要用到这一类数据,可以借助functools中的wraps来保留:

最后

装饰器的常用操作,以上就差不多了。但篇幅有限,没能详尽。这里极推《Python Cookbook》,Python进阶学习的不二之选。书厚且贵,网上有免费中文版(https://python3-cookbook.readthedocs.io/zh_CN/latest/preface.html)。

原理没怎么讲,但网上随便找一篇都可以看到。所以不在这里重复造轮子了。

装饰器真的很优雅,难道你会不喜欢前面那个棉花糖吗?

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20181028G1HMQX00?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

同媒体快讯

扫码关注腾讯云开发者

领取腾讯云代金券