Como obter os nomes dos parâmetros dos métodos?

Dada a função Python:

def a_method(arg1, arg2):
    pass

Como posso extrair o número e os nomes dos argumentos. Ou seja, dado que tenho uma referência func, quero func.[something]que retorne("arg1", "arg2") .

O cenário de uso para isso é que eu tenho um decorador e desejo usar os argumentos do método na mesma ordem em que aparecem para a função real como uma chave. Ou seja, como ficaria o decorador impresso "a,b"quando eu ligo a_method("a", "b")?

Dê uma olhada no inspectmódulo - isso fará a inspeção das várias propriedades do objeto de código para você.

>>> inspect.getfullargspec(a_method)
(['arg1', 'arg2'], None, None, None)

Os outros resultados são o nome das variáveis ​​* args e ** kwargs e os padrões fornecidos. ie

>>> def foo(a, b, c=4, *arglist, **keywords): pass
>>> inspect.getfullargspec(foo)
(['a', 'b', 'c'], 'arglist', 'keywords', (4,))

Observe que alguns callables podem não ser introspectáveis ​​em certas implementações do Python. Por exemplo, no CPython, algumas funções internas definidas em C não fornecem metadados sobre seus argumentos. Como resultado, você receberá um ValueErrorse usar inspect.getfullargspec()em uma função interna.

Desde o Python 3.3, você pode usar inspect.signature()para ver a assinatura de chamada de um objeto que pode ser chamado:

>>> inspect.signature(foo)
<Signature (a, b, c=4, *arglist, **keywords)>

No CPython, o número de argumentos é

a_method.func_code.co_argcount

e seus nomes estão no início de

a_method.func_code.co_varnames

Esses são os detalhes da implementação do CPython, portanto, isso provavelmente não funciona em outras implementações do Python, como IronPython e Jython.

Uma maneira portátil de admitir argumentos de "passagem" é definir sua função com a assinatura func(*args, **kwargs). Isso é muito usado, por exemplo , no matplotlib , onde a camada externa da API passa muitos argumentos de palavras-chave para a API de nível inferior.

Em um método decorador, você pode listar argumentos do método original desta maneira:

import inspect, itertools 

def my_decorator():

        def decorator(f):

            def wrapper(*args, **kwargs):

                # if you want arguments names as a list:
                args_name = inspect.getargspec(f)[0]
                print(args_name)

                # if you want names and values as a dictionary:
                args_dict = dict(itertools.izip(args_name, args))
                print(args_dict)

                # if you want values as a list:
                args_values = args_dict.values()
                print(args_values)

Se **kwargssão importantes para você, será um pouco complicado:

        def wrapper(*args, **kwargs):

            args_name = list(OrderedDict.fromkeys(inspect.getargspec(f)[0] + kwargs.keys()))
            args_dict = OrderedDict(list(itertools.izip(args_name, args)) + list(kwargs.iteritems()))
            args_values = args_dict.values()

Exemplo:

@my_decorator()
def my_function(x, y, z=3):
    pass


my_function(1, y=2, z=3, w=0)
# prints:
# ['x', 'y', 'z', 'w']
# {'y': 2, 'x': 1, 'z': 3, 'w': 0}
# [1, 2, 3, 0]

Acho que o que você está procurando é o método locals -

In [6]: def test(a, b):print locals()
   ...: 

In [7]: test(1,2)              
{'a': 1, 'b': 2}

A versão do Python 3 é:

def _get_args_dict(fn, args, kwargs):
    args_names = fn.__code__.co_varnames[:fn.__code__.co_argcount]
    return {**dict(zip(args_names, args)), **kwargs}

O método retorna um dicionário contendo args e kwargs.

Aqui está algo que acho que funcionará para o que você deseja, usando um decorador.

class LogWrappedFunction(object):
    def __init__(self, function):
        self.function = function

    def logAndCall(self, *arguments, **namedArguments):
        print "Calling %s with arguments %s and named arguments %s" %\
                      (self.function.func_name, arguments, namedArguments)
        self.function.__call__(*arguments, **namedArguments)

def logwrap(function):
    return LogWrappedFunction(function).logAndCall

@logwrap
def doSomething(spam, eggs, foo, bar):
    print "Doing something totally awesome with %s and %s." % (spam, eggs)


doSomething("beans","rice", foo="wiggity", bar="wack")

Execute-o, ele produzirá a seguinte saída:

C:\scripts>python decoratorExample.py
Calling doSomething with arguments ('beans', 'rice') and named arguments {'foo':
 'wiggity', 'bar': 'wack'}
Doing something totally awesome with beans and rice.

Python 3.5 ou superior:

DeprecationWarning: inspect.getargspec () está obsoleto, use inspect.signature ()

Então anteriormente:

