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 函数本身。

相关推荐
Smoothcloud润云5 小时前
PyTorch大模型权重加载与启动耗时优化实战:定位磁盘、内存与显存瓶颈
人工智能·pytorch·python·深度学习·gpu算力
databook5 小时前
从循环到向量化:NumPy提速的7个关键思维
python·数据分析·numpy
棉猴6 小时前
玩游戏学Python1-Python和pgzero库的安装
python·pygame·玩游戏·pgzero·pgzrun
诺伦6 小时前
GEO优化数据实证:78%引用流向官网的机制拆解与小品牌三步管线实战教程 | RiseClaw玄策
python·seo·geo·内容营销·ai搜索
oooost6 小时前
pytorch学习笔记1
python·学习方法
数字融合7 小时前
透明化视频孪生虚实映射一体化融合技术
人工智能·python·数码相机
jack186897 小时前
Lovable.Dev 全栈应用快速落地实战指南
python
华研前沿标杆游学7 小时前
【标杆研学】走进茅台集团|对标学习长期主义与匠心精神
python
GitFun8 小时前
KDJ vs RSI:11年数据实测,金叉死叉输了48个点
python·股票·量化交易
李可以量化8 小时前
从零读懂配对交易(上):从套利本源到配对交易的核心逻辑
python·区块链·量化交易·通达信·qmt