python如何通过inspect获取装饰器传入的参数？

Question

代码如下，想解析装饰器的参数

import inspect
from functools import wraps

def task(_id, params):
    
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)

        return wrapper

    return decorator

@task(_id="aaa", params=(1,2,3))
def foo(q=1):
    ...

if __name__ == '__main__':
    print(inspect.getclosurevars(foo.__wrapped__).nonlocals)  # 不生效，期望获取(_id="aaa", params=(1,2,3))信息

Answer 1

inspect应该做不到了。目前一种方案就是AI给你说的那种，你需要在decorator中去自己存储你的变量。还有一种方案是去针对性的解析你这个代码，但是不是通用性的。

import ast

def get_decorator_args(func):
    source = inspect.getsource(func)
    tree = ast.parse(source)

    for node in ast.walk(tree):
        if isinstance(node, ast.FunctionDef):
            for decorator in node.decorator_list:
                if isinstance(decorator, ast.Call) and decorator.func.id == "task":
                    args = {
                        arg.arg: ast.literal_eval(arg.value)
                        for arg in decorator.keywords
                    }
                    return args
    return {}

只适合你这个问题。

print(get_decorator_args(foo)) 

# {'_id': 'aaa', 'params': (1, 2, 3)}

Answer 2

在Python中，装饰器是通过在函数上应用一个返回另一个函数的函数来工作的。由于装饰器通常不直接在被装饰的函数对象上存储其参数，因此你不能直接通过inspect模块来检索这些参数。但是，你可以通过一些技巧来间接地获取这些信息。

一种方法是使用类来模拟装饰器的行为，并在类的实例中存储这些参数。这样，你可以通过类的实例来访问这些参数。下面是一个使用类来模拟装饰器的例子：

from functools import wraps

class TaskDecorator:
    def __init__(self, _id, params):
        self._id = _id
        self.params = params

    def __call__(self, func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            # 在这里，你可以使用 self._id 和 self.params
            # 如果你想在函数执行时传递这些参数，你可能需要修改 wrapper 的逻辑
            return func(*args, **kwargs)

        # 我们可以将装饰器的参数附加到 wrapper 函数上作为一个属性
        # 注意：这不是标准做法，可能会与未来版本的Python或库冲突
        wrapper.task_info = {'_id': self._id, 'params': self.params}
        return wrapper

def task(_id, params):
    return TaskDecorator(_id, params)

@task(_id="aaa", params=(1,2,3))
def foo(q=1):
    pass

if __name__ == '__main__':
    # 直接从 wrapper 函数上获取我们附加的 task_info 属性
    print(foo.task_info)  # 输出: {'_id': 'aaa', 'params': (1, 2, 3)}

在这个例子中，我们创建了一个TaskDecorator类来模拟装饰器的行为。我们在类的实例中存储了装饰器的参数，并在__call__方法中返回了一个包装函数wrapper。我们还给wrapper函数附加了一个task_info属性，用于存储装饰器的参数。然后，你可以直接从被装饰的函数上访问这个属性来获取装饰器的参数。

请注意，将额外的属性附加到被装饰的函数上可能不是最佳实践，因为这可能会与未来版本的Python或库发生冲突。但是，这种方法在某些情况下可能是有用的，特别是当你需要在运行时访问这些参数时。

另一种方法是使用模块级别的变量或字典来存储这些参数，但这需要更复杂的逻辑来确保正确地关联装饰器的参数和被装饰的函数。