举例讲解Python中装饰器的用法


Posted in Python onApril 27, 2015

由于函数也是一个对象,而且函数对象可以被赋值给变量,所以,通过变量也能调用该函数。

>>> def now():
...   print '2013-12-25'
...
>>> f = now
>>> f()
2013-12-25

函数对象有一个__name__属性,可以拿到函数的名字:

>>> now.__name__
'now'
>>> f.__name__
'now'

现在,假设我们要增强now()函数的功能,比如,在函数调用前后自动打印日志,但又不希望修改now()函数的定义,这种在代码运行期间动态增加功能的方式,称之为“装饰器”(Decorator)。

本质上,decorator就是一个返回函数的高阶函数。所以,我们要定义一个能打印日志的decorator,可以定义如下:

def log(func):
  def wrapper(*args, **kw):
    print 'call %s():' % func.__name__
    return func(*args, **kw)
  return wrapper

观察上面的log,因为它是一个decorator,所以接受一个函数作为参数,并返回一个函数。我们要借助Python的@语法,把decorator置于函数的定义处:

@log
def now():
  print '2013-12-25'

调用now()函数,不仅会运行now()函数本身,还会在运行now()函数前打印一行日志:

>>> now()
call now():
2013-12-25

把@log放到now()函数的定义处,相当于执行了语句:

now = log(now)

由于log()是一个decorator,返回一个函数,所以,原来的now()函数仍然存在,只是现在同名的now变量指向了新的函数,于是调用now()将执行新函数,即在log()函数中返回的wrapper()函数。

wrapper()函数的参数定义是(*args, **kw),因此,wrapper()函数可以接受任意参数的调用。在wrapper()函数内,首先打印日志,再紧接着调用原始函数。

如果decorator本身需要传入参数,那就需要编写一个返回decorator的高阶函数,写出来会更复杂。比如,要自定义log的文本:

def log(text):
  def decorator(func):
    def wrapper(*args, **kw):
      print '%s %s():' % (text, func.__name__)
      return func(*args, **kw)
    return wrapper
  return decorator

这个3层嵌套的decorator用法如下:

@log('execute')
def now():
  print '2013-12-25'

执行结果如下:

>>> now()
execute now():
2013-12-25

和两层嵌套的decorator相比,3层嵌套的效果是这样的:

>>> now = log('execute')(now)

我们来剖析上面的语句,首先执行log('execute'),返回的是decorator函数,再调用返回的函数,参数是now函数,返回值最终是wrapper函数。

以上两种decorator的定义都没有问题,但还差最后一步。因为我们讲了函数也是对象,它有__name__等属性,但你去看经过decorator装饰之后的函数,它们的__name__已经从原来的'now'变成了'wrapper':

>>> now.__name__
'wrapper'

因为返回的那个wrapper()函数名字就是'wrapper',所以,需要把原始函数的__name__等属性复制到wrapper()函数中,否则,有些依赖函数签名的代码执行就会出错。

不需要编写wrapper.__name__ = func.__name__这样的代码,Python内置的functools.wraps就是干这个事的,所以,一个完整的decorator的写法如下:

import functools

def log(func):
  @functools.wraps(func)
  def wrapper(*args, **kw):
    print 'call %s():' % func.__name__
    return func(*args, **kw)
  return wrapper

或者针对带参数的decorator:

import functools

def log(text):
  def decorator(func):
    @functools.wraps(func)
    def wrapper(*args, **kw):
      print '%s %s():' % (text, func.__name__)
      return func(*args, **kw)
    return wrapper
  return decorator

import functools是导入functools模块。模块的概念稍候讲解。现在,只需记住在定义wrapper()的前面加上@functools.wraps(func)即可。
小结

在面向对象(OOP)的设计模式中,decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现,而Python除了能支持OOP的decorator外,直接从语法层次支持decorator。Python的decorator可以用函数实现,也可以用类实现。

decorator可以增强函数的功能,定义起来虽然有点复杂,但使用起来非常灵活和方便。

请编写一个decorator,能在函数调用的前后打印出'begin call'和'end call'的日志。

再思考一下能否写出一个@log的decorator,使它既支持:

