理解和使用Python装饰器

装饰器在 Python 中无处不在,功能强大。本篇介绍装饰器的原理和用法,力求通俗易懂。

我们从一个简单的例子开始,逐步展开。假设有一个函数,函数随便做点啥:

def foo():
    print("do something.")

foobar 在英语中相当于汉语的张三、李四,意思就是随便给个名字。现在要给这个函数增加点功能,比如在函数调用前和调用后都打印一个输出提示。我们日常开发中经常有这类横向插入的需求,比如日志、权限检查等等。在 Java 中,实现这个功能要用大代理模式,但在 Python 中却异常简单,我们只需要另外一个嵌套的函数,如下:

def outer(func):       
    def inner():
        print("before execution.")
        func()
        print("after execution.")

    return inner # 无括号

然后这样使用:

if __name__ == "__main__":    
    proxy = outer(foo)
    proxy()

程序输出:

before execution.
do something.
after execution.

在 Python 中,一切都是对象,函数也是对象。所以

proxy = outer(foo)

就是把 foo 函数作为参数传给 outer 函数,而 outer 函数呢,返回值为 inner 函数,所以 proxy 变量也参照inner 函数,再执行 proxy() 语句,就是调用 inner 函数,我们看内函数 inner 的代码,一共有三个语句:

print("before execution.")      # 打印输出
func()                          # 执行 foo() 函数
print("after execution.")       # 打印输出

Python 提供了装饰器语法糖·(@decorater_name),让我们使用这种嵌套的函数更加简单。下面是变更后的代码:

def outer(func):       
    def inner():
        # 代码同上,省略
    return inner 

@outer
def foo():
    print("do something.")

if __name__ == "__main__":    
    foo()

@outer 是一个语法糖,也就是我们所说的装饰器,这个 @outer 装饰器就是告诉 Python,在调用 foo 函数的时候,把它传给 outer 函数作为参数。outer 函数通过上述机制,既保证调用 foo 函数,也通过它自己的代码增强了 foo 的功能

上述代码为了说明机制,代码极其简化,一般化的装饰器代码是这样的:inner 函数有两个参数,以增加其灵活性。假设我们的需求实现一个 logger 装饰器,记录函数被调用的时间:

from datetime import datetime

def logger(func):
    def wrapper(*args, **kwargs):
        print ('[INFO] {}, function "{}" was called '.format(datetime.now(), func.__name__))
        return func(*args, **kwargs)
    return wrapper

@logger
def foo():
    print("do something.")

if __name__ == "__main__":    
    foo()

因为装饰器器外部函数需要以 function 作为参数,所以如果调用函数需要有信息需要传给装饰器,就需要再增加一层嵌套。

from datetime import datetime

def logger(msg):
    def decorator(func):
        def wrapper(*args, **kwargs):
            print('[INFO] {}, "{}" was called with message "{}"'.format(
                datetime.now(), func.__name__, msg))
            return func(*args, **kwargs)
        return wrapper
    return decorator

@logger("Maybe bored.")
def foo(name):
    print("do something, " + name)

foo('Johnny')

装饰器也可以基于类来实现,要求装饰器类实现 __init__() 方法和 __call__() 方法。类装饰器实现 logger 的代码如下:

from datetime import datetime

class logger(object):
    def __init__(self, func):
        self.func = func

    def __call__(self, *args, **kwargs):
        print ('[INFO] {}, function "{}" was called '.format(
            datetime.now(), self.func.__name__))

        return self.func(*args, **kwargs)

@logger
def foo():
    print("do something.")

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

推荐阅读更多精彩内容

  • 部分细节自己改了点,也加了点自己例子,基本上属于转载。转载出处:https://my.oschina.net/le...
    洛克黄瓜阅读 1,974评论 0 3
  • 呵呵!作为一名教python的老师,我发现学生们基本上一开始很难搞定python的装饰器,也许因为装饰器确实很难懂...
    TypingQuietly阅读 19,551评论 26 186
  • Python的装饰器的英文名叫Decorator,要对一个已有的模块做一些“修饰工作”,所谓修饰工作就是想给现有的...
    Spareribs阅读 676评论 1 11
  • 正在阅读的书:《人生的84000种可能》 阅读有效时间:30分钟 阅读中遇到的困难:笔记较为繁琐,需要学习思维导图...
    李聘2023阅读 101评论 0 0
  • 第一次为教育感到悲哀,它来自学生对副科的轻视,而代课的日子便是开始…… 2019年3月,我来到四川的一...
    桓朗阅读 193评论 0 2