Python装饰器(decorator)定义与用法详解


Posted in Python onFebruary 09, 2018

本文实例讲述了Python装饰器(decorator)定义与用法。分享给大家供大家参考,具体如下:

什么是装饰器(decorator)

简单来说,可以把装饰器理解为一个包装函数的函数,它一般将传入的函数或者是类做一定的处理,返回修改之后的对象.所以,我们能够在不修改原函数的基础上,在执行原函数前后执行别的代码.比较常用的场景有日志插入,事务处理等.

装饰器

最简单的函数,返回两个数的和

def calc_add(a, b):
 return a + b
calc_add(1, 2)

但是现在又有新的需求,计算求和操作耗时,很简单,求和前获取一下时间,求和后再获取一次,求差即可

import datetime
def calc_add(a, b):
 start_time = datetime.datetime.now()
 result = a + b
 end_tiem = datetime.datetime.now()
 print "result:", result, "used:", (end_tiem - start_time).microseconds, "μs"
 return result
calc_add(1, 2)

现在呢,函数calc_diff(a, b),计算a-b,也想计算减法操作的时间差,很好办,把那段代码复制过去.但是假如我们现在想编的是一个数学函数库,各种函数都想计算其执行耗时,总不能一个一个复制代码,想个更好的办法.

我们知道,在Python中函数也是被视为对象的,可以作为参数传递,那么假如把计算耗时的独立为一个单独的函数calc_spend_time(),然后把需要计算耗时的函数例如calc_add的引用传递给它,在calc_spend_time中调用calc_add,这样所有的需要计算耗时的函数都不用修改自己的代码了.

def calc_spend_time(func, *args, **kargs):
 start_time = datetime.datetime.now()
 result = func(*args, **kargs)
 end_tiem = datetime.datetime.now()
 print "result:", result, "used:", (end_tiem - start_time).microseconds, "μs"
def calc_add(a, b):
 return a + b
calc_spend_time(calc_add, 1, 1)
# calc_spend_time(calc_add, a=1, b=2)

看起来也不错,负责计算的函数不用更改,只需调用的时候作为参数传给计算时间差的函数.但就是这,调用的时候形式变了,不再是clac(1, 2),而是calc_spend_time(clac_add, 1, 2),万一calc_add大规模被调用,那么还得一处一处找,然后修改过来,还是很麻烦.如果想不修改代码,就得使clac()calc_spend_time(clac)效果一样,那么可以在calc_spend_time()里把传入的clac包装一下,然后返回包装后的新的函数,再把返回的包装好的函数赋给clac,那么calc()的效果就和上例calc_spend_time(calc())效果一样.

import datetime
def calc_spend_time(func):
 def new_func(a, b):
  start_time = datetime.datetime.now()
  result = func(a, b)
  end_tiem = datetime.datetime.now()
  print "result:", result, "used:", (end_tiem - start_time).microseconds, "μs"
 return new_func
def calc_add(a, b):
 return a + b
calc_add = calc_spend_time(calc_add)
calc_add(1, 2)

语法糖

上面的例子就是装饰器的概念,包装函数的函数.事实上上面的例子还可以更精简

import datetime
def calc_spend_time(func):
 def new_func(a, b):
  start_time = datetime.datetime.now()
  result = func(a, b)
  end_tiem = datetime.datetime.now()
  print "result:", result, "used:", (end_tiem - start_time).microseconds, "μs"
 return new_func
@calc_spend_time
def calc_add(a, b):
 return a + b
calc_add(1, 2)

@calc_spend_time就是语法糖,它的本质就是:calc_add = calc_spend_time(calc_add)

无参数的函数装饰器

import datetime
def calc_spend_time(func):
 def new_func(*args, **kargs):
  start_time = datetime.datetime.now()
  result = func(*args, **kargs)
  end_tiem = datetime.datetime.now()
  print "result:", result, "used:", (end_tiem - start_time).microseconds, "μs"
 return new_func
@calc_spend_time
def calc_add(a, b):
 return a + b
@calc_spend_time
def calc_diff(a, b):
 return a - b
calc_add(a=1, b=2)
calc_diff(1, 2)

注:

*args:把所有的参数按出现顺序打包成list
**kargs:把所有的key=value形式的参数打包成一个dict

带参数的函数装饰器

假如我们需要知道函数的一些额外信息,例如函数作者,可以通过给装饰器函数增加参数来实现.

import datetime
def calc_spend_time(author):
 def first_deco(func):
  def new_func(*args, **kargs):
   start_time = datetime.datetime.now()
   result = func(*args, **kargs)
   end_tiem = datetime.datetime.now()
   print author, "result:", result, "used:", (end_tiem - start_time).microseconds, "μs"
  return new_func
 return first_deco
@calc_spend_time('author_1')
def calc_add(a, b):
 return a + b
@calc_spend_time('author_2')
def calc_diff(a, b):
 return a - b
calc_add(a=1, b=2)
calc_diff(1, 2)

Python内置装饰器

Python内置的装饰器有三个:staticmethodclassmethodproperty

staticmethod:把类中的方法定义为静态方法,使用staticmethod装饰的方法可以使用类或者类的实例对象来调用,不需要传入self

