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的类实例属性访问规则探讨
Jan 30 Python
Python解析xml中dom元素的方法
Mar 12 Python
Python3搜索及替换文件中文本的方法
May 22 Python
Python如何判断数独是否合法
Sep 08 Python
Python面向对象编程之继承与多态详解
Jan 16 Python
python 日期操作类代码
May 05 Python
python实现定时提取实时日志程序
Jun 22 Python
Python subprocess库的使用详解
Oct 26 Python
django获取from表单multiple-select的value和id的方法
Jul 19 Python
解决Pytorch 训练与测试时爆显存(out of memory)的问题
Aug 20 Python
Python 3 使用Pillow生成漂亮的分形树图片
Dec 24 Python
python实现调用摄像头并拍照发邮箱
Apr 27 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的开发框架的现状和展望
2007/03/16 PHP
Linux fgetcsv取得的数组元素为空字符串的解决方法
2011/11/25 PHP
php中global和$GLOBALS[]的分析之一
2012/02/02 PHP
php shell超强免杀、减少体积工具实现代码
2012/10/16 PHP
PHP字符串的编码问题的详细介绍
2013/04/27 PHP
php数字每三位加逗号的功能函数
2015/10/22 PHP
PHP高精确度运算BC函数库实例详解
2017/08/15 PHP
Yaf框架封装的MySQL数据库操作示例
2019/03/06 PHP
DEFER怎么用?
2006/07/01 Javascript
Jquery创建一个层当鼠标移动到层上面不消失效果
2013/12/12 Javascript
使用JavaScript脚本判断页面是否在微信中被打开
2016/03/06 Javascript
关于cookie的初识和运用(js和jq)
2016/04/07 Javascript
深入理解requestAnimationFrame的动画循环
2016/09/20 Javascript
require、backbone等重构手机图片查看器
2016/11/17 Javascript
基于bootstrap的文件上传控件bootstrap fileinput
2016/12/23 Javascript
解决vue 更改计算属性后select选中值不更改的问题
2018/03/02 Javascript
vue仿element实现分页器效果
2018/09/13 Javascript
Vue 实现html中根据类型显示内容
2019/10/28 Javascript
Python程序设计入门(2)变量类型简介
2014/06/16 Python
浅析AST抽象语法树及Python代码实现
2016/06/06 Python
python 使用 requests 模块发送http请求 的方法
2018/12/09 Python
python等差数列求和公式前 100 项的和实例
2020/02/25 Python
解决python3插入mysql时内容带有引号的问题
2020/03/02 Python
Selenium向iframe富文本框输入内容过程图解
2020/04/10 Python
德国汉莎航空中国官网: Lufthansa中国
2017/03/30 全球购物
英国赛车、汽车改装和摩托车零件购物网站:Demon Tweeks
2018/10/29 全球购物
吉列剃须刀英国官网:Gillette英国
2019/03/28 全球购物
化工专业应届生求职信
2013/11/08 职场文书
计算机专业推荐信范文
2013/11/27 职场文书
幼儿园中班教师寄语
2014/04/03 职场文书
小学生新年寄语
2014/04/03 职场文书
计算机专业自荐信
2014/05/24 职场文书
办公室主任个人对照检查材料思想汇报
2014/10/11 职场文书
机关干部四风问题自查报告及整改措施
2014/10/26 职场文书
2014年销售员工作总结
2014/12/01 职场文书
java获取一个文本文件的编码(格式)信息
2022/09/23 Java/Android