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正则表达式抓取成语网站
Nov 20 Python
深入Python解释器理解Python中的字节码
Apr 01 Python
Python3实现发送QQ邮件功能(附件)
Dec 23 Python
Python3多线程操作简单示例
May 22 Python
对django中render()与render_to_response()的区别详解
Oct 16 Python
Python 实现两个列表里元素对应相乘的方法
Nov 14 Python
Python调用C语言的实现
Jul 26 Python
Django为窗体加上防机器人的验证码功能过程解析
Aug 14 Python
Python实现在Windows平台修改文件属性
Mar 05 Python
Python运行提示缺少模块问题解决方案
Apr 02 Python
Django模型验证器介绍与源码分析
Sep 08 Python
python 模块导入问题汇总
Feb 01 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
索尼ICF-SW100收音机评测
2021/03/02 无线电
如何对PHP程序中的常见漏洞进行攻击(上)
2006/10/09 PHP
PHP关于IE下的iframe跨域导致session丢失问题解决方法
2013/10/10 PHP
PHP获取php,mysql,apche的版本信息示例代码
2014/01/16 PHP
php+flash+jQuery多图片上传源码分享
2020/07/27 PHP
实例解析php的数据类型
2018/10/24 PHP
PHP基于swoole多进程操作示例
2019/08/12 PHP
javascript实现简单的Map示例介绍
2013/12/23 Javascript
使用jQuery异步加载 JavaScript脚本解决方案
2014/04/20 Javascript
改变状态栏文字的js代码
2014/06/13 Javascript
跟我学习JScript的Bug与内存管理
2015/11/18 Javascript
复杂的javascript窗口分帧解析
2016/02/19 Javascript
JS操作JSON方法总结(推荐)
2016/06/14 Javascript
JS生成不重复的随机数组的简单实例
2016/07/10 Javascript
js实现分页功能
2017/05/24 Javascript
layui表格checkbox选择全选样式及功能的实例
2018/03/07 Javascript
ES6与CommonJS中的模块处理的区别
2018/06/13 Javascript
Vue 组件参数校验与非props特性的方法
2019/02/12 Javascript
详解Vue 全局变量,局部变量
2019/04/17 Javascript
Python编程实现从字典中提取子集的方法分析
2018/02/09 Python
Python转换时间的图文方法
2019/07/01 Python
使用python实现回文数的四种方法小结
2019/11/24 Python
django 将自带的数据库sqlite3改成mysql实例
2020/07/09 Python
CSS3制作酷炫的三维相册效果
2016/07/01 HTML / CSS
详解HTML5 data-* 自定义属性
2018/01/24 HTML / CSS
德国购买健身器材:AsVIVA
2017/08/09 全球购物
社区消防工作实施方案
2014/03/21 职场文书
医院合作协议书
2014/08/19 职场文书
高中校园广播稿3篇
2014/09/29 职场文书
司机岗位职责范本
2015/04/10 职场文书
2015年酒店客房部工作总结
2015/04/25 职场文书
小学推普周活动总结
2015/05/07 职场文书
2015年幼儿教师个人工作总结
2015/05/20 职场文书
Python爬虫之爬取最新更新的小说网站
2021/05/06 Python
Windows Server 2019 安装DHCP服务及相关配置
2022/04/28 Servers
python解析照片拍摄时间进行图片整理
2022/07/23 Python