@log
def f():
  pass

又支持:

@log('execute')
def f():
  pass
Python 相关文章推荐
python中子类继承父类的__init__方法实例
Dec 15 Python
Python中字典(dict)合并的四种方法总结
Aug 10 Python
python基础梳理(一)(推荐)
Apr 06 Python
python绘制直方图和密度图的实例
Jul 08 Python
基于sklearn实现Bagging算法(python)
Jul 11 Python
利用Python小工具实现3秒钟将视频转换为音频
Oct 29 Python
python如何查看网页代码
Jun 07 Python
python高级特性简介
Aug 13 Python
Python eval函数原理及用法解析
Nov 14 Python
解决python3中os.popen()出错的问题
Nov 19 Python
python tkinter模块的简单使用
Apr 07 Python
python opencv人脸识别考勤系统的完整源码
Apr 26 Python
Python中的匿名函数使用简介
Apr 27 #Python
Python中用函数作为返回值和实现闭包的教程
Apr 27 #Python
Python中利用sorted()函数排序的简单教程
Apr 27 #Python
Python中的filter()函数的用法
Apr 27 #Python
Python中的map()函数和reduce()函数的用法
Apr 27 #Python
PyMongo安装使用笔记
Apr 27 #Python
Windows下PyMongo下载及安装教程
Apr 27 #Python
You might like
CodeIgniter配置之database.php用法实例分析
2016/01/20 PHP
Zend Framework教程之Zend_Config_Ini用法分析
2016/03/23 PHP
ThinkPHP自定义Redis处理SESSION的实现方法
2016/05/16 PHP
PHP二维数组矩形转置实例
2016/07/20 PHP
PHP swoole和redis异步任务实现方法分析
2019/08/12 PHP
jquery.ui.draggable中文文档
2009/11/24 Javascript
js对象数组按属性快速排序
2011/01/31 Javascript
Javascript学习笔记之 函数篇(一) : 函数声明和函数表达式
2014/06/24 Javascript
关于javascript模块加载技术的一些思考
2014/11/28 Javascript
2014 年最热门的21款JavaScript框架推荐
2014/12/25 Javascript
JavaScript知识点总结(五)之Javascript中两个等于号(==)和三个等于号(===)的区别
2016/05/31 Javascript
Node.js的Koa框架上手及MySQL操作指南
2016/06/13 Javascript
js实现前端分页页码管理
2017/01/06 Javascript
Vue.js 2.0窥探之Virtual DOM到底是什么?
2017/02/10 Javascript
nodejs和C语言插入mysql数据库乱码问题的解决方法
2017/04/14 NodeJs
vue Render中slots的使用的实例代码
2017/07/19 Javascript
javascript Function函数理解与实战
2017/12/01 Javascript
详解JS数值Number类型
2018/02/07 Javascript
vue 自定义全局方法,在组件里面的使用介绍
2018/02/28 Javascript
JS中的事件委托实例浅析
2018/03/22 Javascript
js实现贪吃蛇游戏 canvas绘制地图
2020/09/09 Javascript
JS实现页面侧边栏效果探究
2021/01/08 Javascript
跟老齐学Python之让人欢喜让人忧的迭代
2014/10/02 Python
在Django的URLconf中进行函数导入的方法
2015/07/18 Python
Python使用try except处理程序异常的三种常用方法分析
2018/09/05 Python
解决python3读取Python2存储的pickle文件问题
2018/10/25 Python
Django 视图层(view)的使用
2018/11/09 Python
解决Django中修改js css文件但浏览器无法及时与之改变的问题
2019/08/31 Python
Python-openCV开运算实例
2020/07/05 Python
Python3爬虫带上cookie的实例代码
2020/07/28 Python
大女孩胸罩:Big Girls Bras
2016/12/15 全球购物
法国床上用品商店:La Compagnie du lit
2019/12/26 全球购物
小学中秋节活动方案
2014/02/06 职场文书
实习生辞职信范文
2015/03/02 职场文书
欢迎新生标语2015
2015/07/16 职场文书
python通配符之glob模块的使用详解
2021/04/24 Python