Python深入——装饰器
admin
2024-04-21 06:40:40
0

装饰器(decorator)是一种高级Python语法。装饰器可以对一个函数、方法或者类进行加工。在Python中,我们有多种方法对函数和类进行加工,比如在Python闭包中,我们见到函数对象作为某一个函数的返回结果。相对于其它方式,装饰器语法简单,代码可读性高。因此,装饰器在Python项目中有广泛的应用。

装饰器最早在Python 2.5中出现,它最初被用于加工函数和方法这样的可调用对象(callable object,这样的对象定义有__call__方法)。在Python 2.6以及之后的Python版本中,装饰器被进一步用于加工类。

装饰函数和方法

我们先定义两个简单的数学函数,一个用来计算平方和,一个用来计算平方差:

# get square sum
def square_sum(a, b):return a**2 + b**2# get square diff
def square_diff(a, b):return a**2 - b**2print(square_sum(3, 4))
print(square_diff(3, 4))

在拥有了基本的数学功能之后,我们可能想为函数增加其它的功能,比如打印输入。我们可以改写函数来实现这一点:

# modify: print input# get square sum
def square_sum(a, b):print("intput:", a, b)return a**2 + b**2# get square diff
def square_diff(a, b):print("input", a, b)return a**2 - b**2print(square_sum(3, 4))
print(square_diff(3, 4))

我们修改了函数的定义,为函数增加了功能。

现在,我们使用装饰器来实现上述修改:

def decorator(F):def new_F(a, b):print("input", a, b)return F(a, b)return new_F# get square sum
@decorator
def square_sum(a, b):return a**2 + b**2# get square diff
@decorator
def square_diff(a, b):return a**2 - b**2print(square_sum(3, 4))
print(square_diff(3, 4))

装饰器可以用def的形式定义,如上面代码中的decorator。装饰器接收一个可调用对象作为输入参数,并返回一个新的可调用对象。装饰器新建了一个可调用对象,也就是上面的new_F。new_F中,我们增加了打印的功能,并通过调用F(a, b)来实现原有函数的功能。

定义好装饰器后,我们就可以通过@语法使用了。在函数square_sum和square_diff定义之前调用@decorator,我们实际上将square_sum或square_diff传递给decorator,并将decorator返回的新的可调用对象赋给原来的函数名(square_sum或square_diff)。 所以,当我们调用square_sum(3, 4)的时候,就相当于:

square_sum = decorator(square_sum)
square_sum(3, 4)

我们知道,Python中的变量名和对象是分离的。变量名可以指向任意一个对象。从本质上,装饰器起到的就是这样一个重新指向变量名的作用(name binding),让同一个变量名指向一个新返回的可调用对象,从而达到修改可调用对象的目的。

与加工函数类似,我们可以使用装饰器加工类的方法。

如果我们有其他的类似函数,我们可以继续调用decorator来修饰函数,而不用重复修改函数或者增加新的封装。这样,我们就提高了程序的可重复利用性,并增加了程序的可读性。

含参的装饰器

在上面的装饰器调用中,比如@decorator,该装饰器默认它后面的函数是唯一的参数。装饰器的语法允许我们调用decorator时,提供其它参数,比如@decorator(a)。这样,就为装饰器的编写和使用提供了更大的灵活性。

# a new wrapper layer
def pre_str(pre=''):# old decoratordef decorator(F):def new_F(a, b):print(pre + "input", a, b)return F(a, b)return new_Freturn decorator# get square sum
@pre_str('^_^')
def square_sum(a, b):return a**2 + b**2# get square diff
@pre_str('T_T')
def square_diff(a, b):return a**2 - b**2print(square_sum(3, 4))
print(square_diff(3, 4))

上面的pre_str是允许参数的装饰器。它实际上是对原有装饰器的一个函数封装,并返回一个装饰器。我们可以将它理解为一个含有环境参量的闭包。当我们使用@pre_str('^_^')调用的时候,Python能够发现这一层的封装,并把参数传递到装饰器的环境中。该调用相当于:

square_sum = pre_str('^_^') (square_sum)

装饰类

在上面的例子中,装饰器接收一个函数,并返回一个函数,从而起到加工函数的效果。在Python 2.6以后,装饰器被拓展到类。一个装饰器可以接收一个类,并返回一个类,从而起到加工类的效果。

