python的装饰器

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

>>> def printName():
... print("My name is Jobs")
... 
>>> name = printName
>>> 
>>> printName()
My name is Jobs
>>> name()
My name is Jobs

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

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

例子：

>>> 
>>> name.__name__
'printName'
>>> printName.__name__
'printName'

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

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

例子一：

>>> 
>>> def log(func):
... def wrapper(*args,**kw):
... print 'call %s()' %func.__name__
... return func(*args,**kw)
... return wrapper
...

 

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

>>> @log
... def printName():
... print("My name is Jobs")
... 
>>> printName()
call printName()
My name is Jobs

例子二：

>>> 
>>> @log
... def printAge():
... print '%s,my age is 120' %printName() 
... 
>>> job = printAge()
call printAge()
call printName()
My name is Jobs
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的文本：

def log(text):
    def decorator(func):
        def wrapper(*args, **kw):
            print '%s %s():' % (text, func.__name__)
            return func(*args, **kw)
        return wrapper
    return decorator

这个3层嵌套

>>> def log(text):
...     def decorator(func):
...         def wrapper(*args,**kw):
...             print '%s %s():' %(text,func.__name__)
...             return func(*args,**kw)
...         return wrapper
...     return decorator
... 
>>> @log('excute')
... def printName():
...     print("My name is Jobs!")
... 
>>> printName()
excute printName():
My name is Jobs!
>>> 

我们来剖析上面的语句，首先执行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的写法如下：

>>> def log(func):
...     @functools.wraps(func)
...     def wrapper(*args,**kw):
...         print 'call %s():' %func.__name__
...         return func(*args,**kw)
...     return wrapper
... 
>>> 

也可以针对呆参数的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

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

>>> def deco(func):
...     def _deco(a,b):
...         print ("before myfunc() called.")
...         ret = func(a,b)
...         print("after called.result:%s" %ret)
...         return ret
...     return _deco
... 

>>> @deco
... def myfunc(a,b):
...     print("myfunc(%s,%s) called."%(a,b))
...     return a+b
... 
>>> myfunc(1,2)
before myfunc() called.  
myfunc(1,2) called.
after called.result:3
3
>>> 

补充说明：

　　其实，装饰器就是一个函数，一个可以用来包装函数的函数，最后返回一个修改之后的函数（这里的修改，比如增加日志，如上例。）将其重新赋值原来的标识符，并永久丧失对原始函数对象的访问。