Python 装饰器详解

简介：装饰器本质上是一个Python函数，它可以让其他函数在不需要做任何代码变动的前提下增加额外的功能，装饰器的返回值也是一个函数对象。常用于有切面需求的成精，比如：插入日志、性能测试、事务处理、缓存、权限校验等场景，有了装饰器，就可以抽离大量与函数功能本身无关的雷同代码并继续使用。概括的说，装饰器的作用就是为已存在的对象添加额外的功能。

一、在学习装饰器之前需要先了解已下知识点：

1、函数的作用域

1.1、python中的作用域分4种情况：　

• L：local，局部作用域，即函数中定义的变量；
• E：enclosing，嵌套的父级函数的局部作用域，即包含此函数的上级函数的局部作用域，但不是全局的；
• G：globa，全局变量，就是模块级别定义的变量；
• B：built-in，系统固定模块里面的变量，比如int, bytearray等。 搜索变量的优先级顺序依次是：作用域局部>外层作用域>当前模块中的全局>python内置作用域，也就是LEGB。　　　

x = int(2.9)  # int built-in
 
g_count = 0  # global
def outer():
    o_count = 1  # enclosing
    def inner():
        i_count = 2  # local
        print(o_count)
    # print(i_count) 找不到
    inner()
outer()
 
# print(o_count) #找不到

当然，local和enclosing是相对的，enclosing变量相对上层来说也是local。

1.2、作用域产生 

在Python中，只有模块（module），类（class）以及函数（def、lambda）才会引入新的作用域，其它的代码块（如if、try、for等）是不会引入新的作用域的，如下代码：

1 if 2>1:
2     x = 1
3 print(x) # 1

这个是没有问题的，if并没有引入一个新的作用域，x仍处在当前作用域中，后面代码可以使用。

1 def test():
2     x = 2
3 print(x) # NameError: name 'x2' is not defined

def、class、lambda是可以引入新作用域的。 

1.3、变量的修改

 1 #################
 2 x=6
 3 def f2():
 4     print(x)
 5     x=5
 6 f2()
 7   
 8 # 错误的原因在于print(x)时,解释器会在局部作用域找,会找到x=5(函数已经加载到内存),但x使用在声明前了,所以报错:
 9 # local variable 'x' referenced before assignment.如何证明找到了x=5呢?简单:注释掉x=5,x=6
10 # 报错为:name 'x' is not defined
11 #同理
12 x=6
13 def f2():
14     x+=1 #local variable 'x' referenced before assignment.
15 f2()

1.4、global关键字 

当内部作用域想修改外部作用域的变量时，就要用到global和nonlocal关键字了，当修改的变量是在全局作用域（global作用域）上的，就要使用global先声明一下，代码如下：

1 count = 10
2 def outer():
3     global count
4     print(count) 
5     count = 100
6     print(count)
7 outer()
8 #10
9 #100

1.5、nonlocal关键字

global关键字声明的变量必须在全局作用域上，不能嵌套作用域上，当要修改嵌套作用域（enclosing作用域，外层非全局作用域）中的变量怎么办呢，这时就需要nonlocal关键字了

 1 def outer():
 2     count = 10
 3     def inner():
 4         nonlocal count
 5         count = 20
 6         print(count)
 7     inner()
 8     print(count)
 9 outer()
10 #20
11 #20　

1.6、作用域小结：

（1）变量查找顺序：LEGB，作用域局部>外层作用域>当前模块中的全局>python内置作用域；

（2）只有模块、类、及函数才能引入新作用域；

（3）对于一个变量，内部作用域先声明就会覆盖外部变量，不声明直接使用，就会使用外部作用域的变量；

（4）内部作用域要修改外部作用域变量的值时，全局变量要使用global关键字，嵌套作用域变量要使用nonlocal关键字。nonlocal是python3新增的关键字，有了这个 关键字，就能完美的实现闭包了。 

2、高阶函数(函数即对象)

在python的世界里，函数和我们之前的[1,2,3],'abc',8等一样都是对象，而且函数是最高级的对象（对象是类的实例化，可以调用相应的方法，函数是包含变量对象的对象，牛逼！）。

 1 def foo():
 2     print('i am the foo')
 3     bar()
 4      
 5 def bar():     
 6     print('i am the bar')
 7  
 8 foo()
 9 # def bar():      #报错
10 #     print('i am the bar')

带着这个问题，我们聊一聊函数在内存的存储情况：

函数对象的调用仅仅比其它对象多了一个()而已！foo,bar与a,b一样都是个变量名。

那上面的问题也就解决了，只有函数加载到内存才可以被调用。

既然函数是对象，那么自然满足下面两个条件：

2.1. 其可以被赋给其他变量

