Python Decorator基础

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

正文

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

  1. # -*- coding: utf-8 -*- 
  2.  
  3. def log_cost_time(func): 
  4.  
  5.     def wrapped(*args, **kwargs): 
  6.  
  7.         import time 
  8.  
  9.         begin = time.time() 
  10.  
  11.         try: 
  12.  
  13.             return func(*args, **kwargs) 
  14.  
  15.         finally: 
  16.  
  17.             print 'func %s cost %s' % (func.__name__, time.time() - begin
  18.  
  19.     return wrapped 
  20.  
  21.   
  22.  
  23. @log_cost_time 
  24.  
  25. def complex_func(num): 
  26.  
  27.     ret = 0 
  28.  
  29.     for i in xrange(num): 
  30.  
  31.         ret += i * i 
  32.  
  33.     return ret 
  34.  
  35. #complex_func = log_cost_time(complex_func) 
  36.  
  37.   
  38.  
  39. if __name__ == '__main__'
  40.  
  41.     print complex_func(100000) 
  42.  
  43.   
  44.  
  45. code snippet 0  

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

装饰器的语法如下:

  1. @dec 
  2.  
  3. def func():pass  

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

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

装饰器是可以嵌套的,如

  1. @dec0 
  2.  
  3. @dec1 
  4.  
  5. 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__)

  • unctools.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.  
  3. def log_cost_time(func): 
  4.  
  5.     @functools.wraps(func) 
  6.  
  7.     def wrapped(*args, **kwargs): 
  8.  
  9.         import time 
  10.  
  11.         begin = time.time() 
  12.  
  13.         try: 
  14.  
  15.             return func(*args, **kwargs) 
  16.  
  17.         finally: 
  18.  
  19.             print 'func %s cost %s' % (func.__name__, time.time() - begin
  20.  
  21.     return wrapped  

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

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

  1. def log_cost_time(stream): 
  2.  
  3.     def inner_dec(func): 
  4.  
  5.         def wrapped(*args, **kwargs): 
  6.  
  7.             import time 
  8.  
  9.             begin = time.time() 
  10.  
  11.             try: 
  12.  
  13.                 return func(*args, **kwargs) 
  14.  
  15.             finally: 
  16.  
  17.                 stream.write('func %s cost %s \n' % (func.__name__, time.time() - begin)) 
  18.  
  19.         return wrapped 
  20.  
  21.     return inner_dec 
  22.  
  23.   
  24.  
  25. import sys 
  26.  
  27. @log_cost_time(sys.stdout) 
  28.  
  29. def complex_func(num): 
  30.  
  31.     ret = 0 
  32.  
  33.     for i in xrange(num): 
  34.  
  35.         ret += i * i 
  36.  
  37.     return ret 
  38.  
  39.   
  40.  
  41. if __name__ == '__main__'
  42.  
  43.     print complex_func(100000) 
  44.  
  45.   
  46.  
  47. code snippet 1  

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

  1. @dec(dec_args) 
  2.  
  3. def func(*args, **kwargs):pass  

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

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

  1. def Haha(clz): 
  2.  
  3.     clz.__str__ = lambda s: "Haha" 
  4.  
  5.     return clz 
  6.  
  7.   
  8.  
  9. @Haha 
  10.  
  11. class Widget(object): 
  12.  
  13.     ''' class Widget ''' 
  14.  
  15.   
  16.  
  17. if __name__ == '__main__'
  18.  
  19.     w = Widget() 
  20.  
  21.     print w 

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

动态地为某个对象增加额外的责任

由于装饰器模式仅从外部改变组件,因此组件无需对它的装饰有任何了解;也就是说,这些装饰对该组件是透明的。

下图来自《设计模式Java手册》或者GOF的《设计模式》 

 

 

 

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

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

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

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

  1. def catchall(func): 
  2.  
  3.     @functools.wraps(func) 
  4.  
  5.     def wrapped(*args, **kwargs): 
  6.  
  7.         try: 
  8.  
  9.             return func(*args, **kwargs) 
  10.  
  11.         except
  12.  
  13.             pass 
  14.  
  15.     return wrapped  

(4)框架代码,如flask, bottle等等,让使用者很方便就能使用框架,本质上也避免了重复代码。

decorator的奇妙应用往往超出相应,经常在各种源码中看到各种神奇的用法,酷壳这篇文章举的例子也不错。

参考

  • pep 0318:https://www.python.org/dev/peps/pep-0318/#syntax-alternatives
  • PYTHON修饰器的函数式编程:http://coolshell.cn/articles/11265.html
责任编辑:庞桂玉 来源: Python开发者
相关推荐

2021-02-18 15:43:37

Python装饰器Decorator

2021-10-03 15:06:28

Python文件字符

2010-03-10 16:05:27

2021-08-11 09:00:30

Python基础循环

2021-03-04 10:37:37

PythonMongoDB数据库

2021-07-21 10:18:21

Python条件语句Python基础

2024-01-08 22:03:22

python代码开发

2017-06-20 15:39:58

Koa2 应用动态Swagger文档

2021-02-20 09:27:36

Python编程语言机器学习

2011-07-12 17:26:02

PHPPython

2011-05-23 16:40:00

python

2023-07-14 15:10:17

PythonAsyncIO库

2021-04-16 23:23:44

Python开发语言

2010-02-03 10:36:56

Python基础知识

2021-04-15 14:30:39

Python编程语言

2021-03-13 10:14:59

Python定义函数Python基础

2017-07-20 17:05:04

JavaScriptswagger-decSwagger

2021-01-13 14:55:54

JavaPython开发

2018-04-20 17:25:46

Python爬虫智联招聘

2021-04-28 10:01:06

Python基础项目
点赞
收藏

51CTO技术栈公众号