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

大家都知道装饰器是一个很著名的设计模式，经常被用于AOP(面向切面编程)的场景，较为经典的有插入日志，性能测试，事务处理，Web权限校验， Cache等。

原文链接：http://www.gbtags.com/gb/share/5563.htm

Python语言本身提供了装饰器语法（@），典型的装饰器实现如下：

 

1. @function_wrapper
2. deffunction():
3. pass

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

 

1. deffunction():
2. pass
3. function= function_wrapper(function)

 

装饰器的两种实现

函数包装器 - 经典实现

 

1. def function_wrapper(wrapped):
2. def _wrapper(*args,**kwargs):
3. return wrapped(*args,**kwargs)
4. return _wrapper
5. @function_wrapper
6. deffunction():
7. pass

类包装器 - 易于理解

 

1. class function_wrapper(object):
2. def __init__(self, wrapped):
3. self.wrapped = wrapped
4. def __call__(self,*args,**kwargs):
5. returnself.wrapped(*args,**kwargs)
6. @function_wrapper
7. deffunction():
8. pass

 

函数（function）自省

当我们谈到一个函数时，通常希望这个函数的属性像其文档上描述的那样，是被明确定义的，例如__name__ 和__doc__ 。

针对某个函数应用装饰器时，这个函数的属性就会发生变化，但这并不是我们所期望的。

 

1. def function_wrapper(wrapped):
2. def _wrapper(*args,**kwargs):
3. return wrapped(*args,**kwargs)
4. return _wrapper
5. @function_wrapper
6. deffunction():
7. pass
8. >>>print(function.__name__)
9. _wrapper

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

 

1. import functools
2. def function_wrapper(wrapped):
3. @functools.wraps(wrapped)
4. def _wrapper(*args,**kwargs):
5. return wrapped(*args,**kwargs)
6. return _wrapper
7. @function_wrapper
8. deffunction():
9. pass
10. >>>print(function.__name__)
11. function

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

 

1. import inspect
2. def function_wrapper(wrapped):...
3. @function_wrapper
4. deffunction(arg1, arg2):pass
5. >>>print(inspect.getargspec(function))
6. ArgSpec(args=[], varargs='args', keywords='kwargs', defaults=None)
7. >>>print(inspect.getsource(function))
8. @functools.wraps(wrapped)
9. def _wrapper(*args,**kwargs):
10. return wrapped(*args,**kwargs)

 

包装类方法（@classmethod）

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

 

1. classClass(object):
2. @function_wrapper
3. @classmethod
4. def cmethod(cls):
5. pass
6. Traceback(most recent call last):
7. File"<stdin>", line 1,in<module>
8. File"<stdin>", line 3,inClass
9. File"<stdin>", line 2,in wrapper
10. File".../functools.py", line 33,in update_wrapper
11. setattr(wrapper, attr, getattr(wrapped, attr))
12. AttributeError:'classmethod'object has no attribute '__module__'

因为@classmethod 在实现时，缺少functools.update_wrapper 需要的某些属性。这是functools.update_wrapper 在python2中的bug，3.2版本已被修复，参考http://bugs.python.org/issue3445。

然而，在python3下执行，另一个问题出现了：

 

1. classClass(object):
2. @function_wrapper
3. @classmethod
4. def cmethod(cls):
5. pass
6. >>>Class.cmethod()
7. Traceback(most recent call last):
8. File"classmethod.py", line 15,in<module>
9. Class.cmethod()
10. File"classmethod.py", line 6,in _wrapper
11. return wrapped(*args,**kwargs)
12. TypeError:'classmethod'objectisnot callable

这是因为包装器认定被包装的函数（@classmethod ）是可以直接被调用的，但事实并不一定是这样的。被包装的函数实际上可能是描述符（descriptor ），意味着为了使其可调用，该函数（描述符）必须被正确地绑定到某个实例上。关于描述符的定义，可以参考https://docs.python.org/2/howto/descriptor.html。

 

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

尽管大家实现装饰器所用的方法通常都很简单，但这并不意味着它们一定是正确的并且始终能正常工作。

如同上面我们所看到的，functools.wraps() 可以帮我们解决__name__ 和__doc__ 的问题，但对于获取函数的参数（argument）或源代码（ source code ）则束手无策。

以上问题，wrapt都可以帮忙解决，详细用法可参考其官方文档：http://wrapt.readthedocs.org

本文系OneAPM工程师编译整理。OneAPM是中国基础软件领域的新兴领军企业，能帮助企业用户和开发者轻松实现：缓慢的程序代码和SQL语句的实时抓取。想阅读更多技术文章，请访问OneAPM官方技术博客。

 

原文链接：http://www.gbtags.com/gb/share/5563.htm