1 def foo():
2 
3     print('foo')
4 bar=foo
5 bar()
6 foo()
7 print(id(foo),id(bar))  #4321123592 4321123592

2.2. 其可以被定义在另外一个函数内(作为参数&作为返回值),类似于整型，字符串等对象。

 1 #*******函数名作为参数**********
 2 def foo(func):
 3     print('foo')
 4     func()
 5  
 6 def bar():
 7     print('bar')
 8  
 9 foo(bar)
10  
11 #*******函数名作为返回值*********
12  
13 def foo():
14     print('foo')
15     return bar
16  
17 def bar():
18     print('bar')
19  
20 b=foo()
21 b()

注意：这里说的函数都是指函数名，比如foo；而foo()已经执行函数了，foo()是什么类型取决于return的内容是什么类型！！！

         另外，如果大家理解不了对象，那么就将函数理解成变量，因为函数对象总会由一个或多个变量引用，比如foo，bar。

3、函数的嵌套以及闭包

抛一个小问题：

1 def foo():
2     print('foo')
3     def bar():
4         print('bar')
5     # bar()
6 bar()

是的，bar就是一个变量名，有自己的作用域的。

Python允许创建嵌套函数。通过在函数内部def的关键字再声明一个函数即为嵌套：

 1 #想执行inner函数,两种方法
 2 def outer():
 3      x = 1
 4      def inner():
 5          print (x) # 1
 6      # inner() # 2
 7      return inner
 8  
 9 # outer()
10 in_func=outer()
11 in_func()

在这里，你有没有什么疑问？如果没有，那我问你：

 两种调用方式有区别吗，不都是在外面调用inner吗？

1 in_func=outer() 
2 in_func()  
3 ###########
4 inner()(已经加载到内存啦)

 

 1 def outer():
 2      x = 1
 3      def inner():
 4          b=6
 5          print (x)
 6      return inner
 7 #inner()#报错原因:找不到这个引用变量
 8 in_func=outer()#这里其实就是一个变量赋值,将inner的引用对象赋值给in_func,类似于a=5,b=a一样
 9                #有同学会想直接赋值不行吗:in_func=inner? 哥,inner不还是找不到吗,对吧
10 in_func()
11 
12 原因

 

1 def outer():
2     x=1    #函数outer执行完毕即被销毁
3 print(x) 

既然这样，i()执行的时候outer函数已经执行完了，为什么inner还可以调用outer里的变量x呢？

这就涉及到了闭包的用法！因为：outer里return的inner是一个闭包函数，有x这个环境变量。OK，那么什么是闭包呢？

闭包(closure)是函数式编程的重要的语法结构。

定义：如果在一个内部函数里，对在外部作用域（但不是在全局作用域）的变量进行引用，那么内部函数就被认为是闭包(closure).

如上实例，inner就是内部函数，inner里引用了外部作用域的变量x（x在外部作用域outer里面，不是全局作用域），

则这个内部函数inner就是一个闭包。

再稍微讲究一点的解释是，闭包=函数块+定义函数时的环境，inner就是函数块，x就是环境，当然这个环境可以有很多，不止一个简单的x。

 1 # 用途1：当闭包执行完后，仍然能够保持住当前的运行环境。
 2 # 比如说，如果你希望函数的每次执行结果，都是基于这个函数上次的运行结果。我以一个类似棋盘游戏的例子
 3 # 来说明。假设棋盘大小为50*50，左上角为坐标系原点(0,0)，我需要一个函数，接收2个参数，分别为方向
 4 # (direction)，步长(step)，该函数控制棋子的运动。棋子运动的新的坐标除了依赖于方向和步长以外，
 5 # 当然还要根据原来所处的坐标点，用闭包就可以保持住这个棋子原来所处的坐标。
 6 
 7 origin = [0, 0] # 坐标系统原点
 8 legal_x = [0, 50] # x轴方向的合法坐标
 9 legal_y = [0, 50] # y轴方向的合法坐标
10 def create(pos=origin):
11  def player(direction,step):
12   # 这里应该首先判断参数direction,step的合法性，比如direction不能斜着走，step不能为负等
13   # 然后还要对新生成的x，y坐标的合法性进行判断处理，这里主要是想介绍闭包，就不详细写了。
14   new_x = pos[0] + direction[0]*step
15   new_y = pos[1] + direction[1]*step
16   pos[0] = new_x
17   pos[1] = new_y
18   #注意！此处不能写成 pos = [new_x, new_y]，原因在上文有说过
19   return pos
20  return player
21 
22 player = create() # 创建棋子player，起点为原点
23 print (player([1,0],10)) # 向x轴正方向移动10步
24 print (player([0,1],20)) # 向y轴正方向移动20步
25 print (player([-1,0],10)) # 向x轴负方向移动10步
26 
27 用途1

 

 

 1 # 用途2：闭包可以根据外部作用域的局部变量来得到不同的结果，这有点像一种类似配置功能的作用，我们可以
 2 # 修改外部的变量，闭包根据这个变量展现出不同的功能。比如有时我们需要对某些文件的特殊行进行分析，先
 3 # 要提取出这些特殊行。
 4 
 5 def make_filter(keep):
 6  def the_filter(file_name):
 7   file = open(file_name)
 8   lines = file.readlines()
 9   file.close()
