对于Python装饰器使用的一些建议

 更新时间:2015年06月03日 10:51:42   投稿:goldensun  
这篇文章主要介绍了对于Python装饰器使用的一些建议,装饰器是Python学习进阶中的重要知识,需要的朋友可以参考下

装饰器基本概念

大家都知道装饰器是一个很著名的设计模式,经常被用于 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 )则束手无策。

相关文章

  • Python PCA降维的两种实现方法

    Python PCA降维的两种实现方法

    大家好,本篇文章主要讲的是Python PCA降维的两种实现方法,感兴趣的的同学赶快来看一看吧,对你有帮助的话记得收藏一下
    2022-01-01
  • 关于python的矩阵乘法运算

    关于python的矩阵乘法运算

    这篇文章主要介绍了关于python的矩阵乘法运算,矩阵是一个数字阵列,一个二维数组,n行r列的阵列称为n*r矩阵。如果n==r则称为方阵,需要的朋友可以参考下
    2023-04-04
  • Python读写docx文件的方法

    Python读写docx文件的方法

    今天小编就为大家分享一篇Python读写docx文件的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • python3中numpy函数tile的用法详解

    python3中numpy函数tile的用法详解

    今天小编就为大家分享一篇python3中numpy函数tile的用法详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2019-12-12
  • tkinter如何实现打开文件对话框并获取文件绝对路径

    tkinter如何实现打开文件对话框并获取文件绝对路径

    这篇文章主要介绍了tkinter实现打开文件对话框并获取文件绝对路径问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-01-01
  • Kotlin 中的 apply 函数用法详解

    Kotlin 中的 apply 函数用法详解

    apply 函数是 Kotlin 中一个十分方便的工具,它使得对对象进行初始化和配置变得更加简洁、清晰,通过与 Java 的对比,我们可以看出 Kotlin 在处理类似情况时具有更高的表现力和简洁性,本文给大家介绍Kotlin apply 函数的用法,感兴趣的朋友一起看看吧
    2024-03-03
  • Python中常见内置函数的用法合集

    Python中常见内置函数的用法合集

    本文将从基础到高级,详细介绍Python中常见的内置函数,通过代码示例和中文注释,帮助您深入理解如何在不同情景下灵活应用这些函数,需要的可以学习一下
    2023-09-09
  • Python实现在Word中创建表格并填入数据与图片

    Python实现在Word中创建表格并填入数据与图片

    在Word中,表格是一个强大的工具,本文主要为大家介绍了如何使用Python在Word中创建表格并填入数据、图片,以及设置表格样式等,感兴趣的可以了解下
    2024-03-03
  • 在PyCharm下打包*.py程序成.exe的方法

    在PyCharm下打包*.py程序成.exe的方法

    今天小编就为大家分享一篇在PyCharm下打包*.py程序成.exe的方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-11-11
  • Python一行代码实现ChatGPT接入微信机器人

    Python一行代码实现ChatGPT接入微信机器人

    这篇文章主要为大家介绍了Python一行代码实现ChatGPT接入微信机器人示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-03-03

最新评论