Learn Python 3:装饰器

一、理解装饰器

通俗点说,当我们想给一个函数增强额外的功能,但又不想修改原函数的定义,同时新增的功能其它函数可能也需要使用,装饰器就是来解决这种需求的,将与原函数功能无关的代码提取出来,实现复用,在代码运行期间动态的给原函数增加功能,例如在函数执行前后插入日志、计算函数的执行时间等等

二、实践

1、一个小需求

有一个需求,要在函数执行前后打印start executeend execute,如果我们还不知道有装饰器存在可以怎么做呢?

首先定义原函数:

def my_func():
    print('Hello World')

再定义一个函数用来打印日志,并在其中执行原函数:

def log(func):
    def wrapper():
        print('start execute')
        func()
        print('end execute')
    return wrapper

可以看到,log函数接收一个函数作为参数,并返回一个新的wrapper函数。

最后看执行结果:

my_func = log(my_func)
my_func()
0

我们将my_func函数作为参数传给log函数,并将返回的wrapper函数赋值给my_func变量,则my_func变量就是返回的wrapper函数,并不是之前定义的my_func函数,最后执行my_func()其实执行的是返回的wrapper函数。到这里已经实现了前边的小需求,其实装饰器的原理亦是如此。

2、使用装饰器

如果使用装饰器怎么写呢?先不需要修改log函数,只对my_func函数做修改:

@log
def my_func():
    print('Hello World')

很明显吧,用Python的 @ 语法实现装饰器,实现log函数对my_func函数的装饰。

再看执行结果:


1

其实装饰器相当于替我们执行了my_func = log(my_func)这一步。
但是有个问题,按理my_func函数的__name__属性应该是my_func,但使用装饰器后变成了wrapper

2

其实就是前边讲的赋值操作my_func = log(my_func)导致的,这当然不是我们想看到的,可以用Python内置functools模块的wraps()方法,修改我们的log函数:

def log(func):
    @functools.wraps(func)
    def wrapper():
        print('start execute')
        func()
        print('end execute')
    return wrapper

再执行结果:


3

3、带参数的被装饰函数

如果my_func函数有参数呢?像这样:

def my_func(a, b):
    print('a+b=%d' % (a + b))

当然还要修改log函数,怎么改呢,这样???给wrapper加两个参数???

def log(func):
    @functools.wraps(func)
    def wrapper(a, b):
        print('start execute')
        func(a, b)
        print('end execute')
    return wrapper

如果其它函数的参数个数、参数形式和my_func不同,也想使用log作为装饰器,那这样修改log肯定不行......,可以这样,让装饰器内嵌的wrapper函数支持可变参数以及关键字参数:

def log(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
        print('start execute')
        func(*args, **kw)
        print('end execute')
    return wrapper

这样其它函数也就能共用这个log函数了,要不然还搞啥装饰器。现在使用修改后的log函数:

@log
def my_func(a, b):
    print('a+b=%d' % (a + b))

再来一个my_func1函数:

@log
def my_func1(a, b, c, *, d):
    print('a+b+c+d=%d' % (a + b + c + d))

看下执行结果:


4

my_func为例,这时候使用装饰器执行my_func(1, 2)相当于执行了log(my_func)(1, 2)

4、带参数的装饰器函数

如果装饰器函数本身也需要参数呢?继续以log函数为例,现在需要接受一个字符串为参数,并在被装饰函数执行前打印,则可以给它在内嵌一层函数:

def log(arg):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print('装饰器的参数:%s' % arg)
            print('start execute')
            func(*args, **kw)
            print('end execute')
        return wrapper
    return decorator

这时再给my_func添加装饰器:

@log('Hello World')
def my_func(a, b):
    print('a+b=%d' % (a + b))

执行结果如下:


5

此时相当于执行了log('Hello World')(my_func)(1, 2)

5、参数可选的装饰器函数

我们继续扩展装饰器函数log的功能,使其既支持:

@log('Hello World')
def my_func(a, b):
    print('a+b=%d' % (a + b))

又要支持:

@log
def my_func(a, b):
    print('a+b=%d' % (a + b))

即参数可选,怎么修改呢?前边已经说过了,第一种情况执行my_func(1, 2)相当于log('Hello World')(my_func)(1, 2),其中log('Hello World')先执行,返回接受my_func为参数的decorator函数,第二种情况执行相当于log(my_func)(1, 2),其中log(my_func)先执行,返回的是接受1、2为参数的wrapper函数。所以我们让log函数在两种情况下分别返回不同的函数,即log函数的参数为函数时其返回wrapper函数,即decorator(arg)log函数的参数为字符串时让其返回decorator函数,至于打印log的字符串参数,只需要判参数是字符串再打印即可:

def log(arg):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            if arg and isinstance(arg, str):
                print('装饰器的参数:%s' % arg)
            print('start execute')
            func(*args, **kw)
            print('end execute')
        return wrapper
    if callable(arg):
        return decorator(arg)
    return decorator

1、isinstance(arg, str):判断arg是否为str类型
2、callable(arg):判断arg是否可被调用,可被调用指的是能否使用()括号的方法调用。

测试结果如下:


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

推荐阅读更多精彩内容

  • //Clojure入门教程: Clojure – Functional Programming for the J...
    葡萄喃喃呓语阅读 3,502评论 0 7
  • Python进阶框架 希望大家喜欢,点赞哦首先感谢廖雪峰老师对于该课程的讲解 一、函数式编程 1.1 函数式编程简...
    Gaolex阅读 5,466评论 6 53
  • 一.函数装饰器 1.从Python内层函数说起 首先我们来探讨一下这篇文章所讲的内容Inner Functions...
    软体动物Ai阅读 3,216评论 0 14
  • 今天起来的很早… 本来想发条微博的… 可是… 编了五个小时… 竟然没编出来… 我想了想… 还是要写点什么… 才能对...
    计学撮要_阅读 68评论 0 0
  • 老李头醒过来的时候,饭已经做好了,粥的香味通过客厅,渗透到卧室里来,寒冬里,破旧的老楼虽然烧了暖气,但是还是很冷,...
    对方正在输出_阅读 271评论 3 3