Python中的装饰器用法详解

发表于 5年以前  | 总阅读数:1124 次

本文实例讲述了Python中的装饰器用法。分享给大家供大家参考。具体分析如下:

这里还是先由stackoverflow上面的一个问题引起吧,如果使用如下的代码:

复制代码 代码如下:

@makebold
@makeitalic
def say():
return "Hello"

打印出如下的输出:

Hello
你会怎么做?最后给出的答案是:

复制代码 代码如下:

def makebold(fn):
def wrapped():
return "" + fn() + ""
return wrapped

def makeitalic(fn):
def wrapped():
return "" + fn() + ""
return wrapped

@makebold
@makeitalic
def hello():
return "hello world"

print hello() ## 返回 hello world

现在我们来看看如何从一些最基础的方式来理解Python的装饰器。

装饰器是一个很著名的设计模式,经常被用于有切面需求的场景,较为经典的有插入日志、性能测试、事务处理等。装饰器是解决这类问题的绝佳设计,有了装饰器,我们就可以抽离出大量函数中与函数功能本身无关的雷同代码并继续重用。概括的讲,装饰器的作用就是为已经存在的对象添加额外的功能。

1.1. 需求是怎么来的?

装饰器的定义很是抽象,我们来看一个小例子。

复制代码 代码如下:

def foo():
print 'in foo()'
foo()

这是一个很无聊的函数没错。但是突然有一个更无聊的人,我们称呼他为B君,说我想看看执行这个函数用了多长时间,好吧,那么我们可以这样做:

复制代码 代码如下:

import time
def foo():
start = time.clock()
print 'in foo()'
end = time.clock()
print 'used:', end - start

foo()

很好,功能看起来无懈可击。可是蛋疼的B君此刻突然不想看这个函数了,他对另一个叫foo2的函数产生了更浓厚的兴趣。

怎么办呢?如果把以上新增加的代码复制到foo2里,这就犯了大忌了~复制什么的难道不是最讨厌了么!而且,如果B君继续看了其他的函数呢?

1.2. 以不变应万变,是变也

还记得吗,函数在Python中是一等公民,那么我们可以考虑重新定义一个函数timeit,将foo的引用传递给他,然后在timeit中调用foo并进行计时,这样,我们就达到了不改动foo定义的目的,而且,不论B君看了多少个函数,我们都不用去修改函数定义了!

复制代码 代码如下:

import time

def foo():
print 'in foo()'

def timeit(func):
start = time.clock()
func()
end =time.clock()
print 'used:', end - start

timeit(foo)

看起来逻辑上并没有问题,一切都很美好并且运作正常!……等等,我们似乎修改了调用部分的代码。原本我们是这样调用的:foo(),修改以后变成了:timeit(foo)。这样的话,如果foo在N处都被调用了,你就不得不去修改这N处的代码。或者更极端的,考虑其中某处调用的代码无法修改这个情况,比如:这个函数是你交给别人使用的。

1.3. 最大限度地少改动!

既然如此,我们就来想想办法不修改调用的代码;如果不修改调用代码,也就意味着调用foo()需要产生调用timeit(foo)的效果。我们可以想到将timeit赋值给foo,但是timeit似乎带有一个参数……想办法把参数统一吧!如果timeit(foo)不是直接产生调用效果,而是返回一个与foo参数列表一致的函数的话……就很好办了,将timeit(foo)的返回值赋值给foo,然后,调用foo()的代码完全不用修改!

复制代码 代码如下:

-- coding: UTF-8 --

import time

def foo():
print 'in foo()'

定义一个计时器,传入一个,并返回另一个附加了计时功能的方法

def timeit(func):

# 定义一个内嵌的包装函数,给传入的函数加上计时功能的包装  
def wrapper():  
    start = time.clock()  
    func()  
    end =time.clock()  
    print 'used:', end - start  

# 将包装后的函数返回  
return wrapper  

foo = timeit(foo)
foo()

这样,一个简易的计时器就做好了!我们只需要在定义foo以后调用foo之前,加上foo = timeit(foo),就可以达到计时的目的,这也就是装饰器的概念,看起来像是foo被timeit装饰了。在在这个例子中,函数进入和退出时需要计时,这被称为一个横切面(Aspect),这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。与传统编程习惯的从上往下执行方式相比较而言,像是在函数执行的流程中横向地插入了一段逻辑。在特定的业务领域里,能减少大量重复代码。面向切面编程还有相当多的术语,这里就不多做介绍,感兴趣的话可以去找找相关的资料。

这个例子仅用于演示,并没有考虑foo带有参数和有返回值的情况,完善它的重任就交给你了 :)

上面这段代码看起来似乎已经不能再精简了,Python于是提供了一个语法糖来降低字符输入量。

复制代码 代码如下:

import time

def timeit(func):
def wrapper():
start = time.clock()
func()
end =time.clock()
print 'used:', end - start
return wrapper

@timeit
def foo():
print 'in foo()'

foo()

重点关注第11行的@timeit,在定义上加上这一行与另外写foo = timeit(foo)完全等价,千万不要以为@有另外的魔力。除了字符输入少了一些,还有一个额外的好处:这样看上去更有装饰器的感觉。

