举例讲解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二叉树遍历的实现方法
Nov 21 Python
Python实现3行代码解简单的一元一次方程
Aug 18 Python
python以环状形式组合排列图片并输出的方法
Mar 17 Python
Swift 3.0在集合类数据结构上的一些新变化总结
Jul 11 Python
Python脚本实现Web漏洞扫描工具
Oct 25 Python
Python简单生成8位随机密码的方法
May 24 Python
用Python实现KNN分类算法
Dec 22 Python
python dlib人脸识别代码实例
Apr 04 Python
用Python+OpenCV对比图像质量的几种方法
Jul 15 Python
解决Python3 抓取微信账单信息问题
Jul 19 Python
python中必要的名词解释
Nov 20 Python
PIL包中Image模块的convert()函数的具体使用
Feb 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
Linux下安装PHP MSSQL扩展教程
2014/10/24 PHP
8个必备的PHP功能开发
2015/10/02 PHP
PHP实现查询两个数组中不同元素的方法
2016/02/23 PHP
thinkPHP连接sqlite3数据库的实现方法(附Thinkphp代码生成器下载)
2016/05/27 PHP
PHP入门教程之数组用法汇总(创建,删除,遍历,排序等)
2016/09/11 PHP
php中引用符号(&)的使用详细介绍
2016/12/06 PHP
php获取excel文件数据
2017/04/21 PHP
HTML中的setCapture和releaseCapture使用介绍
2012/03/21 Javascript
php图像生成函数之间的区别分析
2012/12/06 Javascript
JavaScript中的运算符种类及其规则介绍
2013/09/26 Javascript
提高NodeJS中SSL服务的性能
2014/07/15 NodeJs
实践中学习AngularJS表单
2016/03/21 Javascript
使用gulp搭建本地服务器并实现模拟ajax
2017/04/05 Javascript
微信JSAPI Ticket接口签名详解
2020/06/28 Javascript
js登录滑动验证的实现(不滑动无法登陆)
2018/01/03 Javascript
vue keep-alive请求数据的方法示例
2018/05/16 Javascript
Koa 中的错误处理解析
2019/04/09 Javascript
Element-ui el-tree新增和删除节点后如何刷新tree的实例
2020/08/31 Javascript
[49:02]KG vs Infamous 2019国际邀请赛淘汰赛 败者组BO1 8.20.mp4
2020/07/19 DOTA
Python实现代码统计工具(终极篇)
2016/07/04 Python
基于python(urlparse)模板的使用方法总结
2017/10/13 Python
Python Cookie 读取和保存方法
2018/12/28 Python
Python字典的核心底层原理讲解
2019/01/24 Python
python二元表达式用法
2019/12/04 Python
jupyter notebook 增加kernel教程
2020/04/10 Python
浅谈numpy中函数resize与reshape,ravel与flatten的区别
2020/06/18 Python
Scrapy项目实战之爬取某社区用户详情
2020/09/17 Python
python 实现的车牌识别项目
2021/01/25 Python
学习十八大精神心得体会
2013/12/31 职场文书
省级青年文明号申报材料
2014/05/23 职场文书
2014班子“三严三实”对照检查材料思想汇报
2014/09/18 职场文书
求职简历自我评价范文
2015/03/10 职场文书
业务员岗位职责范本
2015/04/03 职场文书
初中班长竞选稿
2015/11/20 职场文书
《童年》读后感(三篇)
2019/08/27 职场文书
如何在CSS中绘制曲线图形及展示动画
2021/05/24 HTML / CSS