10   filter_doc = [i for i in lines if keep in i]
11   return filter_doc
12  return the_filter
13 
14 # 如果我们需要取得文件"result.txt"中含有"pass"关键字的行，则可以这样使用例子程序
15 filter = make_filter("pass")
16 filter_result = filter("result.txt")

二、装饰器：

1、装饰器概念：

装饰器本质上是一个函数，该函数用来处理其他函数，它可以让其他函数在不需要修改代码的前提下增加额外的功能，装饰器的返回值也是一个函数对象。它经常用于有切面需求的场景，比如：插入日志、性能测试、事务处理、缓存、权限校验等应用场景。装饰器是��决这类问题的绝佳设计，有了装饰器，我们就可以抽离出大量与函数功能本身无关的雷同代码并继续重用。概括的讲，装饰器的作用就是为已经存在的对象添加额外的功能。

分析：业务生产中大量调用的函数：

1 def foo():
2     print('hello foo')
3 foo()

现在有一个新的需求，希望可以记录下函数的执行时间，于是在代码中添加日志代码：

1 import time
2 def foo():
3     start_time=time.time()
4     print('hello foo')
5     time.sleep(3)
6     end_time=time.time()
7     print('spend %s'%(end_time-start_time))
8  
9 foo()

bar()、bar2()也有类似的需求，怎么做？再在bar函数里调用时间函数？这样就造成大量雷同的代码，为了减少重复写代码，我们可以这样做，重新定义一个函数：专门设定时间:

 1 import time
 2 def show_time(func):
 3     start_time=time.time()
 4     func()
 5     end_time=time.time()
 6     print('spend %s'%(end_time-start_time))
 7  
 8  
 9 def foo():
10     print('hello foo')
11     time.sleep(3)
12  
13 show_time(foo)

逻辑上不难理解，而且运行正常。 但是这样的话,你基础平台的函数修改了名字，容易被业务线的人投诉的，因为我们每次都要将一个函数作为参数传递给show_time函数。而且这种方式已经破坏了原有的代码逻辑结构，之前执行业务逻辑时，执行运行foo()，但是现在不得不改成show_time(foo)。那么有没有更好的方式的呢？当然有，答案就是装饰器。

2、一个简单的装饰器：

if  foo()==show_time(foo) :问题解决!  

所以，我们需要show_time(foo)返回一个函数对象，而这个函数对象内则是核心业务函数:执行func()与装饰函数时间计算，修改如下：

 1 import time
 2  
 3 def show_time(func):
 4     def wrapper():
 5         start_time=time.time()
 6         func()
 7         end_time=time.time()
 8         print('spend %s'%(end_time-start_time))
 9  
10     return wrapper
11  
12  
13 def foo():
14     print('hello foo')
15     time.sleep(3)
16  
17 foo=show_time(foo)
18 foo()

函数show_time就是装饰器，它把真正的业务方法func包裹在函数里面，看起来像foo被上下时间函数装饰了。在这个例子中，函数进入和退出时 ，被称为一个横切面(Aspect)，这种编程方式被称为面向切面的编程(Aspect-Oriented Programming)。

@符号是装饰器的语法糖，在定义函数的时候使用，避免再一次赋值操作

 1 import time
 2  
 3 def show_time(func):
 4     def wrapper():
 5         start_time=time.time()
 6         func()
 7         end_time=time.time()
 8         print('spend %s'%(end_time-start_time))
 9  
10     return wrapper
11  
12 @show_time   #foo=show_time(foo)
13 def foo():
14     print('hello foo')
15     time.sleep(3)
16  
17  
18 @show_time  #bar=show_time(bar)
19 def bar():
20     print('in the bar')
21     time.sleep(2)
22  
23 foo()
24 print('***********')
25 bar()

如上所示，这样我们就可以省去bar = show_time(bar)这一句了，直接调用bar()即可得到想要的结果。如果我们有其他的类似函数，我们可以继续调用装饰器来修饰函数，而不用重复修改函数或者增加新的封装。这样，我们就提高了程序的可重复利用性，并增加了程序的可读性。