要理解python的装饰器,我们首先必须明白在Python中函数也是被视为对象。这一点很重要。先看一个例子:

复制代码 代码如下:

def shout(word="yes") :
return word.capitalize()+" !"

print shout()

输出 : 'Yes !'

作为一个对象,你可以把函数赋给任何其他对象变量

scream = shout

注意我们没有使用圆括号,因为我们不是在调用函数

我们把函数shout赋给scream,也就是说你可以通过scream调用shout

print scream()

输出 : 'Yes !'

还有,你可以删除旧的名字shout,但是你仍然可以通过scream来访问该函数

del shout
try :
print shout()
except NameError, e :
print e

输出 : "name 'shout' is not defined"

print scream()

输出 : 'Yes !'

我们暂且把这个话题放旁边,我们先看看python另外一个很有意思的属性:可以在函数中定义函数:

复制代码 代码如下:

def talk() :

# 你可以在talk中定义另外一个函数  
def whisper(word="yes") :  
    return word.lower()+"...";  

# ... 并且立马使用它  

print whisper()  

你每次调用'talk',定义在talk里面的whisper同样也会被调用

talk()

输出 :

yes...

但是"whisper" 不会单独存在:

try :
print whisper()
except NameError, e :
print e

输出 : "name 'whisper' is not defined"*

函数引用

从以上两个例子我们可以得出,函数既然作为一个对象,因此:

1. 其可以被赋给其他变量

2. 其可以被定义在另外一个函数内

这也就是说,函数可以返回一个函数,看下面的例子:

复制代码 代码如下:

def getTalk(type="shout") :

# 我们定义另外一个函数  
def shout(word="yes") :  
    return word.capitalize()+" !"  

def whisper(word="yes") :  
    return word.lower()+"...";  

# 然后我们返回其中一个  
if type == "shout" :  
    # 我们没有使用(),因为我们不是在调用该函数  
    # 我们是在返回该函数  
    return shout  
else :  
    return whisper  

然后怎么使用呢 ?

把该函数赋予某个变量

talk = getTalk()

这里你可以看到talk其实是一个函数对象:

print talk

输出 : <function shout at 0xb7ea817c>

该对象由函数返回的其中一个对象:

print talk()

或者你可以直接如下调用 :

print getTalk("whisper")()

输出 : yes...

还有,既然可以返回一个函数,我们可以把它作为参数传递给函数:

复制代码 代码如下:

def doSomethingBefore(func) :
print "I do something before then I call the function you gave me"
print func()

doSomethingBefore(scream)

输出 :

I do something before then I call the function you gave me

Yes !

这里你已经足够能理解装饰器了,其他它可被视为封装器。也就是说,它能够让你在装饰前后执行代码而无须改变函数本身内容。

手工装饰

那么如何进行手动装饰呢?

复制代码 代码如下:

装饰器是一个函数,而其参数为另外一个函数

def my_shiny_new_decorator(a_function_to_decorate) :

# 在内部定义了另外一个函数:一个封装器。  
# 这个函数将原始函数进行封装,所以你可以在它之前或者之后执行一些代码  
def the_wrapper_around_the_original_function() :  

    # 放一些你希望在真正函数执行前的一些代码  
    print "Before the function runs"  

    # 执行原始函数  
    a_function_to_decorate()  

    # 放一些你希望在原始函数执行后的一些代码  
    print "After the function runs"  

#在此刻,"a_function_to_decrorate"还没有被执行,我们返回了创建的封装函数  
#封装器包含了函数以及其前后执行的代码,其已经准备完毕  
return the_wrapper_around_the_original_function  

现在想象下,你创建了一个你永远也不远再次接触的函数

def a_stand_alone_function() :
print "I am a stand alone function, don't you dare modify me"

a_stand_alone_function()

输出: I am a stand alone function, don't you dare modify me

好了,你可以封装它实现行为的扩展。可以简单的把它丢给装饰器

装饰器将动态地把它和你要的代码封装起来,并且返回一个新的可用的函数。

a_stand_alone_function_decorated = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function_decorated()

输出 :

Before the function runs

I am a stand alone function, don't you dare modify me

After the function runs

现在你也许要求当每次调用a_stand_alone_function时,实际调用却是a_stand_alone_function_decorated。实现也很简单,可以用my_shiny_new_decorator来给a_stand_alone_function重新赋值。

复制代码 代码如下:

a_stand_alone_function = my_shiny_new_decorator(a_stand_alone_function)
a_stand_alone_function()

输出 :

Before the function runs

I am a stand alone function, don't you dare modify me

After the function runs

And guess what, that's EXACTLY what decorators do !

装饰器揭秘

前面的例子,我们可以使用装饰器的语法:

复制代码 代码如下:

@my_shiny_new_decorator
def another_stand_alone_function() :
print "Leave me alone"

another_stand_alone_function()

输出 :

Before the function runs

Leave me alone

After the function runs

当然你也可以累积装饰:

复制代码 代码如下:

def bread(func) :
def wrapper() :
print "</''''''>"
func()
print "<\__/>"
return wrapper

