Python—装饰器函数

楔子

做为一个会写函数的python开发，咱们从今天开始要去公司上班了。写了一个函数，就交给其余开发用了。

def func1(): print('in func1')

季度末，公司的领导要给你们发绩效奖金了，就提议对这段日子全部人开发的成果进行审核，审核的标准是什么呢？就是统计每一个函数的执行时间。

这个时候你要怎么作呀？

你一想，这好办，把函数一改：

import time def func1(): start = time.time() print('in func1') print(time.time() - start) func1()

来公司半年，写了2000+函数，挨个改一遍，1个礼拜过去了，等领导审核完，再挨个给删了。。。又1个礼拜过去了。。。这是否是很闹心？

你以为不行，不能让本身费劲儿，告诉全部开发，如今大家都在本身本来的代码上加上一句计算时间的语句？

import time def func1(): print('in func1') start = time.time() func1() print(time.time() - start)

仍是不行，由于这样对于开发同事来说实在是太麻烦了。

那怎么办呢？你灵机一动，写了一个timer函数。。。

import time def timer(func): start = time.time() func() print(time.time() - start) def func1(): print('in func1') def func2(): print('in func2') timer(func1) timer(func2)

这样看起来是否是简单多啦？无论咱们写了多少个函数均可以调用这个计时函数来计算函数的执行时间了。。。尽管如今修改为本已经变得很小很小了，可是对于同事来讲仍是改变了这个函数的调用方式，假如某同事由于相信你，在他的代码里用你的方法用了2w屡次，那他修改完代码大家友谊的小船也就完全地翻了。

你要作的就是，让你的同事依然调用func1，可是能实现调用timer方法的效果。

import time def timer(func): start = time.time() func() print(time.time() - start) def func1(): print('in func1') func1 =timer #要是能这样的就完美了。。。惋惜报错 func1()

很是惋惜，上面这段代码是会报错的，由于timer方法须要传递一个func参数，咱们不能在赋值的时候传参，由于只要执行func1 = timer(func1)，timer方法就直接执行了，下面的那句func1根本就没有意义。到这里，咱们的思路好像陷入了僵局。。。

装饰器的造成过程

装饰器——简单版

import time def func1(): print('in func1') def timer(func): def inner(): start = time.time() func() print(time.time() - start) return inner func1 = timer(func1) func1()

忙活了这么半天，终于初具规模了！如今已经基本上完美了，惟一碍眼的那句话就是还要在作一次赋值调用。。。

你以为碍眼，python的开发者也以为碍眼，因此就为咱们提供了一句语法糖来解决这个问题！

装饰器——语法糖

import time def timer(func): def inner(): start = time.time() func() print(time.time() - start) return inner @timer #==> func1 = timer(func1) def func1(): print('in func1') func1()

到这里，咱们能够简单的总结一下：

　　装饰器的本质：一个闭包函数

　　装饰器的功能：在不修改原函数及其调用方式的状况下对原函数功能进行扩展

还有最后一个问题要解决，刚刚咱们讨论的装饰器都是装饰不带参数的函数，如今要装饰一个带参数的函数怎么办呢？

装饰器——带参数的装饰器

def timer(func): def inner(a): start = time.time() func(a) print(time.time() - start) return inner @timer def func1(a): print(a) func1(1)

其实装饰带参的函数并非什么难事，但假如你有两个函数，须要传递的参数不同呢？

装饰器——万能传参

import time def timer(func): def inner(*args,**kwargs): start = time.time() re = func(*args,**kwargs) print(time.time() - start) return re return inner @timer #==> func1 = timer(func1) def func1(a,b): print('in func1') @timer #==> func2 = timer(func2) def func2(a): print('in func2 and get a:%s'%(a)) return 'fun2 over' func1('aaaaaa','bbbbbb') print(func2('aaaaaa'))

如今参数的问题已经完美的解决了，但是若是你的函数是有返回值的呢？

装饰器——带返回值的装饰器

import time def timer(func): def inner(*args,**kwargs): start = time.time() re = func(*args,**kwargs) print(time.time() - start) return re return inner @timer #==> func2 = timer(func2) def func2(a): print('in func2 and get a:%s'%(a)) return 'fun2 over' func2('aaaaaa') print(func2('aaaaaa'))

刚刚那个装饰器已经很是完美了，可是正常咱们状况下查看函数的一些信息的方法在此处都会失效

查看函数信息的方法

def index(): '''这是一个主页信息''' print('from index') print(index.__doc__) #查看函数注释的方法 print(index.__name__) #查看函数名的方法

为了避免让他们失效，咱们还要在装饰器上加上一点来完善它：

装饰器——warps demo

from functools import wraps def deco(func): @wraps(func) #加在最内层函数正上方 def wrapper(*args,**kwargs): return func(*args,**kwargs) return wrapper @deco def index(): '''哈哈哈哈''' print('from index') print(index.__doc__) print(index.__name__)

开放封闭原则

　　1.对扩展是开放的

　　　　为何要对扩展开放呢？

　　　　咱们说，任何一个程序，不可能在设计之初就已经想好了全部的功能而且将来不作任何更新和修改。因此咱们必须容许代码扩展、添加新功能。

　　2.对修改是封闭的

　　　　为何要对修改封闭呢？

　　　　就像咱们刚刚提到的，由于咱们写的一个函数，颇有可能已经交付给其余人使用了，若是这个时候咱们对其进行了修改，颇有可能影响其余已经在使用该函数的用户。

装饰器完美的遵循了这个开放封闭原则。

装饰器的主要功能和装饰器的固定结构

装饰器的主要功能

　　在不改变函数调用方式的基础上在函数的前、后添加功能。

装饰器的固定格式

def timer(func): def inner(*args,**kwargs): '''执行函数以前要作的''' re = func(*args,**kwargs) '''执行函数以后要作的''' return re return inner

# wraps

from functools import wraps def deco(func): @wraps(func) #加在最内层函数正上方 def wrapper(*args,**kwargs): return func(*args,**kwargs) return wrapper

带参数的装饰器

假如你有成千上万个函数使用了一个装饰器，如今你想把这些装饰器都取消掉，你要怎么作？

一个一个的取消掉？ 没日没夜忙活3天。。。

过两天你领导想通了，再让你加上。。。

def outer(flag): def timer(func): def inner(*args,**kwargs): if flag: print('''执行函数以前要作的''') re = func(*args,**kwargs) if flag: print('''执行函数以后要作的''') return re return inner return timer @outer(False) def func(): print(111) func()

多个装饰器装饰同一个函数

有些时候，咱们也会用到多个装饰器装饰同一个函数的状况。

def wrapper1(func): def inner(): print('wrapper1 ,before func') func() print('wrapper1 ,after func') return inner def wrapper2(func): def inner(): print('wrapper2 ,before func') func() print('wrapper2 ,after func') return inner @wrapper2 @wrapper1 def f(): print('in f') f()