Python 装饰器语法详解

Python 装饰器(decorator)是一种语法糖(Syntactic sugar),

@d
def foo():
    pass

以上代码和以下代码是等价的:

foo = d(foo)

进一步说,

@d(param)
def foo():
    pass

和下面代码是等价的

foo = (d(param))(foo)

他们的实质都是传入一个函数对象,进行“装饰”后返回装饰好的另一个函数对象。

返回函数对象的函数

Python 中的函数是一个对象(object),它可以像任何其他对象一样被创建、引用、传递和销毁。引用函数对象的方法是使用它的函数名,如 foo 引用的是一个函数对象,而 foo() 则是其返回值了。

得益于函数在 Python 中一等公民的地位,你可以在一个函数中返回另一个函数,接受函数作为参数或返回函数的函数,称为高阶函数(higher-order function)。

看下面的例子:

def f(a):
    def g(b):
        def h(c):
            print(a, b, c)
        return h
    return g

In [2]: f(1)(2)(3)
1 2 3

In [3]: g = f(4)

In [4]: g(5)(6)
4 5 6

这是在函数式编程中被称为柯里化(currying)的东西,被柯里化后的高阶函数 f 其实是这样执行的:

((f(1))(2))(3)

首先执行的 f(1),返回其内部定义的函数对象 g,接着执行 g(2),返回了 g 内部定义的对象 h,以此类推。

不带参数的装饰器函数

最简单的情形就是不带参数的装饰器函数。
给函数 foo 使用装饰器 d,等价于

foo = d(foo)

为了定义装饰器 d,必须使其接受一个函数对象参数,并返回一个函数对象,而要返回一个函数对象,就需要在 d 内部新定义一个函数对象。这个内部的函数对象有什么特点呢?它接受 foo 的参数,运行 foo 的代码,并返回 foo 的返回值,当然还做了装饰器需要做的额外工作。

按照以上需求,装饰器 d 的代码就可以写出了。

def d(f):
    def wrapper(*args, **kwargs):
        # do something
        res = f(*args, **kwargs)
        # do something
        return res
    
    return wrapper

d(foo) 返回了函数对象 wrapper,而变量 foo 指向了它。foo 不再是原来的那个 foo,装饰器赋予了它额外的功能。

如果需要的话,d 其实是可以这样被调用的:

In [35]: def foo(n):
    ...:     return n + 1
    ...:

In [36]: d(foo)(2)
Out[36]: 3

是不是就是上面柯里化的形式?

另一种装饰器就更容易理解了:

def d(f):
    f.__some_attr__ = 'attr'
    return f

根本就没有重新定义一个函数对象,改了 f 的某个属性就把它扔出来了。

带参数的装饰器函数

带参数的装饰器函数这样使用:

@d(param)
def foo(n):
    return n + 1

它等价于

foo = d(param)(foo)

为此,首先需要定义一个接受装饰器参数 param 的函数,接着再定义接受 foo 为参数的函数,最后是接受函数 foo 本身参数为参数的函数,除了最内层函数返回 foo() 运行结果外,其他函数都返回一个函数对象。

def d(param):
    def outter(f):
        def inner(*args, **kwargs):
            # do something
            res = f(*args, **kwargs)
            # do something
            return res
        return inner
    return outter

你当然也可以这样调用 d:

d(param)(foo)(3)

callable

如果一个类的实例 instance 具有 __call__ 方法,那么这个实例就是一个 callable,instance() 就相当于 instance.__call__()。

不带参数的装饰器类

仍然沿用以上对装饰器语法糖的解释,对函数 foo 使用装饰器类 D,等价于

foo = D(foo)

foo 对象应该在 D.__init__() 中被传入,得到一个 callable,而 foo 在 D.__call__() 中被执行。所以一个不带参数的装饰器类应该写成这样:

class D(object):
    def __init__(self, f):
        self.f = f
        
    def __call__(self, *args, **kwargs):
        # do something
        res = self.f(*args, **kwargs)
        # do something
        return res

带参数的装饰器类

使用带参数的装饰器类,等价于

foo = D(params)(foo)

可以知道,装饰器的参数 params 在 D.__init__() 中被传入,而 D.__call__() 接受函数对象 foo, 返回装饰后的函数对象。因而装饰器类是这样的:

class D(object):
    def __init__(self, param):
        self.param = param
        
    def __call__(self, f):
        def wrapper(*args, **kwargs):
            # do something
            res = f(*args, **kwargs)
            # do something
            return res
        
        return wrapper

总结

本文提供了将装饰器转化成高阶函数表达的一种范式,根据这一范式,可以直接推导出四种装饰器(带参/不带参、函数/类)的写法。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • 前言 人生苦多,快来 Kotlin ,快速学习Kotlin! 什么是Kotlin? Kotlin 是种静态类型编程...
    任半生嚣狂阅读 26,139评论 9 118
  • 本文为《爬着学Python》系列第四篇文章。从本篇开始,本专栏在顺序更新的基础上,会有不规则的更新。 在Pytho...
    SyPy阅读 2,483评论 4 11
  • 这天中午十二点半你发来微信问我:吃饭了吗?我没有看见。十二点四十,你又问我:在干什么,为什么不回消息。等看见的时候...
    张扬趁年华阅读 173评论 2 2
  • 1、拉流: clone git clone git@github.com:arnozhang/Android-Sl...
    牧秦丶阅读 222评论 0 0