python的装饰器

浏览数：32 / 时间：2015年06月08日

由于函数也是一个对象，而且函数作为一个特殊的对象可以被赋值给其他变量（value = pringname()），相反，通过变量也是可以调用函数的，以下是一个简单的例子：

1 >>> def printName():
2 ... print("My name is Jobs")
3 ... 
4 >>> name = printName
5 >>> 
6 >>> printName()
7 My name is Jobs
8 >>> name()
9 My name is Jobs

由以上代码我们不难看出，printName()函数被赋值给name变量，同样用name变量也可以调用printName()函数。此时他们是相同的，在这里说一点小知识：函数对象有

一个__name__属性，可以拿到函数的名字：

例子：

1 >>> 
2 >>> name.__name__
3 ‘printName‘
4 >>> printName.__name__
5 ‘printName‘
6 
7

现在，假设我们要增强printName函数的功能，比如，在函数调用前后自动打印日志，但又不希望修改printName函数的定义，这种在代码运行期间动态增加功能的方式，称之为“

装饰器”（Decorator）。本质上，decorator就是一个返回函数的高阶函数。所以，我们要定义一个能打印日志的decorator，可以定义如下：

例子一：

1 >>> 
2 >>> def log(func):
3 ... def wrapper(*args,**kw):
4 ... print ‘call %s()‘ %func.__name__
5 ... return func(*args,**kw)
6 ... return wrapper
7 ...

观察上面的log，因为它是一个decorator，所以接受一个函数作为参数，并返回一个函数。我们要借助Python的@语法，把decorator置于函数的定义处：

1 >>> @log
2 ... def printName():
3 ... print("My name is Jobs")
4 ... 
5 >>> printName()
6 call printName()
7 My name is Jobs

例子二：

 1 >>> 
 2 >>> @log
 3 ... def printAge():
 4 ... print ‘%s,my age is 120‘ %printName() 
 5 ... 
 6 >>> job = printAge()
 7 call printAge()
 8 call printName()
 9 My name is Jobs
10 None,my age is 120

当你调用printName或者printAge()时，不仅会调用函数本身，而且会调用在调用该函数之前打印一些日志。把@log放在printAge()函数之前相当于执行了语句：

name= log(printName)

由于log()是一个decorator，返回一个函数，所以，原来的now()函数仍然存在，只是现在同名的printName()了新的函数，于是调用printName()将执行新函数，即在log()函数中返回的wrapper()函数。

wrapper()函数的参数定义是(*args, **kw)，因此，wrapper()函数可以接受任意参数的调用。在wrapper()函数内，首先打印日志，再紧接着调用原始函数。

如果decorator本身需要传入参数，那就需要编写一个返回decorator的高阶函数，写出来会更复杂。比如，要自定义log的文本：

1 def log(text):
2     def decorator(func):
3         def wrapper(*args, **kw):
4             print ‘%s %s():‘ % (text, func.__name__)
5             return func(*args, **kw)
6         return wrapper
7     return decorator

这个3层嵌套

 1 >>> def log(text):
 2 ...     def decorator(func):
 3 ...         def wrapper(*args,**kw):
 4 ...             print ‘%s %s():‘ %(text,func.__name__)
 5 ...             return func(*args,**kw)
 6 ...         return wrapper
 7 ...     return decorator
 8 ... 
 9 >>> @log(‘excute‘)
10 ... def printName():
11 ...     print("My name is Jobs!")
12 ... 
13 >>> printName()
14 excute printName():
15 My name is Jobs!
16 >>>

我们来剖析上面的语句，首先执行log(‘execute‘)，返回的是decorator函数，再调用返回的函数，参数是now函数，返回值最终是wrapper函数。

以上两种decorator的定义都没有问题，但还差最后一步。因为我们讲了函数也是对象，它有__name__等属性，但你去看经过decorator装饰之后的函数，它们的__name__已经从原来的‘printName变成了‘wrapper‘：

>>> printName.__name__
‘wrapper‘
>>>

因为返回的那个wrapper()函数名字就是‘wrapper‘，所以，需要把原始函数的__name__等属性复制到wrapper()函数中，否则，有些依赖函数签名的代码执行就会出错。

不需要编写wrapper.__name__ = func.__name__这样的代码，Python内置的functools.wraps就是干这个事的，所以，一个完整的decorator的写法如下：

1 >>> def log(func):
2 ...     @functools.wraps(func)
3 ...     def wrapper(*args,**kw):
4 ...         print ‘call %s():‘ %func.__name__
5 ...         return func(*args,**kw)
6 ...     return wrapper
7 ... 
8 >>>

也可以针对呆参数的decorator:

import functools

def log(text):
    def decorator(func):
        @functools.wraps(func)
        def wrapper(*args, **kw):
            print ‘%s %s():‘ % (text, func.__name__)
            return func(*args, **kw)
        return wrapper
    return decorator

这是一个更新的例子，希望帮助大家理解：

 1 >>> def deco(func):
 2 ...     def _deco(a,b):
 3 ...         print ("before myfunc() called.")
 4 ...         ret = func(a,b)
 5 ...         print("after called.result:%s" %ret)
 6 ...         return ret
 7 ...     return _deco
 8 ... 
 9 
10 >>> @deco
11 ... def myfunc(a,b):
12 ...     print("myfunc(%s,%s) called."%(a,b))
13 ...     return a+b
14 ... 
15 >>> myfunc(1,2)
16 before myfunc() called.  
17 myfunc(1,2) called.
18 after called.result:3
19 3
20 >>>