这里需要注意的问题：  foo=show_time(foo)其实是把wrapper引用的对象引用给了foo，而wrapper里的变量func之所以可以用，就是因为wrapper是一个闭包函数。

@show_time帮我们做的事情就是当我们执行业务逻辑foo()时，执行的代码由粉框部分转到蓝框部分，仅此而已！

装饰器在Python使用如此方便都要归因于Python的函数能像普通的对象一样能作为参数传递给其他函数，可以被赋值给其他变量，可以作为返回值，可以被定义在另外一个函数内。

 3、带参数的被装饰器函数：

 1 import time
 2  
 3 def show_time(func):
 4  
 5     def wrapper(a,b):
 6         start_time=time.time()
 7         func(a,b)
 8         end_time=time.time()
 9         print('spend %s'%(end_time-start_time))
10  
11     return wrapper
12  
13 @show_time   #add=show_time(add)
14 def add(a,b):
15  
16     time.sleep(1)
17     print(a+b)
18  
19 add(2,4)

 

 

 1 import time
 2 
 3 def show_time(func):
 4 
 5     def wrapper(a,b):
 6         start_time=time.time()
 7         ret=func(a,b)
 8         end_time=time.time()
 9         print('spend %s'%(end_time-start_time))
10         return ret
11 
12     return wrapper
13 
14 @show_time   #add=show_time(add)
15 def add(a,b):
16 
17     time.sleep(1)
18     return a+b
19 
20 print(add(2,5))
21 
22 注意点

4、不定长参数被装饰器：

 1 #***********************************不定长参数
 2 import time
 3 
 4 def show_time(func):
 5 
 6     def wrapper(*args,**kwargs):
 7         start_time=time.time()
 8         func(*args,**kwargs)
 9         end_time=time.time()
10         print('spend %s'%(end_time-start_time))
11 
12     return wrapper
13 
14 @show_time   #add=show_time(add)
15 def add(*args,**kwargs):
16 
17     time.sleep(1)
18     sum=0
19     for i in args:
20         sum+=i
21     print(sum)
22 
23 add(2,4,8,9)

5、带参数的装饰器：

装饰器还有更大的灵活性，例如带参数的装饰器：在上面的装饰器调用中，比如@show_time，该装饰器唯一的参数就是执行业务的函数。装饰器的语法允许我们在调用时，提供其它参数，比如@decorator(a)。这样，就为装饰器的编写和使用提供了更大的灵活性。

 1 import time
 2  
 3 def time_logger(flag=0):
 4  
 5     def show_time(func):
 6  
 7             def wrapper(*args,**kwargs):
 8                 start_time=time.time()
 9                 func(*args,**kwargs)
10                 end_time=time.time()
11                 print('spend %s'%(end_time-start_time))
12  
13                 if flag:
14                     print('将这个操作的时间记录到日志中')
15  
16             return wrapper
17  
18     return show_time
19  
20  
21 @time_logger(3)
22 def add(*args,**kwargs):
23     time.sleep(1)
24     sum=0
25     for i in args:
26         sum+=i
27     print(sum)
28  
29 add(2,7,5)

@time_logger(3) 做了两件事：

    （1）time_logger(3)：得到闭包函数show_time，里面保存环境变量flag

    （2）@show_time   ：add＝show_time(add)

上面的time_logger是允许带参数的装饰器。它实际上是对原有装饰器的一个函数封装，并返回一个装饰器(一个含有参数的闭包函数)。当我 们使用@time_logger(3)调用的时候，Python能够发现这一层的封装，并把参数传递到装饰器的环境中。

6、多层装饰器：

 1 def makebold(fn):
 2     def wrapper():
 3         return "<b>" + fn() + "</b>"
 4     return wrapper
 5  
 6 def makeitalic(fn):
 7     def wrapper():
 8         return "<i>" + fn() + "</i>"
 9     return wrapper
10  
11 @makebold
12 @makeitalic
13 def hello():
14     return "hello alvin"
15  
16 hello()

过程：

7、类装饰器：

再来看看类装饰器，相比函数装饰器，类装饰器具有灵活度大、高内聚、封装性等优点。使用类装饰器还可以依靠类内部的__call__方法，当使用 @ 形式将装饰器附加到函数上时，就会调用此方法。

 1 import time
 2 
 3 class Foo(object):
 4     def __init__(self, func):
 5         self._func = func
 6 
 7     def __call__(self):
 8         start_time=time.time()
 9         self._func()
10         end_time=time.time()
11         print('spend %s'%(end_time-start_time))
12 
13 @Foo  #bar=Foo(bar)
14 
15 def bar():
16 
17     print ('bar')
18     time.sleep(2)
19 
20 bar()    #bar=Foo(bar)()>>>>>>>没有嵌套关系了,直接active Foo的 __call__方法