版权声明:首发于 www.amoshuang.com https://blog.csdn.net/qq_35499060/article/details/82765466
为了让装饰器更加灵活,我们希望编写一个能够接受参数的装饰器,以满足各种需求。
下面以编写一个为函数添加日志功能的装饰器为例,它允许用户修改日志的等级和打印信息:
from functools import wraps
import logging
def logged(level,name=None, message=None):
def decorate(func):
logname = name if name else func.__module__
log = logging.getLogger(logname)
logmsg = message if message else func.__name__
@wraps(func)
def wrapper(*args, **kwargs):
log.log(level, logmsg)
return func(*args, **kwargs)
return wrapper
return decorate
下面进行使用演示:
>>> logging.basicConfig(level=logging.DEBUG)#设置控制台的日志输出
>>> @logged(logging.DEBUG) #指定装饰器的第一个参数
def add(a,b):
print(a+b)
>>> add(1,2)
DEBUG:__main__:add
3
>>> @logged(logging.WARNING,"add", "AmosH's blog")#指定装饰器的全部参数
def add(a,b):
print(a+b)
>>> add(2,3)
WARNING:add:AmosH's blog
5
最外层的logged()函数接受所需要的参数,保存参数并让它们对装饰器的内层函数可见。内层的decorate()函数接受一个函数并给它加上一个包装层。这个装饰器的关键部分就在于这个包装层可以使用传递给logged()的参数。
但是这样的装饰器似乎还是不够灵活。我只想定义一次add函数,并希望能够像修改类的属性那样,修改装饰器的参数,这样用起来才够爽。
那么我们该如何修改代码让用户可以修改装饰器属性呢?
为了实现这个目标,我们需要引入访问器函数,通过使用nonlocal关键字声明变量来修改装饰器内部的属性,最后把访问器函数作为属性附加在包装函数上。
示例代码如下:
from functools import wraps, partial
import logging
def attach_wrapper(obj, func=None):
if func is None:
return partial(attach_wrapper, obj)
setattr(obj, func.__name__, func)
return func
def logged(level,name=None, message=None):
def decorate(func):
logname = name if name else func.__module__
log = logging.getLogger(logname)
logmsg = message if message else func.__name__
@wraps(func)
def wrapper(*args, **kwargs):
log.log(level, logmsg)
return func(*args, **kwargs)
@attach_wrapper(wrapper)
def set_level(newlevel):
nonlocal level
level = newlevel
@attach_wrapper(wrapper)
def set_message(newmessage):
nonlocal logmsg
logmsg = newmessage
return wrapper
return decorate
下面进行使用演示:
>>> logging.basicConfig(level=logging.DEBUG)
>>> @logged(logging.DEBUG)
def add(a, b):
print(a + b)
>>> add(1,2)
DEBUG:__main__:add
3
>>> add.set_message('123')
>>> add(1, 2)
DEBUG:__main__:123
在这个演示中,像修改类实例的属性一样,我们通过调用set_message()方法修改了日志输出的信息,很方便地修改了装饰器的属性。
但是很难懂啊!有没有!
下面进行逐步解析,港真,装饰器是很方便,很强大,但是有些复杂。
- 程序执行到@logged(logging.DEBUG)时,首先执行被装饰函数的装饰代码,进行初始化。
- 程序跳转到logged()函数,指定level为logging.DEBUG。函数返回内层函数decorate()。
- @操作符运行decorate()函数进行装饰,参数func为被装饰函数add()函数。
- 首先初始化变量logname、log和logmsg。然后执行内层各个函数的装饰。
- wrapper()函数对add()函数进行包装。然后再看下面的set_level()以及set_message()函数。先执行它们的装饰@attach_wrapper(wrapper)
- 这里是整个装饰器的重中之重,难中之难。首先参数传进来,obj为wrapper()函数,因为wrapper()函数包装了add()函数,所以这个obj其实就是add()函数。但是你不能直接传参func代替wrapper,因为后面调用add()函数时,要走装饰器的wrapper()函数,所以必须传入的是wrapper()函数作为参数。
- 这时候attach_wrapper()函数的另一个参数func为None,这是为了方便适应不同的被装饰方法做的改变。所以返回partial(attach_wrapper, obj)。
- 这个partial()函数的功能蛮有意思,参考官方文档,它会生成一个新的函数,这个函数已经保存了原函数的部分参数,可以像使用正常函数那样,传入剩下的参数以执行原函数正常的功能。
- 所以此时这个返回其实相当于返回等待func参数的attach_wrapper()函数。
- 回到被装饰函数set_level(),这时@操作符会进行装饰,这个时候,被装饰函数set_level()就作为func参数传入attach_wrapper()函数了!
- 执行setattr(obj, func.__name__, func)语句!为obj设置一个属性func.__name__,其值为func 。也就是说,为add函数增加了一个叫做set_level的属性,它的值是方法set_level。
- 依照上述进行set_message()函数的装饰。剩下的就比较简单了。
最后说一下nonlocal关键字的作用。它用来指示作用域,告诉程序使用外层变量。