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


Posted in Python onJune 03, 2015

装饰器基本概念

大家都知道装饰器是一个很著名的设计模式,经常被用于 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 相关文章推荐
Python合并多个装饰器小技巧
Apr 28 Python
Django ManyToManyField 跨越中间表查询的方法
Dec 18 Python
python 实现selenium断言和验证的方法
Feb 13 Python
Python分布式进程中你会遇到的问题解析
May 28 Python
python输入错误后删除的方法
Oct 12 Python
Flask中endpoint的理解(小结)
Dec 11 Python
如何基于python测量代码运行时间
Dec 25 Python
Python2和Python3中@abstractmethod使用方法
Feb 04 Python
python实现梯度下降和逻辑回归
Mar 24 Python
基于SQLAlchemy实现操作MySQL并执行原生sql语句
Jun 10 Python
python实现代码审查自动回复消息
Feb 01 Python
Python实现老照片修复之上色小技巧
Oct 16 Python
Python模块搜索概念介绍及模块安装方法介绍
Jun 03 #Python
Python使用ftplib实现简易FTP客户端的方法
Jun 03 #Python
Python中的深拷贝和浅拷贝详解
Jun 03 #Python
python下paramiko模块实现ssh连接登录Linux服务器
Jun 03 #Python
python处理二进制数据的方法
Jun 03 #Python
Python读写配置文件的方法
Jun 03 #Python
python操作ssh实现服务器日志下载的方法
Jun 03 #Python
You might like
SONY ICF-F10中波修复记
2021/03/02 无线电
全文搜索和替换
2006/10/09 PHP
php中jQuery插件autocomplate的简单使用笔记
2012/06/14 PHP
探讨如何使用SimpleXML函数来加载和解析XML文档
2013/06/07 PHP
php单文件版在线代码编辑器
2015/03/12 PHP
PHP SESSION的增加、删除、修改、查看操作
2015/03/20 PHP
jQuery ajax+PHP实现的级联下拉列表框功能示例
2019/02/12 PHP
自定义Laravel (monolog)日志位置,并增加请求ID的实现
2019/10/17 PHP
jQuery UI-Draggable 参数集合
2010/01/10 Javascript
一个网马的tips实现分析
2010/11/28 Javascript
jquery滚动条插件jScrollPane的使用介绍
2013/11/08 Javascript
jQuery中;function($,undefined) 前面的分号的用处
2014/12/17 Javascript
JavaScript设置获取和设置属性的方法
2015/03/04 Javascript
javascript实现保留两位小数的多种方法
2015/12/18 Javascript
详解AngularJS中的filter过滤器用法
2016/01/04 Javascript
简单实现js浮动框
2016/12/13 Javascript
vue中$refs的用法及作用详解
2018/04/24 Javascript
最简单的vue消息提示全局组件的方法
2019/06/16 Javascript
nuxt.js写项目时增加错误提示页面操作
2020/11/05 Javascript
修改Python的pyxmpp2中的主循环使其提高性能
2015/04/24 Python
使用Python实现博客上进行自动翻页
2017/08/23 Python
浅谈keras中自定义二分类任务评价指标metrics的方法以及代码
2020/06/11 Python
pymysql模块使用简介与示例
2020/11/17 Python
python爬虫利用selenium实现自动翻页爬取某鱼数据的思路详解
2020/12/22 Python
CSS3中:nth-child和:nth-of-type的区别深入理解
2014/03/10 HTML / CSS
CSS3制作酷炫的条纹背景
2017/11/09 HTML / CSS
法学个人求职信范文
2014/01/27 职场文书
行政副总岗位职责
2014/02/23 职场文书
《雪儿》教学反思
2014/04/17 职场文书
创先争优活动承诺书
2014/08/30 职场文书
我与祖国共奋进演讲稿
2014/09/13 职场文书
学校教师师德师风承诺书
2015/04/28 职场文书
解决redis sentinel 频繁主备切换的问题
2021/04/12 Redis
redis配置文件中常用配置详解
2021/04/14 Redis
Golang之sync.Pool使用详解
2021/05/06 Golang
python 使用tkinter与messagebox写界面和弹窗
2022/03/20 Python