func_args = inspect.getargspec(function).args

Agora:

func_args = list(inspect.signature(function).parameters.keys())

Testar:

'arg' in list(inspect.signature(function).parameters.keys())

Dado que temos a função 'function' que recebe o argumento 'arg', isso será avaliado como True, caso contrário, como False.

Exemplo do console do Python:

Python 3.6.0 (v3.6.0:41df79263a11, Dec 23 2016, 07:18:10) [MSC v.1900 32 bit (Intel)] on win32
>>> import inspect
>>> 'iterable' in list(inspect.signature(sum).parameters.keys())
True

No Python 3. + com o Signatureobjeto em mãos, uma maneira fácil de obter um mapeamento entre nomes de argumentos e valores, é usando o bind()método Signature !

Por exemplo, aqui está um decorador para imprimir um mapa como esse:

import inspect

def decorator(f):
    def wrapper(*args, **kwargs):
        bound_args = inspect.signature(f).bind(*args, **kwargs)
        bound_args.apply_defaults()
        print(dict(bound_args.arguments))

        return f(*args, **kwargs)

    return wrapper

@decorator
def foo(x, y, param_with_default="bars", **kwargs):
    pass

foo(1, 2, extra="baz")
# This will print: {'kwargs': {'extra': 'baz'}, 'param_with_default': 'bars', 'y': 2, 'x': 1}

Aqui está outra maneira de obter os parâmetros de função sem usar nenhum módulo.

def get_parameters(func):
    keys = func.__code__.co_varnames[:func.__code__.co_argcount][::-1]
    sorter = {j: i for i, j in enumerate(keys[::-1])} 
    values = func.__defaults__[::-1]
    kwargs = {i: j for i, j in zip(keys, values)}
    sorted_args = tuple(
        sorted([i for i in keys if i not in kwargs], key=sorter.get)
    )
    sorted_kwargs = {}
    for i in sorted(kwargs.keys(), key=sorter.get):
        sorted_kwargs[i] = kwargs[i]      
    return sorted_args, sorted_kwargs


def f(a, b, c="hello", d="world"): var = a


print(get_parameters(f))

Resultado:

(('a', 'b'), {'c': 'hello', 'd': 'world'})

Retorna uma lista de nomes de argumentos, cuida de parciais e funções regulares:

def get_func_args(f):
    if hasattr(f, 'args'):
        return f.args
    else:
        return list(inspect.signature(f).parameters)

Atualização para a resposta de Brian :

Se uma função no Python 3 tiver argumentos apenas de palavras-chave, será necessário usar inspect.getfullargspec:

def yay(a, b=10, *, c=20, d=30):
    pass
inspect.getfullargspec(yay)

gera isso:

FullArgSpec(args=['a', 'b'], varargs=None, varkw=None, defaults=(10,), kwonlyargs=['c', 'd'], kwonlydefaults={'c': 20, 'd': 30}, annotations={})

No python 3, abaixo, é para fazer *argse **kwargsentrar em um dict(use OrderedDictpara python <3.6 para manter dictordens):

from functools import wraps

def display_param(func):
    @wraps(func)
    def wrapper(*args, **kwargs):

        param = inspect.signature(func).parameters
        all_param = {
            k: args[n] if n < len(args) else v.default
            for n, (k, v) in enumerate(param.items()) if k != 'kwargs'
        }
        all_param .update(kwargs)
        print(all_param)

        return func(**all_param)
    return wrapper

inspect.signatureé muito lento. A maneira mais rápida é

def f(a, b=1, *args, c, d=1, **kwargs):
   pass

f_code = f.__code__
f_code.co_varnames[:f_code.co_argcount + f_code.co_kwonlyargcount]  # ('a', 'b', 'c', 'd')

Para atualizar um pouco a resposta de Brian , há agora uma boa backport de inspect.signatureque você pode usar em versões mais antigas do Python: funcsigs. Então, minha preferência pessoal iria para

try:  # python 3.3+
    from inspect import signature
except ImportError:
    from funcsigs import signature

def aMethod(arg1, arg2):
    pass

sig = signature(aMethod)
print(sig)

Por diversão, se você estiver interessado em brincar com Signatureobjetos e até criar funções com assinaturas aleatórias dinamicamente, poderá dar uma olhada no meu makefunprojeto.

E sobre dir()e vars()agora?

Parece fazer exatamente o que está sendo pedido, super simples…

Deve ser chamado de dentro do escopo da função.

Mas tenha cuidado para que ele retorne todas as variáveis ​​locais; portanto, faça isso no início da função, se necessário.

Observe também que, conforme apontado nos comentários, isso não permite que seja feito fora do escopo. Portanto, não é exatamente o cenário do OP, mas ainda corresponde ao título da pergunta. Daí a minha resposta.