浅析decorator

从功能上来说,decorator是为了在代码运行期间动态增加代码功能的一种方案(即:我们要增强函数的功能,但是又不希望修改函数的定义);
从实现上来说,decorator is a function that accepts a function as input and returns a new function as output.

先上代码来举个栗子:


example
import time
from functools import wraps

def timethis(func):
    '''
    Decorator that reports the executions time.
    '''
    @wraps(func)
    def wrapper(*args, **kwargs):
        start = time.time()
        result = func(*args, **kwargs)
        end = time.time()
        print(func.__name__, end - start)
        return result
    return wrapper

@timethis
def countdown(n):
    '''
    Counts down
    '''
    while n > 0:
        n -= 1

分析开始
我们先来看原始函数:

def countdown(n):
    '''
    Counts down
    '''
    while n > 0:
        n -= 1

这个函数的功能很简单,就是把输入的n减到0,也没有输出,所以没什么卵用。接下来我们决定开始增强它的功能,让它有卵用!!!

我决定给这个函数增加:
1.打印函数名字的功能
2.打印整个函数运行时间的功能

这两个功能我已经写好了,我把它写在了名为timethis的这个函数里面。我现在就来改造原函数!代码如下:

@timethis
def countdown(n):
    '''
    Counts down
    '''
    while n > 0:
        n -= 1

执行一下:print(countdown(100000))
输出结果:

countdown 0.014000892639160156
None

(不要在意这个None,之所以出现None是因为我们的coundown函数没有写返回值啊亲:P)

你现在肯定想问我加了什么特技,居然只写了一个@timethis就实现了增强函数功能这么神奇的事情!

讲解如下
@这个符号在微博里表示“点名”,或者“提醒某某人”的意思,在这里也是一样的。
@timethis写在了countdown函数定义的上面,就相当于countdown函数在微博上@了一下timethis,然后跟他说,“喂喂喂,内个谁,timethis啊,你帮我个忙啊。”

那么countdown函数具体是如何告诉timethis自己的需求的呢?timethis怎么知道要帮什么忙呢?

答案是:这些需求都已经写在了timethis函数的函数体里面,代码如下:

def timethis(func):
    '''
    Decorator that reports the executions time.
    '''
    @wraps(func)  #这句代码先不要考虑,我们在本文章的最后给大家分析
    def wrapper(*args, **kwargs):
        start = time.time()  #获取系统时间
        result = func(*args, **kwargs)
        end = time.time()  #我们获取了两次系统时间,它们相减得到的值就是函数的运行时间
        print(func.__name__, end - start)
        return result
    return wrapper

接下来我们一步步地还原这个函数的构建过程(注释我就不再写一遍了啊=_=):

1.我们接收一个没卵用的函数,对它进行改造后,返回一个niubility的新函数。

def timethis(func):  #func就是待改造的函数
    XXXXXXXXX   #对原函数func进行改造的代码
    return 一个增强后的新函数

2.由于我们返回了一个新函数,所以理所当然地,我们要在函数体中定义这个新函数。(我们给这个增强后的函数取一个名字wrapper吧,这个名字取得还是挺形象的呢:P
所以代码现在变成了如下的样子:

def timethis(func):
    def wrapper(*args, **kwargs):  #参数表写成这个样子,表示我们可以将任意参数传入这个函数,在本文章末尾我会对此用法进行简要说明
        XXXXXXXXX  #增加的新功能的代码
        return func(*args, **kwargs)  #返回之前函数原有功能的执行结果(虽然我们要增加新功能,但是函数原有的功能也不能丢了呀,所以这段代码是必要的)
    return wrapper  #这句话返回了强大的新函数

3.进一步地,函数变成了如下的样子:

def timethis(func):
    def wrapper(*args, **kwargs):
        start = time.time()  #获取系统时间
        result = func(*args, **kwargs)
        end = time.time()  #我们获取了两次系统时间,它们相减得到的值就是函数的运行时间
        print(func.__name__, end - start)
        return result
    return wrapper

到目前为止,我们基本上完成了decorator的编写和使用。
我们谈一下前面遗留的几个重要问题:

1.为什么要在wrapper函数的上面写@wraps(func) ?
答:为了保留原函数的一些原始信息,或者说保留函数的metedata.

当我们使用装饰器时(如下),

@timethis
def countdown(n):
    ...

我们相当于执行了如下代码:

def countdown(n):
    ...
countdown = timethis(countdown)

也就是说,我们返回了一个新函数后,还用旧函数的名字来使用它。那么问题来了,当我们通过这个函数来访问某些信息时(具体访问哪些信息我们接下来讨论),我们原本想访问旧函数的信息,可是由于被覆盖,我们只能访问到新函数的信息,这显然不是我们想要的结果。
从另一个角度想,我们使用装饰器只是想增强原函数的功能,没想让新函数取而代之啊!我们需要的还是旧函数啊!
好了,wrapper函数上面写的@wraps(func)就解决了这个问题。
我们来访问一些信息,以便验证我们刚才说的话:

condition 1:没写@wraps(func)时:

执行如下代码:

print(countdown.__name__)
print(countdown.__doc__)

输出如下:

wrapper
None

condition 2:写了@wraps(func)以后:

执行如下代码:

print(countdown.__name__)
print(countdown.__doc__)

输出如下:

countdown

    Counts down

由此可见,@wraps(func)是非常必要的。补充一点,要想使用@wraps(func)还需要在代码的开头写上from functools import wraps这么一句。

2.关于参数表(*args, **kwargs)
* 代表可变参数,** 代表关键字参数。至于参数的名字,其实无所谓,不过通常我们使用args来命名可变参数,用kw或kwargs来命名关键字参数。
这里我讲的不是很具体,不懂的话请百度“python可变参数”“python关键字参数”

总结
本文的内容就和本文的标题一样,只是对decorator的一个粗浅的介绍。
还有很多有用的内容我们限于篇幅并没有提到,那么就请期待我的下一篇关于decorator的文章吧!

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

推荐阅读更多精彩内容

  • Python进阶框架 希望大家喜欢,点赞哦首先感谢廖雪峰老师对于该课程的讲解 一、函数式编程 1.1 函数式编程简...
    Gaolex阅读 5,484评论 6 53
  • 前言 Python的修饰器的英文名叫Decorator,当你看到这个英文名的时候,你可能会把其跟Design Pa...
    linheimx阅读 623评论 0 4
  • 函数式编程就是一种抽象程度很高的编程范式,纯粹的函数式编程语言编写的函数没有变量,因此,任意一个函数,只要输入是确...
    齐天大圣李圣杰阅读 1,515评论 0 2
  • 要点: 函数式编程:注意不是“函数编程”,多了一个“式” 模块:如何使用模块 面向对象编程:面向对象的概念、属性、...
    victorsungo阅读 1,443评论 0 6
  • 1. Android系统架构 四层架构: Linux内核层、系统运行库层、应用框架层、应用层。 如图所示: 1.1...
    开心wonderful阅读 1,402评论 0 6