检查函数是否使用特定的关键字参数

时间:2015-07-26 16:34:13

标签: python function arguments python-decorators

我有一个像这样的装饰师:

def auth(func):
    def dec(self, *args):
        user = Auth.auth(self.server.parse_params(), self.server.client_address)
        // snip...
        if user is None:
            raise NoSuchUserError
        func(self, *args, user=user)
    return dec

这很好用,现在我可以编写这样的函数:

@auth
def serve_account(self, user=None):
    return json.dumps(user)

但有时候我的函数实际上根本没有读user参数,我只是希望装饰师能够处理未经身份验证的用户。以此为例:

@auth
def serve_status(self, user=None):
    // I get the status here but I don't use the user parameter.
    return json.dumps(status)

现在我的IDE和我的静态代码分析服务一直在唠叨:

  

未使用的参数'user'

它可能会让那些不知道装饰者发生了什么的人感到困惑:

TypeError: serve_status() got an unexpected keyword argument 'user'

我无法删除参数,否则一旦修饰器调用该函数,我就会收到运行时错误。

如果函数在参数列表中没有参数,有没有办法可以省略装饰器中的参数? (除了创建第二个装饰器,如@auth_but_dont_pass_the_user

2 个答案:

答案 0 :(得分:1)

您可以解析被调用函数的源并检查user变量的使用次数,如果它大于1,则可以使用变量user调用该函数:

import ast
import inspect


def is_variable_used(func, variable):
    source = inspect.getsource(func).split('\n', 1)[1]  # Split to drop the decorator part
    return sum(node.id == variable for node in ast.walk(ast.parse(source))
               if isinstance(node, ast.Name)) > 1


def auth(func):
    def dec(self, *args):
        if is_variable_used(func, 'user'):
            print 'Calling {func_name} with user.'.format(func_name=func.__name__)
            return func(self, user=100)
        else:
            print 'Calling {func_name} without user.'.format(func_name=func.__name__)
            return func(self)
    return dec


@auth
def func1_with_user(foo, user=None):
    return 10 + user

@auth
def func2_with_user(foo, user=None):
    a = 10 + foo
    b = a + foo
    c = a + b + user
    return a + b + c

@auth
def func1_without_user(foo, user=None):
    pass

@auth
def func2_without_user(foo, user=None):
    return 10 + foo


print func1_with_user(10)
print func2_with_user(20)
print func1_without_user(100)
print func2_without_user(200)

<强>输出:

>>> !python so.py
Calling func1_with_user with user.
110
Calling func2_with_user with user.
260
Calling func1_without_user without user.
None
Calling func2_without_user without user.
210

答案 1 :(得分:0)

为什么不使用**kwargs?一个例子是:

def f(*args, **kwargs):
    if 'user' in kwargs:
        print 'the given user is:', kwargs['user']
    else:
        # do something else

这样您就不必将参数显式地放在装饰器中,但是如果用户指定它,您就可以检索它。