(点击上方公众号,可快速关注)
来源:geekvi
来源:segmentfault.com/a/1190000007558691
我们知道,在 Python 中,我们可以像使用变量一样使用函数:
函数可以被赋值给其他变量
函数可以被删除
可以在函数里面再定义函数
函数可以作为参数传递给另外一个函数
函数可以作为另一个函数的返回
简而言之,函数就是一个对象。
对一个简单的函数进行装饰
为了更好地理解装饰器,我们先从一个简单的例子开始,假设有下面的函数:
def hello():
return 'hello world'
在上面,我们将 hello 函数传给 makeitalic,再将返回赋给 hello,此时调用 hello() 就得到了我们想要的结果。
不过要注意的是,由于我们将 makeitalic 的返回赋给了 hello,此时 hello() 函数仍然存在,但是它的函数名不再是 hello 了,而是 wrapped,正是 makeitalic 返回函数的名称,可以验证一下:
>>> hello.__name__
'wrapped'
对于这个小瑕疵,后文将会给出解决方法。
现在,我们梳理一下上面的例子,为了增强原函数 hello 的功能,我们定义了一个函数,它接收原函数作为参数,并返回一个新的函数,完整的代码如下:
def makeitalic(func):
def wrapped():
return "" + func() + ""
return wrapped
def hello():
return 'hello world'
hello = makeitalic(hello)
事实上,makeitalic 就是一个装饰器(decorator),它『装饰』了函数 hello,并返回一个函数,将其赋给 hello。
一般情况下,我们使用装饰器提供的 @ 语法糖(Syntactic Sugar),来简化上面的写法:
def makeitalic(func):
def wrapped():
return "" + func() + ""
return wrapped
@makeitalic
def hello():
return 'hello world'
像上面的情况,可以动态修改函数(或类)功能的函数就是装饰器。本质上,它是一个高阶函数,以被装饰的函数(比如上面的 hello)为参数,并返回一个包装后的函数(比如上面的 wrapped)给被装饰函数(hello)。
装饰器的使用形式
@decorator
def func():
pass
等价于下面的形式:
def func():
pass
func = decorator(func)
@decorator_one
@decorator_two
def func():
pass
等价于:
def func():
pass
func = decorator_one(decorator_two(func))
@decorator(arg1, arg2)
def func():
pass
等价于:
def func():
pass
func = decorator(arg1, arg2)(func)
下面我们再看一些具体的例子,以加深对它的理解。
对带参数的函数进行装饰
前面的例子中,被装饰的函数 hello() 是没有带参数的,我们看看被装饰函数带参数的情况。对前面例子中的 hello() 函数进行改写,使其带参数,如下:
def makeitalic(func):
def wrapped(*args, **kwargs):
ret = func(*args, **kwargs)
return '' + ret + ''
return wrapped
@makeitalic
def hello(name):
return 'hello %s' % name
@makeitalic
def hello2(name1, name2):
return 'hello %s, %s' % (name1, name2)
由于函数 hello 带参数,因此内嵌包装函数 wrapped 也做了一点改变:
看看使用:
>>> hello('python')
'hello python'
>>> hello2('python', 'java')
'hello python, java'
带参数的装饰器
上面的例子,我们增强了函数 hello 的功能,给它的返回加上了标签 …,现在,我们想改用标签 … 或
…
。是不是要像前面一样,再定义一个类似 makeitalic 的装饰器呢?其实,我们可以定义一个函数,将标签作为参数,返回一个装饰器,比如:
def wrap_in_tag(tag):
def decorator(func):
def wrapped(*args, **kwargs):
ret = func(*args, **kwargs)
return ' + tag + '>' + ret + '' + tag + '>'
return wrapped
return decorator
现在,我们可以根据需要生成想要的装饰器了:
makebold = wrap_in_tag('b') # 根据 'b' 返回 makebold 生成器
@makebold
def hello(name):
return 'hello %s' % name
>>> hello('world')
'hello world'
上面的形式也可以写得更加简洁:
@wrap_in_tag('b')
def hello(name):
return 'hello %s' % name
这就是带参数的装饰器,其实就是在装饰器外面多了一层包装,根据不同的参数返回不同的装饰器。
多个装饰器
现在,让我们来看看多个装饰器的例子,为了简单起见,下面的例子就不使用带参数的装饰器。
def makebold(func):
def wrapped():
return '' + func() + ''
return wrapped
def makeitalic(func):
def wrapped():
return '' + func() + ''
return wrapped
@makebold
@makeitalic
def hello():
return 'hello world'
上面定义了两个装饰器,对 hello 进行装饰,上面的最后几行代码相当于:
def hello():
return 'hello world'
hello = makebold(makeitalic(hello))
调用函数 hello:
>>> hello()
'hello world'
基于类的装饰器
前面的装饰器都是一个函数,其实也可以基于类定义装饰器,看下面的例子:
class Bold(object):
def __init__(self, func):
self.func = func
def __call__(self, *args, **kwargs):
return '' + self.func(*args, **kwargs) + ''
@Bold
def hello(name):
return 'hello %s' % name
>>> hello('world')
'hello world'
可以看到,类 Bold 有两个方法:
还可以让类装饰器带参数:
class Tag(object):
def __init__(self, tag):
self.tag = tag
def __call__(self, func):
def wrapped(*args, **kwargs):
return "{res}{tag}>".format(
res=func(*args, **kwargs), tag=self.tag
)
return wrapped
@Tag('b')
def hello(name):
return 'hello %s' % name
需要注意的是,如果类装饰器有参数,则 __init__ 接收参数,而 __call__ 接收 func。
装饰器的副作用
前面提到,使用装饰器有一个瑕疵,就是被装饰的函数,它的函数名称已经不是原来的名称了,回到最开始的例子:
def makeitalic(func):
def wrapped():
return "" + func() + ""
return wrapped
@makeitalic
def hello():
return 'hello world'
函数 hello 被 makeitalic 装饰后,它的函数名称已经改变了:
>>> hello.__name__
'wrapped'
为了消除这样的副作用,Python 中的 functool 包提供了一个 wraps 的装饰器:
from functools import wraps
def makeitalic(func):
@wraps(func) # 加上 wraps 装饰器
def wrapped():
return "" + func() + ""
return wrapped
@makeitalic
def hello():
return 'hello world'
>>> hello.__name__
'hello'
小结
参考资料
关注「Python开发者」
看更多精选Python技术文章
↓↓↓