对于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格式化压缩后的JS文件的方法
Mar 05 Python
Python入门教程之if语句的用法
May 14 Python
Python中atexit模块的基本使用示例
Jul 08 Python
简单解决Python文件中文编码问题
Nov 22 Python
Python基础教程之内置函数locals()和globals()用法分析
Mar 16 Python
超简单使用Python换脸实例
Mar 27 Python
python中几种自动微分库解析
Aug 29 Python
python读取hdfs上的parquet文件方式
Jun 06 Python
Python脚本破解压缩文件口令实例教程(zipfile)
Jun 14 Python
解决Keras中循环使用K.ctc_decode内存不释放的问题
Jun 29 Python
Selenium环境变量配置(火狐浏览器)及验证实现
Dec 07 Python
django上传文件的三种方式
Apr 29 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
PHP中strtotime函数使用方法详解
2011/11/27 PHP
PHP编程中的常见漏洞和代码实例
2014/08/06 PHP
PHP实现的带超时功能get_headers函数
2015/02/10 PHP
php文档工具PHP Documentor安装与使用方法
2016/01/25 PHP
PHP文件操作实例总结
2016/09/27 PHP
2017年最好用的9个php开发工具推荐(超好用)
2017/10/23 PHP
把html页面的部分内容保存成新的html文件的jquery代码
2009/11/12 Javascript
TinyMCE 新增本地图片上传功能
2010/11/05 Javascript
JavaScript实现下拉列表框数据增加、删除、上下排序的方法
2015/08/11 Javascript
d3.js中冷门却实用的内置函数总结
2017/02/04 Javascript
Node.js查找当前目录下文件夹实例代码
2017/03/07 Javascript
javascript 中关于array的常用方法详解
2017/05/05 Javascript
封装运动框架实战左右与上下滑动的焦点轮播图(实例)
2017/10/17 Javascript
Angular使用cli生成自定义文件、组件的方法
2018/09/04 Javascript
Vue项目实现换肤功能的一种方案分析
2019/08/28 Javascript
js数组中去除重复值的几种方法
2020/08/03 Javascript
js实现三角形粒子运动
2020/09/22 Javascript
[49:21]完美世界DOTA2联赛循环赛 Ink Ice vs LBZS BO2第二场 11.05
2020/11/06 DOTA
python基础教程之数字处理(math)模块详解
2014/03/25 Python
Python学习教程之常用的内置函数大全
2017/07/14 Python
python opencv实现证件照换底功能
2019/08/19 Python
python网络爬虫 CrawlSpider使用详解
2019/09/27 Python
python实现KNN分类算法
2019/10/16 Python
numpy数组做图片拼接的实现(concatenate、vstack、hstack)
2019/11/08 Python
Python模块/包/库安装的六种方法及区别
2020/02/24 Python
德国高品质男装及配饰商城:Cultizm(Raw Denim原色牛仔裤)
2018/04/16 全球购物
Java如何格式化日期
2012/08/07 面试题
网吧收银员岗位职责
2013/12/14 职场文书
家长给幼儿园的表扬信
2014/01/09 职场文书
幼儿园运动会入场词
2014/02/10 职场文书
绿色环保演讲稿
2014/05/10 职场文书
保卫钓鱼岛口号
2014/06/20 职场文书
2015毕业实习推荐信
2015/03/23 职场文书
绿里奇迹观后感
2015/06/15 职场文书
仅用几行Python代码就能复制她的U盘文件?
2021/06/26 Python
分享CSS盒子模型隐藏的几种方式
2022/02/28 HTML / CSS