Conservación de firmas de funciones decoradas

Supongamos que he escrito un decorador que hace algo muy genérico. Por ejemplo, podría convertir todos los argumentos a un tipo específico, realizar el registro, implementar la memorización, etc.

Aquí hay un ejemplo:

def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    return g

@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

>>> funny_function("3", 4.0, z="5")
22

Todo bien hasta ahora. Hay un problema, sin embargo. La función decorada no conserva la documentación de la función original:

>>> help(funny_function)
Help on function g in module __main__:

g(*args, **kwargs)

Afortunadamente, existe una solución alternativa:

def args_as_ints(f):
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    g.__name__ = f.__name__
    g.__doc__ = f.__doc__
    return g

@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

Esta vez, el nombre de la función y la documentación son correctos:

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(*args, **kwargs)
    Computes x*y + 2*z

Pero todavía hay un problema: la firma de la función es incorrecta. La información "* args, ** kwargs" es casi inútil.

¿Qué hacer? Puedo pensar en dos soluciones simples pero defectuosas:

1 - Incluya la firma correcta en la cadena de documentos:

def funny_function(x, y, z=3):
    """funny_function(x, y, z=3) -- computes x*y + 2*z"""
    return x*y + 2*z

Esto es malo debido a la duplicación. La firma aún no se mostrará correctamente en la documentación generada automáticamente. Es fácil actualizar la función y olvidarse de cambiar la cadena de documentos o de cometer un error tipográfico. [ Y sí, soy consciente del hecho de que la cadena de documentos ya duplica el cuerpo de la función. Por favor ignore esto; funny_function es solo un ejemplo aleatorio. ]

2 - No use un decorador, o use un decorador de propósito especial para cada firma específica:

def funny_functions_decorator(f):
    def g(x, y, z=3):
        return f(int(x), int(y), z=int(z))
    g.__name__ = f.__name__
    g.__doc__ = f.__doc__
    return g

Esto funciona bien para un conjunto de funciones que tienen una firma idéntica, pero es inútil en general. Como decía al principio, quiero poder utilizar decoradores de forma totalmente genérica.

Estoy buscando una solución que sea completamente general y automática.

Entonces, la pregunta es: ¿hay alguna manera de editar la firma de la función decorada después de que se haya creado?

De lo contrario, ¿puedo escribir un decorador que extraiga la firma de la función y use esa información en lugar de "* kwargs, ** kwargs" al construir la función decorada? ¿Cómo extraigo esa información? ¿Cómo debo construir la función decorada - con ejecutivo?

¿Algún otro enfoque?

1. Instale el módulo decorador :

   $ pip install decorator

2. Adaptar la definición de args_as_ints():

   import decorator
   
   @decorator.decorator
   def args_as_ints(f, *args, **kwargs):
       args = [int(x) for x in args]
       kwargs = dict((k, int(v)) for k, v in kwargs.items())
       return f(*args, **kwargs)
   
   @args_as_ints
   def funny_function(x, y, z=3):
       """Computes x*y + 2*z"""
       return x*y + 2*z
   
   print funny_function("3", 4.0, z="5")
   # 22
   help(funny_function)
   # Help on function funny_function in module __main__:
   # 
   # funny_function(x, y, z=3)
   #     Computes x*y + 2*z
   

Python 3.4+

functools.wraps()de stdlib conserva las firmas desde Python 3.4:

import functools


def args_as_ints(func):
    @functools.wraps(func)
    def wrapper(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return func(*args, **kwargs)
    return wrapper


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z


print(funny_function("3", 4.0, z="5"))
# 22
help(funny_function)
# Help on function funny_function in module __main__:
#
# funny_function(x, y, z=3)
#     Computes x*y + 2*z

functools.wraps()está disponible al menos desde Python 2.5 pero no conserva la firma allí:

help(funny_function)
# Help on function funny_function in module __main__:
#
# funny_function(*args, **kwargs)
#    Computes x*y + 2*z

Aviso: en *args, **kwargslugar de x, y, z=3.

Esto se resuelve con la biblioteca estándar de Python functoolsy la functools.wrapsfunción específica , que está diseñada para " actualizar una función contenedora para que se parezca a la función empaquetada ". Sin embargo, su comportamiento depende de la versión de Python, como se muestra a continuación. Aplicado al ejemplo de la pregunta, el código se vería así:

from functools import wraps

def args_as_ints(f):
    @wraps(f) 
    def g(*args, **kwargs):
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return f(*args, **kwargs)
    return g


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z

Cuando se ejecuta en Python 3, esto produciría lo siguiente:

>>> funny_function("3", 4.0, z="5")
22
>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(x, y, z=3)
    Computes x*y + 2*z

Su único inconveniente es que en Python 2, sin embargo, no actualiza la lista de argumentos de la función. Cuando se ejecuta en Python 2, producirá:

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(*args, **kwargs)
    Computes x*y + 2*z

Hay un módulodecorator decorador con decorador que puede utilizar:

@decorator
def args_as_ints(f, *args, **kwargs):
    args = [int(x) for x in args]
    kwargs = dict((k, int(v)) for k, v in kwargs.items())
    return f(*args, **kwargs)

Luego se conserva la firma y la ayuda del método:

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(x, y, z=3)
    Computes x*y + 2*z

EDITAR: JF Sebastian señaló que no modifiqué la args_as_intsfunción, ahora está arreglada.

Eche un vistazo al módulo decorador , específicamente el decorador decorador, que resuelve este problema.

Segunda opción:

1. Instale el módulo envuelto:

$ easy_install envuelto

Wrap tiene una bonificación, conserva la firma de la clase.

import wrapt
import inspect


@wrapt.decorator
def args_as_ints(wrapped, instance, args, kwargs):
    if instance is None:
        if inspect.isclass(wrapped):
            # Decorator was applied to a class.
            return wrapped(*args, **kwargs)
        else:
            # Decorator was applied to a function or staticmethod.
            return wrapped(*args, **kwargs)
    else:
        if inspect.isclass(instance):
            # Decorator was applied to a classmethod.
            return wrapped(*args, **kwargs)
        else:
            # Decorator was applied to an instancemethod.
            return wrapped(*args, **kwargs)


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x * y + 2 * z


>>> funny_function(3, 4, z=5))
# 22

>>> help(funny_function)
Help on function funny_function in module __main__:

funny_function(x, y, z=3)
    Computes x*y + 2*z

Como se comentó anteriormente en la respuesta de jfs ; si le preocupa la firma en términos de apariencia ( help, y inspect.signature), entonces usar functools.wrapsestá perfectamente bien.

Si le preocupa la firma en términos de comportamiento (en particular TypeErroren caso de que los argumentos no coincidan), functools.wrapsno la conserve. Debería usar decoratorpara eso, o mi generalización de su motor central, llamado makefun.

from makefun import wraps

def args_as_ints(func):
    @wraps(func)
    def wrapper(*args, **kwargs):
        print("wrapper executes")
        args = [int(x) for x in args]
        kwargs = dict((k, int(v)) for k, v in kwargs.items())
        return func(*args, **kwargs)
    return wrapper


@args_as_ints
def funny_function(x, y, z=3):
    """Computes x*y + 2*z"""
    return x*y + 2*z


print(funny_function("3", 4.0, z="5"))
# wrapper executes
# 22

help(funny_function)
# Help on function funny_function in module __main__:
#
# funny_function(x, y, z=3)
#     Computes x*y + 2*z

funny_function(0)  
# observe: no "wrapper executes" is printed! (with functools it would)
# TypeError: funny_function() takes at least 2 arguments (1 given)

Vea también esta publicación sobrefunctools.wraps .