Zheng

浅析decorator

 
  • Jun 15, 2015
  • 0 views

概要

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

示例分析

先上代码来举个栗子：

示例代码

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.我们接收一个没卵用的函数，对它进行改造后，返回一个牛X的新函数。

def timethis(func):  # func就是待改造的函数
    XXXXXXXXX   # 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的编写和使用。
我们谈一下前面遗留的几个重要问题：

为什么要在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这么一句。

关于参数表(*args, **kwargs)

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

总结

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

Search