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

1fe1se 发布于2019-07-24 17:58 / 984人阅读

摘要：然而，当我们想要获取被包装函数的参数或源代码时，同样不能得到我们想要的结果。这是在中的，版本已被修复，参考。如同上面我们所看到的，可以帮我们解决和的问题，但对于获取函数的参数或源代码则束手无策。

装饰器基本概念

大家都知道装饰器是一个很著名的设计模式，经常被用于 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 "", line 1, in 
      File "", line 3, in Class
      File "", 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 
        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 官方技术博客。

云服务器 GPU云服务器 python 装饰器装饰器python 装饰器装饰器模式

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/37523.html

Python进阶细节

摘要：进阶细节根据慕课网七月老师视频整理一切皆对象对与来说，一切皆对象，包括函数。闭包的意义在于返回了一个现场，如果没有闭包，很容易被外部的变量所影响。重复定义可见此时返回了不再是闭包了。注意该方法的返回值只能是布尔类型，即或。 Python进阶细节根据慕课网七月老师视频整理一切皆对象对与Python来说，一切皆对象，包括函数。在其他语言比如c++中，函数只是一段可执行的代码，只要你获...

tomato 2019-07-31 11:07 评论0 收藏0
Python中的函数装饰器和闭包

摘要：变量查找规则在中一个变量的查找顺序是局部环境，闭包，全局，内建闭包引用了自由变量的函数。闭包的作用闭包的最大特点是可以将父函数的变量与内部函数绑定，并返回绑定变量后的函数，此时即便生成闭包的环境父函数已经释放，闭包仍然存在。导语：本文章记录了本人在学习Python基础之函数篇的重点知识及个人心得，打算入门Python的朋友们可以来一起学习并交流。本文重点： 1、掌握装饰器的本质、功...

caozhijian 2019-07-30 16:05 评论0 收藏0
Python 的闭包和装饰器

摘要：所以，有另一种说法认为闭包是由函数和与其相关的引用环境组合而成的实体。对于已经对闭包或者装饰器有一定概念的，可以直接通过右侧标题目录直接定位到相应段落查看所需的内容。什么是装饰器？装饰器（Decorator）相对简单，咱们先介绍它：装饰器的功能是将被装饰的函数当作参数传递给与装饰器对应的函数（名称相同的函数），并返回包装后的被装饰的函数，听起来有点绕，没关系，直接看示意图,...

justCoding 2019-07-24 18:29 评论0 收藏0
Python装饰器学习笔记

摘要：前言最近跟着流畅的和学习，看到装饰器部分，有些头大倒不是因为概念难以理解，而是书和网上文章中有些地方有些矛盾之处在简单学习和实践之后，整理出我对装饰器的理解如下装饰器的定义在不同语境下，装饰器有不一样的含义，我大致认为有种定义一种把另一个对前言最近跟着《流畅的Python》和《Python Cookbook》学习，看到装饰器部分，有些头大倒不是因为概念难以理解，而是书和网上文章中有...

Cristalven 2019-07-30 15:05 评论0 收藏0
【Python】一文弄懂python装饰器（附源码例子）

摘要：装饰器的使用符合了面向对象编程的开放封闭原则。三简单的装饰器基于上面的函数执行时间的需求，我们就手写一个简单的装饰器进行实现。函数体就是要实现装饰器的内容。类装饰器的实现是调用了类里面的函数。类装饰器的写法比我们装饰器函数的写法更加简单。目录前言一、什么是装饰器二、为什么要用装饰器 ...

liuchengxu 2021-09-04 16:40 评论0 收藏0