如何通俗理解python中的装饰器？

装饰器详解

装饰器，顾名思义就是装饰的意思，就是不改变里面的墙体结构，只是在外面增加了一层隔音板或者墙纸。

对应程序也是这样的，不改变原函数的结构功能，调用函数的接口也没有变化，但是就是增多了该函数的功能。这是怎么做到的呢？本次用一个例子来全面说明。

我们已经写好了一个函数是index，现在给该函数index加上该函数运行的时间的功能。

1、原始代码

# -*- coding=utf-8 -*-
import time

def index():  
    time.sleep(2)

startTime = time.time()
index()   #f1,f2...fn
endTime = time.time()
print(endTime - startTime) #输出2.000297784805298

上面代码表示运行index函数花费的时间，这就有一个问题了，如果我要计算函数f1()，函数f2()，函数fn()…那么每一个函数都要这么写，就会重复很多代码，这是写程序不允许的，因此需要一个函数来进行包装，也就是说decorator就是一个返回函数的高阶函数。

2、增加函数

import time
def index():
    time.sleep(2)

def calculate_time():
    startTime = time.time()
    index()
    endTime = time.time()
    print(endTime - startTime)

calculate_time() #out:2.000297784805298

上面这么写就是用了一个函数，还是不能解决之前提到的问题，换了index()，还得重新写calculate_time函数，那么此时我们需要用到将函数传递到函数里面。

# -*- coding=utf-8 -*-
import time

def index():
    time.sleep(2)

def calculate_time(f):
    startTime = time.time()
    f()
    endTime = time.time()
    print(endTime - startTime)

calculate_time(index)

把index()传过去，那么之后需要修改index就很方便，但是这个也不能完全解决之前的问题，即我改变的函数的调用接口，之前的函数是index，现在的函数变成了calculate_time，这也也很不习惯，因此我们需要进一步升级。

3、加入闭包

这一步就是在函数里面添加函数

import time

def index():
    time.sleep(2)

def calculate_time(f):
    def inner():
        startTime = time.time()
        f()
        endTime = time.time()
        print(endTime - startTime)
    return inner

index = calculate_time(index)
index()

这个写法和上面的例子是一致的，且调用的时候，我们只是用了index(),这就是装饰器了，不过需要在前面加一句话index = calculate_time(index)
所以我们需要python中的语法糖@

# -*- coding=utf-8 -*-
import time

def calculate_time(f):
    def inner():
        startTime = time.time()
        f()
        endTime = time.time()
        print(endTime - startTime)
    return inner

@calculate_time #index = calculate_time(index)
def index():
    time.sleep(2)

index()

需要知道 @calculate_time 等价于 index = calculate_time(index)

4、加入输出变量

一般函数都是由return输出的，本例子加入index输出结果，如下：

import time

def calculate_time(f):
    def inner():
        startTime = time.time()
        result = f()  #f函数是有输出的，符合一般的函数写法
        endTime = time.time()
        print(endTime - startTime)
        return result
    return inner

@calculate_time #index = calculate_time(index)
def index():
    time.sleep(2)
    return 'index'

res = index()
print(res) # out:2.0000038146972656 index

5、升级优化传递函数

如果我们需要在写入一个其他的函数，且各个函数输入不一样，那么此时需要对函数的传递参数进行改进，如下：

# -*- coding=utf-8 -*-
import time

def calculate_time(f):
    def inner(*args,**kwargs):
        startTime = time.time()
        result = f(*args,**kwargs)
        endTime = time.time()
        print(endTime - startTime)
        return result
    return inner

@calculate_time
def index():
    time.sleep(2)
    return 'index'

@calculate_time
def add(x,y):
    time.sleep(2)
    return x + y

res = index()
addRes = add(1,2)
print(res,addRes)

输出：

2.000779151916504
2.000826597213745
index 3

把*args,**kwargs传递到函数里面，之后就可以随意写自己需要被装饰的函数了。

6、总结

一个标准的装饰器如下：

def calculate_time(f):
    def inner(*args,**kwargs):
        startTime = time.time()
        result = f(*args,**kwargs)
        endTime = time.time()
        print(endTime - startTime)
        return result
    return inner

先把功能写好，比如上面的计算时间差。然后调用我们的需要被装饰的函数f(*args,**kwargs)，并给出一个返回值，且需要把内层函数作为结果返回出去。那么最后我们的 index = calculate_time(index)等价于@calculate_time 。

整个便是装饰器的内容了。
记住： @calculate_time 等价于 index = calculate_time(index)