Skip to main content
 首页 » 编程设计

python之如何将非硬编码参数传递给 Python 装饰器

2024年10月25日11三少

我的目标是创建一个简单的单元测试装饰器,它执行一个函数,如果成功,则不执行任何操作,如果不成功,则打印“FAILURE”及其所有参数。我确实知道内置的 unittest 包。我这样做是为了学习装饰器。除了“如果实际等于预期,则什么也不做,否则打印参数”,我不会采取任何进一步的措施。

我找到了 this function打印出函数的所有参数:

def dumpArgs(func): 
    '''Decorator to print function call details - parameters names and effective values''' 
    def wrapper(*func_args, **func_kwargs): 
        arg_names = func.__code__.co_varnames[:func.__code__.co_argcount] 
        args = func_args[:len(arg_names)] 
        defaults = func.__defaults__ or () 
        args = args + defaults[len(defaults) - (func.__code__.co_argcount - len(args)):] 
        params = list(zip(arg_names, args)) 
        args = func_args[len(arg_names):] 
        if args: params.append(('args', args)) 
        if func_kwargs: params.append(('kwargs', func_kwargs)) 
        print(func.__name__ + ' (' + ', '.join('%s = %r' % p for p in params) + ' )') 
        return func(*func_args, **func_kwargs) 
    return wrapper 
 
@dumpArgs 
def test(a, b = 4, c = 'blah-blah', *args, **kwargs): 
    pass 
 
test(1) 
test(1, 3) 
test(1, d = 5) 
test(1, 2, 3, 4, 5, d = 6, g = 12.9) 

输出:

test (a = 1, b = 4, c = 'blah-blah' ) 
test (a = 1, b = 3, c = 'blah-blah' ) 
test (a = 1, b = 4, c = 'blah-blah', kwargs = {'d': 5} ) 
test (a = 1, b = 2, c = 3, args = (4, 5), kwargs = {'g': 12.9, 'd': 6} ) 

我把它改成这样,它只在函数不等于 4 时打印出参数(在没有装饰器参数的情况下实现):

def get_all_func_param_name_values(func, *func_args, **func_kwargs): 
    arg_names = func.__code__.co_varnames[:func.__code__.co_argcount] 
    args = func_args[:len(arg_names)] 
    defaults = func.__defaults__ or () 
    args = args + defaults[len(defaults) - (func.__code__.co_argcount - len(args)):] 
    params = list(zip(arg_names, args)) 
    args = func_args[len(arg_names):] 
    if args: params.append(('args', args)) 
    if func_kwargs: params.append(('kwargs', func_kwargs)) 
    return  '(' + ', '.join('%s = %r' % p for p in params) + ')' 
 
def dumpArgs(func): 
    '''Decorator to print function call details - parameters names and effective values''' 
    def wrapper(*func_args, **func_kwargs): 
        a = func(*func_args, **func_kwargs) 
        if(a != 4): 
            return  a 
        print("FAILURE: " + func.__name__ + get_all_func_param_name_values(func, *func_args, **func_kwargs)) 
        return a 
    return wrapper 
 
@dumpArgs 
def getA(a, b = 4, c = 'blah-blah', *args, **kwargs): 
    return  a 
 
getA(1) 
getA(1, 3) 
getA(4, d = 5) 
getA(1, 2, 3, 4, 5, d = 6, g = 12.9) 

输出:

FAILURE: getA(a = 4, b = 4, c = 'blah-blah', kwargs = {'d': 5}) 
Out[21]: 1 

(我不明白为什么第二行打印1。)

然后我将其更改为传入预期值 4 作为装饰器参数。如 this answer 中所述,它要求原始装饰器是一个嵌套函数:

def get_all_func_param_name_values(func, *func_args, **func_kwargs): 
    arg_names = func.__code__.co_varnames[:func.__code__.co_argcount] 
    args = func_args[:len(arg_names)] 
    defaults = func.__defaults__ or () 
    args = args + defaults[len(defaults) - (func.__code__.co_argcount - len(args)):] 
    params = list(zip(arg_names, args)) 
    args = func_args[len(arg_names):] 
    if args: params.append(('args', args)) 
    if func_kwargs: params.append(('kwargs', func_kwargs)) 
    return  '(' + ', '.join('%s = %r' % p for p in params) + ')' 
 
def dumpArgs(expected_value): 
    def dumpArgs2(func): 
        '''Decorator to print function call details - parameters names and effective values''' 
        def wrapper(*func_args, **func_kwargs): 
            a = func(*func_args, **func_kwargs) 
            if(a == expected_value): 
                return  a 
            print("FAILURE: " + func.__name__ + get_all_func_param_name_values(func, *func_args, **func_kwargs)) 
            return a 
        return wrapper 
    return  dumpArgs2 
 
@dumpArgs(4) 
def getA(a, b = 4, c = 'blah-blah', *args, **kwargs): 
    return  a 
 
getA(1) 
getA(1, 3) 
getA(4, d = 5) 
getA(1, 2, 3, 4, 5, d = 6, g = 12.9) 

输出:

FAILURE: getA(a = 1, b = 4, c = 'blah-blah') 
FAILURE: getA(a = 1, b = 3, c = 'blah-blah') 
FAILURE: getA(a = 1, b = 2, c = 3, args = (4, 5), kwargs = {'g': 12.9, 'd': 6}) 
Out[31]: 1 

(同样,1...)

我不清楚如何将这个硬编码的 4 更改为 expected_value 参数,该参数在每次函数调用时都会传递。我见过的所有示例(如 this one)都有硬编码参数。

我正在尝试

assert_expected_func_params(4, getA, 1) 
assert_expected_func_params(4, getA, 1, 3) 
assert_expected_func_params(4, getA, 4, d = 5) 
assert_expected_func_params(4, getA, 1, 2, 3, 4, 5, d = 6, g = 12.9) 

但这还远没有奏效。

如何实现可以传递给每个函数调用的装饰器参数?

请您参考如下方法:

由于装饰器包装了函数,您可以在调用函数时拦截函数的输入和输出。通过这种方式,您可以查找 _expected 关键字,将其剥离,调用函数,然后根据传入的预期值测试函数的返回值。

from functools import wraps 
 
_empty = object()  # sentinel value used to control testing 
 
def dump_ne(func): 
    @wraps(func) 
    def decorated(*args, **kwargs): 
        # remove the expected value from the actual call kwargs 
        expected = kwargs.pop('_expected', _empty) 
 
        # call the function with rest of args and kwargs 
        result = func(*args, **kwargs) 
 
        # only test when _expected was passed in the kwargs 
        # only print when the result didn't equal expected 
        if expected is not _empty and expected != result: 
            print('FAIL: func={}, args={}, kwargs={}'.format(func.__name__, args, kwargs)) 
 
        return result 
 
    return decorated 
 
@dump_ne 
def cool(thing): 
    return thing.upper() 
 
print(cool('cat'))  # prints 'CAT', test isn't run 
 
for thing in ('cat', 'ice', 'cucumber'): 
    print(cool(thing, _expected='CUCUMBER')) 
    # dumps info for first 2 calls (cat, ice)