def decorator(aClass):class newClass:def __init__(self, age):self.total_display   = 0self.wrapped         = aClass(age)def display(self):self.total_display += 1print("total display", self.total_display)self.wrapped.display()return newClass@decorator
class Bird:def __init__(self, age):self.age = agedef display(self):print("My age is",self.age)eagleLord = Bird(5)
for i in range(3):eagleLord.display()

在decorator中,我们返回了一个新类newClass。在新类中,我们记录了原来类生成的对象(self.wrapped),并附加了新的属性total_display,用于记录调用display的次数。我们也同时更改了display方法。

通过修改,我们的Bird类可以显示调用display的次数了。

总结

装饰器的核心作用是name binding。这种语法是Python多编程范式的又一个体现。大部分Python用户都不怎么需要定义装饰器,但有可能会使用装饰器。鉴于装饰器在Python项目中的广泛使用,了解这一语法是非常有益的。

相关内容

热门资讯

关于金庸武侠杨过的评价 关于金庸武侠杨过的评价有情有意 婆婆妈妈侠之大者为国为民其实他和小龙女都不是完美的人,但是他们却深入...
写给你留下深刻印象的动画片片段... 写给你留下深刻印象的动画片片段你也可以讲讲最吸引你的人物或故事片段写话 《夏目友人帐》中的片段:树...
铁桶江山的意思及成语解释 铁桶江山的意思及成语解释铁桶江山 [ tiě tǒng jiāng shān ] 生词本基本释义 详...
投稿了第五届计算机与通信工程技... 投稿了第五届计算机与通信工程技术国际会议,请问大家提交了多久适合催稿?催稿后容易被拒吗,好着急啊。一...
有什么地方可以卖猫的 有什么地方可以卖猫的有什么地方可以?卖猫吗?宠物市场就可以卖猫。到那个地方。会有买卖的,买卖猫的地方...
老武侠电视剧 老武侠电视剧雪花神剑 里聂小凤的兵器挺有趣的
得了银屑病,该注意哪些问题 得了银屑病,该注意哪些问题饮食上少接触酒、海鲜、忌辛辣,多吃新鲜水果、蔬菜。尽可能避免感冒、扁桃腺炎...
宝宝第一次开口叫妈妈时,你是什... 宝宝第一次开口叫妈妈时,你是什么心情?我是非常感动的,我感觉自己做什么事情都是值得的,孩子叫自己母亲...
先填成语,后归纳. 先填成语,后归纳.开(天 )辟(地 ) 精卫(填 )(海 ) (邯郸 )学步 (螳 )(臂 )挡车 ...
卖萝卜的故事 卖萝卜的故事商人骑一头驴要穿越1000公里长的沙漠,去卖3000根胡萝卜。驴一次性可驮1000根胡萝...
cctalk课程名片是自己的名... cctalk课程名片是自己的名字吗可以是的在cctalk群聊中我们是可以对自己的课程名片进行设置的,...
有什么好看的历史书 有什么好看的历史书没有什么谁都觉得好看的书。(包括历史书)。萝卜青菜,各有所爱。就像我原来觉得好看的...
为什么我对一个人有一种奇怪的感... 为什么我对一个人有一种奇怪的感觉为什么我对一个人始终有种奇怪的感觉 一种让我说不出来的感觉 有谁知道...
消银片吃完一个月有效果吗 消银片吃完一个月有效果吗这个效果具体还是要根据个人的吸收程度,如果你吸收程度比较好的话,可能一个月就...
刺客信条里“安息吧”的英文是什... 刺客信条里“安息吧”的英文是什么Requiescat in pace是意大利语rest in pea...
夜听中这一刻的文字 夜听中这一刻的文字夜听中这一刻的文字... 夜听中这一刻的文字 展开你可以用EXCEL中的“自动...
伯玉毁琴故事完整版? 伯玉毁琴故事完整版?这是一个高山流水的故事。伯牙与子期。子期死后,伯牙没有了知己。就把自己的琴毁掉了...
说说愉快的心情的句子幽默 说说愉快的心情的句子幽默1、微笑拥抱每一天,做像葵花般和煦的女子。2、最好的脸部保养品,就是微笑与善...
中冶天工国际工程分公司 待遇 中冶天工国际工程分公司 待遇不请自来的招聘,你非要去信? 不在本地的公司,非要千里迢迢的找你?这个单...
《红高粱家族》读后感? 《红高粱家族》读后感?戴凤莲留住准备散伙的长工们,成了烧酒作坊的新主人。为头的罗汉大叔,继续主事。他...