class Human(object):
 """docstring for Human"""
 def __init__(self):
  super(Human, self).__init__()
 @staticmethod
 def say(message):
  if not message:
   message = 'hello'
  print 'I say %s' % message
 def speak(self, message):
  self.say(message)
Human.say(None)
human = Human()
human.speak('hi')

输出:

I say hello
I say hi

classmethod:把类中的方法定义为类方法,使用classmethod装饰的方法可以使用类或者类的实例对象来调用,并将该class对象隐式的作为第一个参数传入

class Human(object):
 """docstring for Human"""
 def __init__(self):
  super(Human, self).__init__()
  self.message = '111'
 def say(message):
  if not message:
   message = 'hello'
  print 'I say %s' % message
 @classmethod
 def speak(cls, message):
  if not message:
   message = 'hello'
  cls.say(message)
human = Human()
human.speak('hi')

输出同上例

property:把方法变成属性

class Human(object):
 """docstring for Human"""
 def __init__(self, value):
  super(Human, self).__init__()
  self._age = value
 @property
 def age(self):
  return self._age
human = Human(20)
print human.age

更多关于Python相关内容可查看本站专题:《Python数据结构与算法教程》、《Python Socket编程技巧总结》、《Python函数使用技巧总结》、《Python字符串操作技巧汇总》及《Python入门与进阶经典教程》

希望本文所述对大家Python程序设计有所帮助。

Python 相关文章推荐
Python导入txt数据到mysql的方法
Apr 08 Python
python机器学习之神经网络实现
Oct 13 Python
Python解析命令行读取参数之argparse模块
Jul 26 Python
python2爬取百度贴吧指定关键字和图片代码实例
Aug 14 Python
利用Python实现kNN算法的代码
Aug 16 Python
解析python实现Lasso回归
Sep 11 Python
python 解决tqdm模块不能单行显示的问题
Feb 19 Python
Python列表切片常用操作实例解析
Mar 10 Python
150行python代码实现贪吃蛇游戏
Apr 24 Python
python字典按照value排序方法
Dec 28 Python
Python实现学生管理系统(面向对象版)
Jun 24 Python
使用Python+OpenCV进行卡类型及16位卡号数字的OCR功能
Aug 30 Python
详解python的ORM中Pony用法
Feb 09 #Python
python监控键盘输入实例代码
Feb 09 #Python
Python with语句上下文管理器两种实现方法分析
Feb 09 #Python
Python遍历pandas数据方法总结
Feb 09 #Python
python中的闭包函数
Feb 09 #Python
基于Python socket的端口扫描程序实例代码
Feb 09 #Python
利用python 更新ssh 远程代码 操作远程服务器的实现代码
Feb 08 #Python
You might like
PHP 文件系统详解
2012/09/13 PHP
CentOS下搭建PHP环境与WordPress博客程序的全流程总结
2016/05/07 PHP
Yii2.0框架behaviors方法使用实例分析
2019/09/30 PHP
PHP常用函数之格式化时间操作示例
2019/10/21 PHP
将HTML自动转为JS代码
2006/06/26 Javascript
让网页跳转到指定位置的jquery代码非书签
2013/09/06 Javascript
Javascript显示和隐藏ul列表的方法
2015/07/15 Javascript
javascript中加var和不加var的区别 你真的懂吗
2016/01/06 Javascript
etmvc+jQuery EasyUI+combobox多值操作实现角色授权实例
2016/11/09 Javascript
使用vue实现点击按钮滑出面板的实现代码
2017/01/10 Javascript
Javascript继承机制详解
2017/05/30 Javascript
基于构造函数的五种继承方法小结
2017/07/27 Javascript
浅谈Node 异步IO和事件循环
2019/05/05 Javascript
vue项目中引入Sass实例方法
2019/08/27 Javascript
Python中的tuple元组详细介绍
2015/02/02 Python
python中安装Scrapy模块依赖包汇总
2017/07/02 Python
python遍历文件夹,指定遍历深度与忽略目录的方法
2018/07/11 Python
pytorch中获取模型input/output shape实例
2019/12/30 Python
Python实现小黑屋游戏的完整实例
2021/01/06 Python
使用html2canvas将页面转成图并使用用canvas2image下载
2019/04/04 HTML / CSS
UGG雪地靴荷兰官网:UGG荷兰
2016/09/09 全球购物
领先的钻石和订婚戒指零售商:Diamonds-USA
2016/12/11 全球购物
卡骆驰英国官网:Crocs英国
2019/08/22 全球购物
新锐科技Java程序员面试题
2016/07/25 面试题
11月红领巾广播稿
2014/01/17 职场文书
《藤野先生》教学反思
2014/02/19 职场文书
放飞梦想演讲稿200字
2014/08/26 职场文书
团队拓展活动总结
2014/08/27 职场文书
公司员工安全协议书
2014/11/21 职场文书
2015年学生会纪检部工作总结
2015/03/31 职场文书
清明祭英烈活动总结
2015/05/11 职场文书
2015年政府采购工作总结
2015/05/21 职场文书
积极心理学课程心得体会
2016/01/22 职场文书
小学一年级数学教学反思
2016/02/16 职场文书
Nginx解决前端访问资源跨域问题的方法详解
2021/03/31 Servers
MySQL 如何设计统计数据表
2021/06/15 MySQL