Python - 装饰器使用过程中的误区

装饰器基本概念

大家都知道装饰器是一个很著名的设计模式，经常被用于AOP(面向切面编程)的场景，较为经典的有插入日志，性能测试，事务处理，Web权限校验， Cache等。
Python语言本身提供了装饰器语法（@），典型的装饰器实现如下：

1.     @function_wrapper

2.     def function():

3.        pass

@实际上是python2.4才提出的语法糖，针对python2.4以前的版本有另一种等价的实现：

1.     def function():

2.         pass

3. 
   

4.     function = function_wrapper(function)

装饰器的两种实现

函数包装器 - 经典实现

1.     def function_wrapper(wrapped):

2.         def _wrapper(*args, **kwargs):

3.             return wrapped(*args, **kwargs)

4.         return _wrapper

5. 
   

6.     @function_wrapper

7.     def function():

8.         pass

类包装器 - 易于理解

1.     class function_wrapper(object):

2.         def __init__(self, wrapped):

3.             self.wrapped = wrapped

4.         def __call__(self, *args, **kwargs):

5.             return self.wrapped(*args, **kwargs)

6. 
   

7.     @function_wrapper

8.     def function():

9.         pass

函数（function）自省

当我们谈到一个函数时，通常希望这个函数的属性像其文档上描述的那样，是被明确定义的，例如__name__ 和__doc__ 。
针对某个函数应用装饰器时，这个函数的属性就会发生变化，但这并不是我们所期望的。

1.     def function_wrapper(wrapped):

2.         def _wrapper(*args, **kwargs):

3.             return wrapped(*args, **kwargs)

4.         return _wrapper

5. 
   

6.     @function_wrapper

7.     def function():

8.         pass

9. 
   

10.     >>> print(function.__name__)

11.     _wrapper

python标准库提供了functools.wraps() ，来解决这个问题。

1.     import functools

2. 
   

3.     def function_wrapper(wrapped):

4.         @functools.wraps(wrapped)

5.         def _wrapper(*args, **kwargs):

6.             return wrapped(*args, **kwargs)

7.         return _wrapper

8. 
   

9.     @function_wrapper

10.     def function():

11.         pass

12. 
    

13.     >>> print(function.__name__)

14.     function

然而，当我们想要获取被包装函数的参数（argument ）或源代码（source code）时，同样不能得到我们想要的结果。

1.     import inspect

2. 
   

3.     def function_wrapper(wrapped): ...

4. 
   

5.     @function_wrapper

6.     def function(arg1, arg2): pass

7. 
   

8.     >>> print(inspect.getargspec(function))

9.     ArgSpec(args=[], varargs='args', keywords='kwargs', defaults=None)

10. 
    

11.     >>> print(inspect.getsource(function))

12.         @functools.wraps(wrapped)

13.         def _wrapper(*args, **kwargs):

14.             return wrapped(*args, **kwargs)

包装类方法（@classmethod）

当包装器（@function_wrapper ）被应用于@classmethod时，将会抛出如下异常：

1.     class Class(object):

2.         @function_wrapper

3.         @classmethod

4.         def cmethod(cls):

5.             pass

6. 
   

7.     Traceback (most recent call last):

8.       File "<stdin>", line 1, in <module>

9.       File "<stdin>", line 3, in Class

10.       File "<stdin>", line 2, in wrapper

11.       File ".../functools.py", line 33, in update_wrapper

12.         setattr(wrapper, attr, getattr(wrapped, attr))

13.     AttributeError: 'classmethod' object has no attribute '__module__'

因为@classmethod 在实现时，缺少functools.update_wrapper 需要的某些属性。
然而，在python3下执行，另一个问题出现了：

1.     class Class(object):

2.         @function_wrapper

3.         @classmethod

4.         def cmethod(cls):

5.             pass

6. 
   

7.     >>> Class.cmethod()

8.     Traceback (most recent call last):

9.       File "classmethod.py", line 15, in <module>

10.         Class.cmethod()

11.       File "classmethod.py", line 6, in _wrapper

12.         return wrapped(*args, **kwargs)

13.     TypeError: 'classmethod' object is not callable

这是因为包装器认定被包装的函数（@classmethod ）是可以直接被调用的，但事实并不一定是这样的。被包装的函数实际上可能是描述符（descriptor ），意味着为了使其可调用，该函数（描述符）必须被正确地绑定到某个实例上。



总结 - 简单并不意味着正确

尽管大家实现装饰器所用的方法通常都很简单，但这并不意味着它们一定是正确的并且始终能正常工作。
如同上面我们所看到的，functools.wraps() 可以帮我们解决__name__ 和__doc__ 的问题，但对于获取函数的参数（argument）或源代码（ source code ）则束手无策。