从装饰函数将参数传递给装饰器

Question

我已经准备了一些函数装饰器，从装饰器的角度传递了默认参数：

def decorator_wraper(max_repeating=20)
    def decorator(function):
        def wrap_function(*args, **kwargs):
            print(f"max_repeating = {max_repeating}")
            repeat = 0
            while repeat < max_repeating:
                try:
                    return function(*args, **kwargs)
                    break
                except Exception:
                    pass
                repeat += 1
        return wrap_function
    return decorator

它工作正常，所以如果某个装饰函数失败 - 装饰器允许重复该函数直到成功或重复 >= max_repeating。

但是如果我需要从修饰函数的角度更改默认的 max_repeating 怎么办？

这里我有两个装饰函数：

@decorator_wraper(5)
def decorate_me_with_argument(max_repeating=10):
    print('decorate_me_with_argument')

@decorator_wraper()
def decorate_me_with_default():
    print('decorate_me_with_default')

calling:
decorate_me_with_argument() # max_repeating should be 5 cause while decorating the function I have passed 5.
decorate_me_with_default() # max repeating should be 20 cause default for the decorator is 20.

以及我想要达到的目标：

decorate_me_with_argument(3) # max_repeating should be 3
decorate_me_with_default(8) # max repeating should be 8

也许有什么简单的方法可以解决这样的问题？

Answer 1

将wrap_function 的第一个参数设为重复次数，并使用装饰器中指定的默认值max_repeats。

def decorator_wraper(max_repeats=20):
    def decorator(function):
        def wrap_function(max_repeating=max_repeats, *args, **kwargs):
            print(f"max_repeating = {max_repeating}")
            repeat = 0
            while repeat < max_repeating:
                try:
                    return function(*args, **kwargs)
                except Exception:
                    pass
        return wrap_function
    return decorator


@decorator_wraper(5)
def decorate_me_with_argument():
    print('decorate_me_with_argument')


@decorator_wraper()
def decorate_me_with_default():
    print('decorate_me_with_default')


decorate_me_with_argument()  # max_repeating = 5
decorate_me_with_default()  # max_repeating = 20
decorate_me_with_argument(3)  # max_repeating = 3
decorate_me_with_default(8)  # max_repeating = 8

Answer 2

另一种方法是在wrap_function 上公开重复次数：

def decorator_wrapper(max_repeating=20):
    def decorator(function):
        def wrap_function(*args, **kwargs):
            print(f"max_repeating = {wrap_function.max_repeating}")
            for _ in range(wrap_function.max_repeating):
                try:
                    return function(*args, **kwargs)
                except Exception:
                    pass
        wrap_function.max_repeating = max_repeating
        return wrap_function
    return decorator

这样你不会改变被包裹的function的界面，但你仍然可以在初始修饰后改变重复限制：

>>> @decorator_wrapper()
... def bad_func():
...     print("in bad func")
...     raise Exception("oh no!")
...
>>> bad_func.max_repeating
20
>>> bad_func.max_repeating = 3
>>> bad_func()
max_repeating = 3
in bad func
in bad func
in bad func

将任意属性添加到wrap_function 还允许您提供内联 API 来调用具有不同重试次数的包装函数，例如类似：

bad_func.retry_times(3)()

同样bad_func.retry_times(3) 是bad_func 的直接替代品，因为它返回一个接受完全相同参数的函数，而不是添加到包装函数的现有参数（并有与之冲突的风险）。

---

请注意，如果最后一次重试失败，您可能应该提出错误，否则它将完全丢失：

def retry(times, func, *args, **kwargs):
    for _ in range(times):
        try:
            return func(*args, **kwargs)
        except Exception as exc:
            exception = exc
    raise exception

需要exception = exc，因为except-clause deletes local variable。

Answer 3

以下与我在项目中的类似，kwargs 参数获取从装饰函数传递的所有内容：

def decorator_wraper(func):
    def wrap_function(max_repeating=20, *args, **kwargs):
        if kwargs.get('max_repeating'):
            max_repeating = kwargs['max_repeating']
        print(max_repeating)
        # TODO
        return func(*args, **kwargs)
    return wrap_function

@decorator_wraper
def decorate_me():
    pass

decorate_me()  # should print 20
decorate_me(max_repeating=10)  # should print 10