Python 定义一个属性可由用户修改的装饰器

需求

我们想编写一个装饰器来包装函数,但是可以让用户调整装饰器的属性,这样在运行时能够控制装饰器的行为

解决方案

下面给出的解决方案对上一节的示例进行了扩展,引入了访问器函数(accessor function),通过使用nonlocal关键字声明变量来修改装饰器内部的属性。之后把访问器函数作为函数属性附加到包装函数上

python 复制代码
import logging
from functools import partial, wraps


# Utility decorator to attach a function as an attribute of obj
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):
    '''
    Add logging to a function. level is the logging
    level, name is the logger name, and message is the
    log message. If name and message aren't specified,
    they default to the function's module and name.
    '''
    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 setter functions
        @attach_wrapper(wrapper)
        def set_level(newlevel):
            nonlocal level
            level = newlevel

        @attach_wrapper(wrapper)
        def set_message(newmsg):
            nonlocal logmsg
            logmsg = newmsg

        return wrapper
    return decorate

# Example use
@logged(logging.DEBUG)
def add(x, y):
    return x + y

@logged(logging.CRITICAL, 'example')
def spam():
    print('Spam!')

logging.basicConfig(level=logging.DEBUG)
add(2, 3) #DEBUG:__main__:add

add.set_level(logging.WARNING)
add(2, 3) #WARNING:__main__:add

关键就在访问器函数(即,set_message()和set_level()),它们以属性的形式附加到了包装函数上。每个访问器函数允许对nonlocal变量赋值来调整内部参数

attach_wrapper 分析如下

def attach_wrapper(obj, func=None):

这是函数的定义部分。它接受两个参数:

obj: 要将函数附加到的对象

func: 要附加的函数,默认为 None

  • if func is None:

    如果 func 参数为 None,说明用户只传递了 obj 参数。

    在这种情况下,attach_wrapper 函数返回一个新的偏函数(partial function),它接受一个 func 参数。这个偏函数会将传递给它的 func 附加到 obj 上。

    setattr(obj, func.name, func)

  • 如果 func 参数不为 None,说明用户同时传递了 obj 和 func 参数。

    这行代码将 func 函数附加到 obj 对象上,函数名称为 func.name

    return func

最后,这个装饰器函数返回传入的 func 函数本身。

相关推荐
Hello eveybody22 分钟前
什么是动态规划(DP)?(Python版)
python·动态规划
南 阳1 小时前
Python从入门到精通day34
开发语言·python
APIshop3 小时前
阿里巴巴中国站按图搜索1688商品(拍立淘)API 返回值说明
java·python·图搜索算法
哈库纳玛塔塔3 小时前
dbVisitor 利用 queryForPairs 让键值查询一步到位
java·数据库·python
sa100273 小时前
京东评论接口调用、签名生成与异常处理
开发语言·数据库·python
赵谨言3 小时前
基于Python实现地理空间数据批处理技术探讨及实现--以“多规合一“总体规划数据空间叠加分析为例
大数据·开发语言·经验分享·python
DN20203 小时前
AI销售:从不迟到早退,永远秒回,您的忠实员工
人工智能·python
编程之升级打怪4 小时前
Python的图形框架tkinter使用案例
python
liu****4 小时前
3.RNN及其变体
人工智能·python·rnn·深度学习
大江东去浪淘尽千古风流人物5 小时前
【Sensor】IMU传感器选型车轨级 VS 消费级
人工智能·python·算法·机器学习·机器人