让python装饰器不再晦涩难懂
在学习修饰器函数之前,考虑如下的两种情形:
a.
有一个函数fn,我们不能修改函数的源代码,但是要扩展函数的功能,怎么实现呢?
我们可以定义一个新的函数 deco, 然后执行fn=deco(fn)这样的赋值操作,那么在原来fn 被调用的时候,其实是执行了 deco(fn)的操作. 如果这个方式可行,我们面临如下的问题:
deco函数必须接受一个函数作为参数,同时deco函数也必须要返回一个函数. 很显然,接受的函数必须是函数fn, 而返回的函数既需要具备fn的功能,还需有扩展的功能。 因此 deco 函数的结构可以如下:
def deco(fn):
def wrapper(*args,**kwargs): #此处的参数目的是传递给 fn 函数.
CODE ... #New function code if any
fn(*args,**kwargs)
CODE ... #New function code if any
return wrapper
#调用方式如下:
fn=deco(fn)
fn(*args,**kwargs) #不改变fn函数的调用方式
b.
有函数wrapper, 我们在不改变该函数调用方式情况下,如何传递额外的参数给函数wrapper ?
我们可以利用赋值的方式改变wrapper,比如 wrapper=func(args), 其中args就是我们要传递的额外的参数,func 是一个新的函数. 该func函数需要:
接受我们要传递的额外的参数args, 同时需要返回一个函数,返回的函数应该就是wrapper 函数. 至于传入的参数args 如何给到wrapper 函数呢 ,需要在wrapper的代码中来接受这个参数,一种可能的结构如下:
def func(args):
CODE.... #Code if any required.
tmp_para=args #使用tmp 来接受额外的参数args
def wrapper():
extra_para=tmp_para # 实现额外参数args传递给wrapper函数.
CODE... # wrapper 函数的code 。
return wrapper
CODE.... #如果存在,这部分code 可以是处理参数s 相关的
#调用方式如下:
wrapper=func(args) #args 就是额外要传递的参数
wrapper(*args,**kwargs) #分别是wrapper自己本身的参数
在上面的两种情形中,我们分别实现了:
A. 通过赋值 fn=deco(fn) , 在不改变函数源代码的情况下,扩展了函数fn的功能.
B. 通过赋值wrapper=func(args),利用新的函数func 来传递额外的参数给wrapper函数,但是wrapper函数的源代码必须要进行修改, 如果wrapper函数的源代码不能修改,那么传递额外参数给wrapper又有何意义呢?
下面看一个例子:
#!/usr/bin/env python
# -*- coding:utf-8 -*-
#Author: PandaEye
def welcome(name): #A very simple function.
print("Welcome to my blog: %s !" % name)
def wrapper(gift):
ext_para=gift #Extra parameter is : gift , pass it to function deco.
def deco(fn): #The deco extend the function and no change the code of fn.
def fun(*args,**kwargs):
print("I am the new function, send you 10 points more for congratulations!")
fn(*args,**kwargs)
print("Congratulations, you got the 1st, send the gift %s to you !" % ext_para)
return fun
return deco
deco=wrapper("BMW")
welcome=deco(welcome)
welcome("XiaoMa")
在上述的例子中,主程序中的函数welcome的调用方式始终没有改变,但是函数功能经过了两次的扩展:
其中第一次使用deco函数进行扩展.
在第一次deco扩展的基础上,我们需要传递额外的参数gift给deco, 很显然无法直接传递给deco,因为deco所接受的参数必须是fn, 所以我们用wrapper函数进行传递. 传递该参数给deco之后,我们修改了deco, 因为deco 要处理这个传入的参数,那么就必须要修改deco 的代码。至此完成了两次扩展.
理解了上述过程,其实就理解了装饰器函数,装饰器函数:
装饰器函数其实就是把上述 两行的赋值代码变成了 @wrapper("BMW"),然后调整位置而已。 对于装饰器函数的编写过程.
个人更乐于: 从deco 函数写起,然后再做二次扩展(也就是为deco函数传递参数),这就是外围的wrapper函数,写完deco和wrapper函数,那么装饰器函数就完成了.
下面是上面例子的装饰器常用写法,两者非常的相似,理解了上述的调用,就理解了这个 装饰器函数了.
#!/usr/bin/env python
# -*- coding:utf-8 -*-
#Author: PandaEye
def wrapper(gift):
ext_para=gift #Extra parameter is : gift , pass it to function deco.
def deco(fn): #The deco extend the function and no change the code of fn.
def fun(*args,**kwargs):
print("I am the new function, send you 10 points more for congratulations!")
fn(*args,**kwargs)
print("Congratulations, you got the 1st, send the gift %s to you !" % ext_para)
return fun
return deco
#deco=wrapper("BMW")
#welcome=deco(welcome)
@wrapper("BMW") #这一条语句和紧邻的上面的两条语句作用相同,这是装饰器函数常用表达方式, 调用装饰器函数之前,必须先定义,所以wrapper 函数定义一定要在这一句之前,否则报错
def welcome(name): #A very simple function.
print("Welcome to my blog: %s !" % name)
welcome("XiaoMa")