def ingredients(func) :
def wrapper() :
print "#tomatoes#"
func()
print "~salad~"
return wrapper

def sandwich(food="--ham--") :
print food

sandwich()

输出 : --ham--

sandwich = bread(ingredients(sandwich))
sandwich()

outputs :

</''''''>

#tomatoes#

--ham--

~salad~

<\__/>

使用python装饰器语法:

复制代码 代码如下:

@bread
@ingredients
def sandwich(food="--ham--") :
print food

sandwich()

输出 :

</''''''>

#tomatoes#

--ham--

~salad~

<\__/>

装饰器的顺序很重要,需要注意

复制代码 代码如下:

@ingredients
@bread
def strange_sandwich(food="--ham--") :
print food

strange_sandwich()

输出 :

tomatoes#

</''''''>

--ham--

<\__/>

~salad~

最后回答前面提到的问题:

复制代码 代码如下:

装饰器makebold用于转换为粗体

def makebold(fn):

结果返回该函数

def wrapper():  
    # 插入一些执行前后的代码  
    return "<b>" + fn() + "</b>"  
return wrapper  

装饰器makeitalic用于转换为斜体

def makeitalic(fn):

结果返回该函数

def wrapper():  
    # 插入一些执行前后的代码  
    return "<i>" + fn() + "</i>"  
return wrapper  

@makebold
@makeitalic
def say():
return "hello"

print say()

输出: hello

等同于

def say():
return "hello"
say = makebold(makeitalic(say))

print say()

输出: hello

内置的装饰器

内置的装饰器有三个,分别是staticmethod、classmethod和property,作用分别是把类中定义的实例方法变成静态方法、类方法和类属性。由于模块里可以定义函数,所以静态方法和类方法的用处并不是太多,除非你想要完全的面向对象编程。而属性也不是不可或缺的,Java没有属性也一样活得很滋润。从我个人的Python经验来看,我没有使用过property,使用staticmethod和classmethod的频率也非常低。

复制代码 代码如下:

class Rabbit(object):

def __init__(self, name):  
    self._name = name  

@staticmethod  
def newRabbit(name):  
    return Rabbit(name)  

@classmethod  
def newRabbit2(cls):  
    return Rabbit('')  

@property  
def name(self):  
    return self._name

这里定义的属性是一个只读属性,如果需要可写,则需要再定义一个setter:

复制代码 代码如下:

@name.setter
def name(self, name):
self._name = name

functools模块

functools模块提供了两个装饰器。这个模块是Python 2.5后新增的,一般来说大家用的应该都高于这个版本。但我平时的工作环境是2.4 T-T

2.3.1. wraps(wrapped[, assigned][, updated]):
这是一个很有用的装饰器。看过前一篇反射的朋友应该知道,函数是有几个特殊属性比如函数名,在被装饰后,上例中的函数名foo会变成包装函数的名字wrapper,如果你希望使用反射,可能会导致意外的结果。这个装饰器可以解决这个问题,它能将装饰过的函数的特殊属性保留。

复制代码 代码如下:

import time
import functools

def timeit(func):
@functools.wraps(func)
def wrapper():
start = time.clock()
func()
end =time.clock()
print 'used:', end - start
return wrapper

@timeit
def foo():
print 'in foo()'

foo()
print foo.name

首先注意第5行,如果注释这一行,foo.name将是'wrapper'。另外相信你也注意到了,这个装饰器竟然带有一个参数。实际上,他还有另外两个可选的参数,assigned中的属性名将使用赋值的方式替换,而updated中的属性名将使用update的方式合并,你可以通过查看functools的源代码获得它们的默认值。对于这个装饰器,相当于wrapper = functools.wraps(func)(wrapper)。

2.3.2. total_ordering(cls):
这个装饰器在特定的场合有一定用处,但是它是在Python 2.7后新增的。它的作用是为实现了至少ltlegtge其中一个的类加上其他的比较方法,这是一个类装饰器。如果觉得不好理解,不妨仔细看看这个装饰器的源代码:

复制代码 代码如下:

def total_ordering(cls):
"""Class decorator that fills in missing ordering methods"""
convert = {
'lt': [('gt', lambda self, other: other < self),
('le', lambda self, other: not other < self),
('ge', lambda self, other: not self < other)],
'le': [('ge', lambda self, other: other <= self),
('lt', lambda self, other: not other <= self),
('gt', lambda self, other: not self <= other)],
'gt': [('lt', lambda self, other: other > self),
('ge', lambda self, other: not other > self),
('le', lambda self, other: not self > other)],
'ge': [('le', lambda self, other: other >= self),
('gt', lambda self, other: not other >= self),
('lt', lambda self, other: not self >= other)]
}
roots = set(dir(cls)) & set(convert)
if not roots:
raise ValueError('must define at least one ordering operation: < > <= >=')
root = max(roots) # prefer lt to le to gt to ge
for opname, opfunc in convert[root]:
if opname not in roots:
opfunc.name = opname
opfunc.doc = getattr(int, opname).doc
setattr(cls, opname, opfunc)
return cls

希望本文所述对大家的Python程序设计有所帮助。

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237267次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8108次阅读
 目录