要增加函数的功能,却不希望修改函数的定义,这种在代码运行期间动态增加功能的方式,称之为装饰器。本质上,装饰器就是一个返回函数的高阶函数。
例如我们要定义一个能打印被执行函数名的装饰器,可以定义如下:
def name(func):
def f(*args,**kw):
print('%s():'%func.__name__)
return func(*args,**kw)
return f
上面的装饰器接受一个函数作为参数,并返回其中定义的一个函数。
把装饰器置于函数的定义处:
@name
def hello():
print('Hello World!')
相当于执行了语句hello=name(hello)
执行name()函数,不仅会返回函数本身的结果,还会再函数执行结果的前一行打印该函数的名字。
>>> hello()
hello():
Hello World!
>>>
由于name()是一个装饰器,返回一个函数,所以,原来的hello()函数仍然存在,只是现在同名的hello变量指向了新的函数,于是调用hello()将执行新函数,即在name()函数中返回的f()函数。f()函数的参数定义是(*args, **kw),因此,f()函数可以接受任意参数的调用。在f()函数内,首先打印函数名,再调用原始函数。
如果我们执行如下命令,会发现返回的并不是hello,而是f。返回的并不是被装饰的函数的名字,而是装饰器内部函数的名字。
>>> hello.__name__
'f'
>>>
可以使用functools模块来解决这个问题
import functools
def name(func):
@functools.wraps(func)
def f(*args,**kw):
print('%s():'%func.__name__)
return func(*args,**kw)
return f
@name
def hello():
print('Hello World!')
此时执行name()函数,结果并没有发生变化,但是通过hello.__name__
返回的名字变回了被装饰的函数的名字。
>>> hello()
hello():
Hello World!
>>> hello.__name__
'hello'
如果装饰器本身需要传入参数,那就需要编写一个返回装饰器的高阶函数。
比如,要在打印的被执行函数名的前面添加自己的名字。
def name(text):
def decorator(func):
def f(*args,**kw):
print('%s:%s():'%(text,func.__name__))
return func(*args,**kw)
return f
return decorator
使用该装饰器:
@name('CHD')
def hello():
print('Hello World!')
相当于hello=name(‘CHD’)(hello)
执行结果如下
>>> hello()
CHD:hello():
Hello World!
>>>