Como posso usar argumentos nomeados em um decorador?

Question

Se eu tenho a seguinte função:

def intercept(func):
  # do something here

@intercept(arg1=20)
def whatever(arg1,arg2):
  # do something here

Gostaria de interceptação para disparar apenas quando arg1 é 20. Eu gostaria de ser capaz de passar parâmetros nomeados para a função. Como eu poderia fazer isso?

Aqui está um exemplo de código pouco:

def intercept(func):
    def intercepting_func(*args,**kargs):
        print "whatever"
        return func(*args,**kargs)
    return intercepting_func

@intercept(a="g")
def test(a,b):
    print "test with %s %s" %(a,b)

test("g","d")

Isto lança a seguinte TypeError exceção: intercept () tem um argumento chave inesperado 'a'

Answer 1

from functools import wraps

def intercept(target,**trigger):
    def decorator(func):
        names = getattr(func,'_names',None)
        if names is None:
            code = func.func_code
            names = code.co_varnames[:code.co_argcount]
        @wraps(func)
        def decorated(*args,**kwargs):
            all_args = kwargs.copy()
            for n,v in zip(names,args):
                all_args[n] = v
            for k,v in trigger.iteritems():
                if k in all_args and all_args[k] != v:
                    break
            else:
                return target(all_args)
            return func(*args,**kwargs)
        decorated._names = names
        return decorated
    return decorator

Exemplo:

def interceptor1(kwargs):
    print 'Intercepted by #1!'

def interceptor2(kwargs):
    print 'Intercepted by #2!'

def interceptor3(kwargs):
    print 'Intercepted by #3!'

@intercept(interceptor1,arg1=20,arg2=5) # if arg1 == 20 and arg2 == 5
@intercept(interceptor2,arg1=20)        # elif arg1 == 20
@intercept(interceptor3,arg2=5)         # elif arg2 == 5
def foo(arg1,arg2):
    return arg1+arg2

>>> foo(3,4)
7
>>> foo(20,4)
Intercepted by #2!
>>> foo(3,5)
Intercepted by #3!
>>> foo(20,5)
Intercepted by #1!
>>>

functools.wraps faz o que o "decorador simples" no wiki faz; Atualizações __doc__, __name__ e outro atributo do decorador.

Answer 2

Lembre-se que

@foo
def bar():
    pass

é equivalente a:

def bar():
    pass
bar = foo(bar)

então se você:

@foo(x=3)
def bar():
    pass

que é equivalente a:

def bar():
    pass
bar = foo(x=3)(bar)

para suas necessidades decorador para algo parecido com isto:

def foo(x=1):
    def wrap(f):
        def f_foo(*args, **kw):
            # do something to f
            return f(*args, **kw)
        return f_foo
    return wrap

Em outras palavras, def wrap(f) é realmente o decorador e foo(x=3) é uma chamada de função que retorna um decorador.

Answer 3

Você pode fazer isso usando * args e kwargs ** no decorador:

def intercept(func, *dargs, **dkwargs):
    def intercepting_func(*args, **kwargs):
        if (<some condition on dargs, dkwargs, args and kwargs>):
            print 'I intercepted you.'
        return func(*args, **kwargs)
    return intercepting_func

É até você como você deseja passar argumentos para controlar o comportamento do decorador.

Para fazer isso o mais transparente possível para o usuário final, você pode usar o "decorador simples" no Python wiki ou "decorador decorador" de Michele Simionato