python decorator 基础

转自:http://www.cnblogs.com/xybaby/p/6274187.html

  一般来说,装饰器是一个函数,接受一个函数(或者类)作为参数,返回值也是也是一个函数(或者类)。首先来看一个简单的例子:

# -*- coding: utf-8 -*-
 2 def log_cost_time(func):
 3     def wrapped(*args, **kwargs):
 4         import time
 5         begin = time.time()
 6         try:
 7             return func(*args, **kwargs)
 8         finally:
 9             print ‘func %s cost %s‘ % (func.__name__, time.time() - begin)
10     return wrapped
11
12 @log_cost_time
13 def complex_func(num):
14     ret = 0
15     for i in xrange(num):
16         ret += i * i
17     return ret
18 #complex_func = log_cost_time(complex_func)
19
20 if __name__ == ‘__main__‘:
21     print complex_func(100000)

复制代码

代码中,函数log_cost_time就是一个装饰器,其作用也很简单,打印被装饰函数运行时间。

装饰器的语法如下:

1 @dec
2     def func():pass

本质上等同于: func = dec(func)。

  在上面的代码(code snippet 0)中,把line12注释掉,然后把line18的注释去掉,是一样的效果。另外staticmethod和classmethod是两个我们经常在代码中用到的装饰器,如果对pyc反编译,得到的代码一般也都是 func = staticmthod(func)这种模式。当然,@符号的形式更受欢迎些,至少可以少拼写一次函数名。

装饰器是可以嵌套的,如

@dec0

@dec1

def func():pass

等将于 func = dec0(dec1(fun))。

  装饰器也有“副作用“”,对于被log_cost_time装饰的complex_calc, 我们查看一下complex_func.__name__,输出是:”wrapped“”。额,这个是log_cost_time里面inner function(wrapped)的名字,调用者当然希望输出是"complex_func",为了解决这个问题,python提供了两个函数。

  • functools.update_wrapper

   原型: functools.update_wrapper(wrapper, wrapped[, assigned][, updated])

   第三个参数,将wrapped的值直接复制给wrapper,默认为(__doc__, __name__, __module__)

   第四个参数,update,默认为(__dict__)

  • functools.wraps: update_wrapper的封装

  

This is a convenience function for invoking partial(update_wrapper,wrapped=wrapped,assigned=assigned,updated=updated) as a function decorator when defining a wrapper function.

简单改改代码:

 1 import functools
 2 def log_cost_time(func):
 3     @functools.wraps(func)
 4     def wrapped(*args, **kwargs):
 5         import time
 6         begin = time.time()
 7         try:
 8             return func(*args, **kwargs)
 9         finally:
10             print ‘func %s cost %s‘ % (func.__name__, time.time() - begin)
11     return wrapped

再查看complex_func.__name__ 输出就是 “complex_func”

装饰器也是可以带参数的。我们将上面的代码略微修改一下:

 1 def log_cost_time(stream):
 2     def inner_dec(func):
 3         def wrapped(*args, **kwargs):
 4             import time
 5             begin = time.time()
 6             try:
 7                 return func(*args, **kwargs)
 8             finally:
 9                 stream.write(‘func %s cost %s \n‘ % (func.__name__, time.time() - begin))
10         return wrapped
11     return inner_dec
12
13 import sys
14 @log_cost_time(sys.stdout)
15 def complex_func(num):
16     ret = 0
17     for i in xrange(num):
18         ret += i * i
19     return ret
20
21 if __name__ == ‘__main__‘:
22     print complex_func(100000)

log_cost_time函数也接受一个参数,该参数用来指定信息的输出流,对于带参数的decorator

  @dec(dec_args)

  def func(*args, **kwargs):pass

  等价于 func = dec(dec_args)(*args, **kwargs)。

装饰器对类的修饰也是很简单的,只不过平时用得不是很多。举个例子,我们需要给修改类的__str__方法,代码很简单。

 1 def Haha(clz):
 2     clz.__str__ = lambda s: "Haha"
 3     return clz
 4
 5 @Haha
 6 class Widget(object):
 7     ‘‘‘ class Widget ‘‘‘
 8
 9 if __name__ == ‘__main__‘:
10     w = Widget()
11     print w

那什么场景下有必要使用decorator呢,设计模式中有一个模式也叫装饰器。我们先简单回顾一下设计模式中的装饰器模式,简单的一句话概述

 动态地为某个对象增加额外的责任
 由于装饰器模式仅从外部改变组件,因此组件无需对它的装饰有任何了解;也就是说,这些装饰对该组件是透明的。

回到Python中来,用decorator语法实现装饰器模式是很自然的,比如文中的示例代码,在不改变被装饰对象的同时增加了记录函数执行时间的额外功能。当然,由于Python语言的灵活性,decorator是可以修改被装饰的对象的(比如装饰类的例子)。decorator在python中用途非常广泛,下面列举几个方面:

  (1)修改被装饰对象的属性或者行为

  (2)处理被函数对象执行的上下文,比如设置环境变量,加log之类

  (3)处理重复的逻辑,比如有N个函数都可能跑出异常,但是我们不关心这些异常,只要不向调用者传递异常就行了,这个时候可以写一个catchall的decorator,作用于所用可能跑出异常的函数

def catchall(func):
    @functools.wraps(func)
    def wrapped(*args, **kwargs):
        try:
            return func(*args, **kwargs)
        except:
            pass
    return wrapped

references

