Python装饰器

什么是装饰器?

类似于Java的注解。在python中叫做装饰器,目的是用于对已存在代码进行修改。这里的修改是狭义的,并非任意的修改,而是能够对其执行过程进行编译时修改。

最简单示例

def DecoratorTest(fun):
    def _T_fun_(id):
        print("before call -----")
        fun(id)
        print("after call -----")
    return _T_fun_

@DecoratorTest
def OutputX(id):
    print(id)

OutputX(20)

输出结果:

before call -----
20
after call -----

在没有使用装饰器之前,输出20,使用装饰器之后,实现了对OutputX函数的逻辑修改,这个就是装饰器的作用。

有什么用?

虽然前一个章节中,大致说明了装饰器的用法,但很多人还是不会用,原因在于不知道到底这个功能应该应用于什么场景。如果螺丝刀只是被描述为一头是一字形或十字形的器具,可能即使遇到一个螺丝,都不会想到螺丝刀,所以将工具与场景紧密关联是很重要的。装饰器常用的就两个场景:

  1. 构建流程注入,例如注入日志、性能分析处理;
  2. 程序扩展实现,适合在处理流程中添加具体扩展实现,实现类似回调功能;

怎么用?

流程注入

假设一个场景:设计了一个系统,希望在某个场景下可以记录系统内函数的执行过程信息,帮助进行问题定位,实现类似日志的功能。
简化原系统实现如下:

def FunA(a):
  return a+20
def FunB(a, b):
  return a+b
def FunC(a, b):
  return FunA(a)+FunB(a, b)

print(FunC(30,40))

输出结果为:

120

这时,发现输出数字与预期不相符,怎么办?除了调试,如果希望通过日志来定位解决问题,那么修改系统实现如下:

def AFun(fun):
    def CallBack(*args, **args2):
        print("befor call "+getattr(fun,"__name__"))
        ret = fun(*args, **args2)
        if ret is not None:
            print("Return:")
            print(ret)
        print("befor call "+getattr(fun,"__name__"))
        return ret
    return CallBack
        
@AFun
def FunA(a):
  return a+20
@AFun
def FunB(a, b):
  return a+b
@AFun
def FunC(a, b):
  return FunA(a)+FunB(a, b)

print(FunC(30,40))

最终输出如下:

befor call FunC
befor call FunA
Return:
50
befor call FunA
befor call FunB
Return:
70
befor call FunB
Return:
120
befor call FunC
120

通过这种方式,在不修改原代码逻辑的基础上,添加了日志执行输出功能,还可以对调用过程进行时间统计,分析系统的性能瓶颈。

扩展实现

假设场景:假设设计一个web框架,最起码一个需求就是用户可以扩展定义响应链接,例如响应“/a/b"的"get"请求。有两种设计方式,先看正常常规设计方式:

url_processors = {}
def WebEngine(url, method):
    if url in url_processors and method in url_processors[url]:
        return url_processors[url][method]()
    else:
        return 404

def ProcessA():
    print("in process A")
    return "Hello A"

url_processors["/A"] = {}
url_processors["/A"]["get"] = ProcessA

print(WebEngine("/A", "get"))
print(WebEngine("/B", "get"))

执行输出结果如下:

in process A
Hello A
404

从上边看到,修改响应信息,需要维护两个地方的代码,容易带来不一致问题,也提升了维护成本。利用装饰器如何解决这个问题,代码示例如下:

url_processors = {}
def WebEngine(url, method):
    global url_processors
    if url in url_processors and method in url_processors[url]:
        return url_processors[url][method]()
    else:
        return 404

def DeclMethod( url="", method=""):
    def DSF(fun):
        global url_processors
        
        url_processors[url] = {}
        url_processors[url][method] = fun
    return DSF


@DeclMethod(url="/A", method="get")
def ProcessA():
    print("in process A")
    return "Hello A"

print(WebEngine("/A", "get"))
print(WebEngine("/B", "get"))

从代码上看,扩展一个响应,只需要在函数前添加具体的扩展装饰声明即可。执行结果如下:

in process A
Hello A
404

总结

在学习过程中,需要将工具与场景进行联系,在场景的解决实践中,会发现很多其他不足,例如在上例中,涉及了不定长参数的处理,装饰器参数的处理。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容

  • 本文转自http://mingxinglai.com/cn/2015/08/python-decorator/ [...
    Jlan阅读 546评论 0 5
  • 装饰器是程序开发中经常会用到的一个功能,功能就是在运行原来功能基础上,加上一些其它功能,比如权限的验证,比如日志的...
    壁花烧年阅读 245评论 0 0
  • 在python编程中,我们经常看到下面的函数用法: with open("test.txt", "w") as f...
    hugoren阅读 799评论 0 0
  • 一 装饰器介绍 1.1 为何要用装饰器 软件的设计应该遵循开放封闭原则,即对扩展是开放的,而对修改是封闭的。对扩展...
    100斤的瘦子_汤勇阅读 562评论 0 0
  • 表情是什么,我认为表情就是表现出来的情绪。表情可以传达很多信息。高兴了当然就笑了,难过就哭了。两者是相互影响密不可...
    Persistenc_6aea阅读 123,910评论 2 7