举例讲解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发送Email方法实例
Aug 21 Python
Python中__call__用法实例
Aug 29 Python
Python可跨平台实现获取按键的方法
Mar 05 Python
用PyQt进行Python图形界面的程序的开发的入门指引
Apr 14 Python
Python实现统计英文单词个数及字符串分割代码
May 28 Python
浅谈Pandas中map, applymap and apply的区别
Apr 10 Python
python函数与方法的区别总结
Jun 23 Python
python 3.7.4 安装 opencv的教程
Oct 10 Python
django 解决扩展自带User表遇到的问题
May 14 Python
简述 Python 的类和对象
Aug 21 Python
教你如何用Python实现人脸识别(含源代码)
Jun 23 Python
基于PyQt5制作一个群发邮件工具
Apr 08 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
php生成随机密码的几种方法
2011/01/17 PHP
5种PHP创建数组的实例代码分享
2014/01/17 PHP
php数组冒泡排序算法实例
2016/05/06 PHP
php实现用户注册密码的crypt加密
2017/06/08 PHP
php使用自带dom扩展进行元素匹配的原理解析
2020/05/29 PHP
extjs之去除s.gif的影响
2010/12/25 Javascript
jquery中ajax学习笔记一
2011/10/16 Javascript
js中的cookie的读写操作示例详解
2014/04/17 Javascript
JavaScript保留关键字汇总
2015/12/01 Javascript
JS实现动态表格的添加,修改,删除功能(推荐)
2016/06/15 Javascript
html+js实现简单的计算器代码(加减乘除)
2016/07/12 Javascript
模拟javascript中的sort排序(简单实例)
2016/08/17 Javascript
EasyUI的doCellTip实现鼠标放到单元格上提示单元格内容
2016/08/24 Javascript
使用SVG基本操作API的实例讲解
2017/09/14 Javascript
Vue头像处理方案小结
2018/07/26 Javascript
webpack 最佳配置指北(推荐)
2020/01/07 Javascript
原生JS实现多条件筛选
2020/08/19 Javascript
微信小程序实现日历签到
2020/09/21 Javascript
python支持断点续传的多线程下载示例
2014/01/16 Python
Python标准库之随机数 (math包、random包)介绍
2014/11/25 Python
python检测IP地址变化并触发事件
2018/12/26 Python
python 实现读取一个excel多个sheet表并合并的方法
2019/02/12 Python
python logging模块的使用总结
2019/07/09 Python
python之pexpect实现自动交互的例子
2019/07/25 Python
Python爬虫学习之获取指定网页源码
2019/07/30 Python
pandas DataFrame创建方法的方式
2019/08/02 Python
分享一个python的aes加密代码
2020/12/22 Python
使用CSS3来匹配横屏竖屏的简单方法
2015/08/04 HTML / CSS
简单掌握CSS3中resize属性的用法
2016/04/01 HTML / CSS
HTML5表单验证特性(知识点小结)
2020/03/10 HTML / CSS
澳大利亚领先的睡衣品牌:Peter Alexander
2016/08/16 全球购物
信息与计算科学专业推荐信
2014/02/23 职场文书
2014乡镇班子个人对照检查材料思想汇报
2014/09/26 职场文书
2015年党建工作目标责任书
2015/05/08 职场文书
心理健康教育培训研修感言
2015/11/18 职场文书
SQL CASE 表达式的具体使用
2022/03/21 SQL Server