pep 0318:https://www.python.org/dev/peps/pep-0318/#syntax-alternatives

PYTHON修饰器的函数式编程:http://coolshell.cn/articles/11265.html

时间: 2024-10-13 06:27:05

python decorator 基础的相关文章

PYTHON 一些基础面试题目总结

PYTHON 一些基础面试题目总结http://www.bieryun.com/1191.html 1.       Python是如何进行内存管理的? 答:从三个方面来说,一对象的引用计数机制,二垃圾回收机制,三内存池机制 一.对象的引用计数机制 python内部使用引用计数,来保持追踪内存中的对象,所有对象都有引用计数. 引用计数增加的情况: 1,一个对象分配一个新名称 2,将其放入一个容器中(如列表.元组或字典) 引用计数减少的情况: 1,使用del语句对对象别名显示的销毁 2,引用超出作

问道python之基础篇【二】python入门

问道python之基础篇[二] Python入门 1.python的工作过程 python解释器把源代码转换为字节码的中间形式,然后再把它翻译成机器使用的机器语言并运行. 2.pyc文件 2.1.什么是pyc文件 执行python代码时,如果导入了其他的.py文件,那么在执行过程中会自动生成一个与其同名的.pyc文件,该文件就是python解释器编译之后产生的字节码. ps:代码经过编译可以产生字节码:字节码通过反编译也可以得到代码. Pyc文件一般由3个部分组成: 最开始4个字节是一个Maig

老少皆宜的密大Python零基础入门

Who are we? MTech是一个由密歇根大学 工程院中 (AE/ME)的中国学生组成的的一个专注于专业知识和技能的分享和交流的俱乐部.我们创建这个俱乐部旨在促进工程专业中国学生之间技术层面的交流,搭建桥梁促进知识的分享和传播.请关注我们的微信公众号("密大MTech")和我们的网站(mtechmae.webstarts.com)了解关于我们的更多信息. What is Python? Python是一种面向对象.直译式的编程语言.它的语法简单,并包含了功能完备的库,适合解决很多

python/HTML基础

---恢复内容开始--- python/HTML基础 HTML: 超文本标记(标签)语言 (以<>扩起来的都是标签语言,放入标签里的不仅仅是文本)一套语言规则 浏览器的渲染顺序是从上到下,从左到右 不同的浏览器,对同一标签可能会有不完全相同的解释(兼容性)至今已经解决的差不多了 .html或htm   静态网页文件扩展名后缀 标签可以进行嵌套,但是不能进行交叉嵌套 HTML 不是一种编程语言,而是一种标记语言,HTML使用标记标签来描述网页 HTML结构: <html></h

Python服务器开发二:Python网络基础

Python服务器开发二:Python网络基础 网络由下往上分为物理层.数据链路层.网络层.传输层.会话层.表示层和应用层. HTTP是高层协议,而TCP/IP是个协议集,包过许多的子协议.包括:传输层的 FTP,UDP,TCP协议等,网络层的ip协议等,高层协议如HTTP,telnet协议等,HTTP是TCP/IP的一个子协议. socket是对TCP/IP协议的封装和应用(程序员层面上).也可以说,TPC/IP协议是传输层协议,主要解决数据如何在网络中传输,而HTTP是应用层协议,主要解决如

问道python之基础篇【一】 认识python

问道python之基础篇[一] 认识python 1.python的简介 1.1.什么是python? Python是一种面向对象.解释型计算机程序设计语言,由Guido van Rossum于1989年发明,第一个公开发行版发行于1991年. Python语法简洁清晰,特色之一是强制用空白符作为语句缩进. Python具有丰富和强大的库.它常被昵称为胶水语言,能够用其他语言制作的各种模块(尤其是C++)很轻松地联结在一起. 1.2.python的特点 简单,易学,免费.开源,高层语言,移植性,

Python学习基础篇第一篇——快速入门(适合初学者)

一.Python学习基础篇第一篇--(快速入门) 建议从Python2.7开始学习,Python2.7可以支持扩展大量的第三方类库,是目前比较成熟的版本 编写代码的软件推荐将python自带的IDLE和PyCharm集成IDE结合起来使用 1.1 Python命令行 Python命令行将以 >>> 开始,比如 >>>print 'Hello World!' 对于验证简单的命令可以在python自带的IDLE中完成  1.2 在Python自带的IDLE写一段小程序 在所

python 网络基础

服务器客户端模式,服务器存在唯一目的是:等待客户的请求, 一.套接字 unix套接字,AF_LOCAL,地址家族,缩写:AF,AF_LOCAL将代替AF_UNIX,很多时候两者等价 基于网络的套接字,AF_INET,AF_INET6 AF_NETLINK,无连接 python只支持AF_UNIX,AF_NETLINK,AF_INET家族 一种面向连接的:tcp协议,SOCK_STREAM 一种面向无连接的:udp协议,SOCK_DGRAM socket创建套接字,语法如下: socket(soc

Python爬虫基础之requests

一.随时随地爬取一个网页下来 怎么爬取网页?对网站开发了解的都知道,浏览器访问Url向服务器发送请求,服务器响应浏览器请求并返回一堆HTML信息,其中包括html标签,css样式,js脚本等.我们之前用的是Python标准基础库Urllib实现的, 现在我们使用Python的Requests HTTP库写个脚本开始爬取网页.Requests的口号很响亮“让HTTP服务人类“,够霸气. 二.Python Requests库的基本使用 1.GET和POST请求方式 GET请求 1 import re