Python Decorator

flask中有很多装饰器,今天来整理下Python中装饰器的相关概念。

1. 最简单的装饰器

我们常常可以看到类似这样的代码:

@decorator
def fun():
    # ...
    return res

这里定义函数fun的时候用了一个名为decorator的装饰器,使得最终定义出来的fun成为了一个被装饰过的fun。@其实是一种语法糖,等效于以下代码:

def fun():
    # ...
    return res

fun = decorator(fun)

这应该比较好懂。其实@语法会调用decorator对象,并将原来的fun作为第一个参数传入,再用decorator的返回值取代掉原来的fun,就这么简单。
而装饰器本身可能会这么写:

def decorator(fun):
    def decorated_fun():
        # do sth before fun
        res = fun()
        # do sth after fun
        return res
    return decorated_fun

这个装饰器本身是个函数,唯一的参数是个函数,返回值也是个函数。作用就是在原函数之前和之后加一些代码,变成一个装饰过的函数再返回。

2. 被装饰的函数带有参数

需要被装饰的函数往往是有传入参数的。因此装饰器加工之后的函数也应该能正确处理这些参数。要实现其实也很简单,比如原函数有*args, **kwargs这样的参数,装饰器一般就该这么写:

def decorator(fun):
    def decorated_fun(*args, **kwargs):
        # do sth before fun
        res = fun(*args, **kwargs)
        # do sth after fun
        return res
    return decorated_fun

decorator还是接收原函数fun这一个参数,而是其中定义的decorated_fun则和原函数一样,接收*args, **kwargs,同时将其传递给原函数执行。

3. 装饰器本身带有参数

如果不用@语法糖,装饰器可以想传多少个参数就传多少个参数。比如说这样的装饰器:

def decorator(fun, foo, bar):
    def decorated_fun(*args, **kwargs):
        # do sth before fun with foo
        res = fun(*args, **kwargs)
        # do sth after fun with bar
        return res
    return decorated_fun

由于闭包这一概念,在decorator内部,foo和bar都是可以随意调用的,包括在其中定义的decorated_fun内部。
这个带有foo和bar参数的装饰器,可以这样调用:

def fun():
    # ...
    return res

fun = decorator(fun, foo='foo', bar='bar')

用了语法糖的代价,就是需要按照一定的规则来进行编码。比如@语法就只能传递一个参数给装饰器,也就是原函数。想要用@语法,则可以这么做:

def decorator_with_param(foo, bar)
    def decorator(fun):
        def decorated_fun(*args, **kwargs):
            # do sth before fun with foo
            res = fun(*args, **kwargs)
            # do sth after fun with bar
            return res
        return decorated_fun
    return decorator

这样调用:

@decorator_with_param(foo, bar)
def fun()
    # ...
    return res

这其实等价于:

:::python
decorator = decorator_with_param(foo, bar)
@decorator
def fun():
    # ...
    return res

也等价于:

def fun():
    # ...
    return res

fun = decorator_with_param(foo, bar)(fun)

这挺有意思的。首先decorator_with_param函数接收foo和bar2个参数,返回值是个函数。接着这个函数作为一个装饰器,接收一个fun参数,然后会调用foo和bar来装饰这个fun。还是由于闭包这个概念,所以在decorator_with_param内部可以随意使用foo和bar。我觉得这段文字比较难懂,还是看代码吧。

4. 用class写装饰器

装饰器也可以用class来写,比如这样:

class Decorator(object):
    def __init__(self, foo, bar):
        self.foo = foo
        self.bar = bar

    def __call__(self, fun):
        def decorated_fun(*args, **kwargs):
            # do sth before fun with self.foo
            res = fun(*args, **kwargs)
            # do sth after fun with self.bar
            return res
        return decorated_fun

调用还是一样:

@Decorator(foo, bar)
def fun()
    # ...
    return res

这更有意思了。首先Decorator(foo, bar)会生成一个Decorator的实例,有foo和bar这2个实例变量。然后按照@语法,调用这个实例,并将fun这个原函数作为参数传入。也就是会调用__call__方法,__call__的返回值和前面一样,就是被装饰好的函数了。

另外,装饰器还可以用来做register之类的工作,下次有机会再写。

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

推荐阅读更多精彩内容