V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐学习书目
Learn Python the Hard Way
Python Sites
PyPI - Python Package Index
http://diveintopython.org/toc/index.html
Pocoo
值得关注的项目
PyPy
Celery
Jinja2
Read the Docs
gevent
pyenv
virtualenv
Stackless Python
Beautiful Soup
结巴中文分词
Green Unicorn
Sentry
Shovel
Pyflakes
pytest
Python 编程
pep8 Checker
Styles
PEP 8
Google Python Style Guide
Code Style from The Hitchhiker's Guide
OneAPM
V2EX  ›  Python

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

  •  8
     
  •   OneAPM ·
    oneapm · 2015-06-17 15:49:36 +08:00 · 3336 次点击
    这是一个创建于 3443 天前的主题,其中的信息可能已经有所发展或是发生改变。

    装饰器基本概念

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

    Python语言本身提供了装饰器语法(@),典型的装饰器实现如下:

    @function_wrapper
     def function():
         pass
    

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

    def function():
       pass
    
    function = function_wrapper(function)
    

    装饰器的两种实现

    函数包装器 - 经典实现

    def function_wrapper(wrapped):
        def _wrapper(*args, **kwargs):
            return wrapped(*args, **kwargs)
        return _wrapper
    
    @function_wrapper
    def function():
        pass
    

    类包装器 - 易于理解

    class function_wrapper(object):
        def __init__(self, wrapped):
            self.wrapped = wrapped
        def __call__(self, *args, **kwargs):
            return self.wrapped(*args, **kwargs)
    
    @function_wrapper
    def function():
        pass
    

    函数(function)自省

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

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

    def function_wrapper(wrapped):
        def _wrapper(*args, **kwargs):
            return wrapped(*args, **kwargs)
        return _wrapper
    
    @function_wrapper
    def function():
        pass
    
    >>> print(function.__name__)
    _wrapper
    

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

    import functools
    
    def function_wrapper(wrapped):
        @functools.wraps(wrapped)
        def _wrapper(*args, **kwargs):
            return wrapped(*args, **kwargs)
        return _wrapper
    
    @function_wrapper
    def function():
        pass
    
    >>> print(function.__name__)
    function
    

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

    import inspect
    
    def function_wrapper(wrapped): ...
    
    @function_wrapper
    def function(arg1, arg2): pass
    
    >>> print(inspect.getargspec(function))
    ArgSpec(args=[], varargs='args', keywords='kwargs', defaults=None)
    
    >>> print(inspect.getsource(function))
        @functools.wraps(wrapped)
        def _wrapper(*args, **kwargs):
            return wrapped(*args, **kwargs)
    

    包装类方法(@classmethod)

    当包装器(@function_wrapper)被应用于@classmethod时,将会抛出如下异常:

    class Class(object):
        @function_wrapper
        @classmethod
        def cmethod(cls):
            pass
    
    Traceback (most recent call last):
      File "<stdin>", line 1, in <module>
      File "<stdin>", line 3, in Class
      File "<stdin>", line 2, in wrapper
      File ".../functools.py", line 33, in update_wrapper
        setattr(wrapper, attr, getattr(wrapped, attr))
    AttributeError: 'classmethod' object has no attribute '__module__'
    

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

    然而,在python3下执行,另一个问题出现了:

    class Class(object):
        @function_wrapper
        @classmethod
        def cmethod(cls):
            pass
    
    >>> Class.cmethod()
    Traceback (most recent call last):
      File "classmethod.py", line 15, in <module>
        Class.cmethod()
      File "classmethod.py", line 6, in _wrapper
        return wrapped(*args, **kwargs)
    TypeError: 'classmethod' object is not 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官方技术博客

    5 条回复    2015-07-03 10:09:00 +08:00
    ljcarsenal
        1
    ljcarsenal  
       2015-06-17 19:02:23 +08:00 via iPad   ❤️ 1
    不错 顶一个
    junnplus
        2
    junnplus  
       2015-06-17 22:57:46 +08:00 via Android   ❤️ 1
    mark
    sichuyoudang312
        3
    sichuyoudang312  
       2015-06-18 15:14:16 +08:00
    装饰器用处不小啊
    saber000
        4
    saber000  
       2015-07-02 19:34:59 +08:00
    有什么方法解决这些问题吗?
    startover
        5
    startover  
       2015-07-03 10:09:00 +08:00
    @saber000 上面貌似提到了wrapt这个库,mod-wsgi的作者写的,应该差不了
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   3202 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 13:21 · PVG 21:21 · LAX 05:21 · JFK 08:21
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.