Получение имен параметров метода в Python

учитывая функцию Python:

def aMethod(arg1, arg2):
    pass

Как я могу извлечь число и имена аргументов. То есть, учитывая, что у меня есть ссылка на func, я хочу func.[что-то], чтобы вернуться ("arg1", "arg2").

сценарий использования этого в том, что у меня есть декоратор, и я хочу использовать аргументы метода в том же порядке, в котором они появляются для действительной функции в качестве ключа. То есть, как бы выглядел декоратор, который напечатал "a, b", когда я называю аметод ("a","b")?

181
decorator introspection python python-datamodel

11 ответов

посмотри проверить модуль-это сделает проверку различных свойств объекта кода для вас.

>>> inspect.getargspec(aMethod)
(['arg1', 'arg2'], None, None, None)

другими результатами являются имя переменных *args и * * kwargs и предоставленные значения по умолчанию. то есть.

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

обратите внимание, что некоторые вызываемые объекты могут не быть интроспектируемыми в некоторых реализациях Python. Например, в CPython некоторые встроенные функции, определенные в C, не предоставляют метаданных о своих аргументах. В результате, вы получите ValueError в случае, если вы используете inspect.getargspec() С встроенной функцией.

начиная с Python 3.3, вы можете использовать также проверка.подпись() чтобы узнать сигнатуру вызова вызываемого объекта:

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

в CPython количество аргументов равно

aMethod.func_code.co_argcount

и их имена в начале

aMethod.func_code.co_varnames

Это детали реализации CPython, поэтому это, вероятно, не работает в других реализациях Python, таких как IronPython и Jython.

один портативный способ признать" сквозные " аргументы-определить вашу функцию с помощью подписи func(*args, **kwargs). Это используется много, например, в matplotlib, где внешний слой API передает много ключевых слов аргументы для API нижнего уровня.

90

в методе декоратора вы можете перечислить аргументы исходного метода следующим образом:

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)

если **kwargs важны для вас, тогда это будет немного сложно:

        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()

пример:

@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]
21

вот что, я думаю, будет работать для того, что вы хотите, используя декоратора.

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")

запустите его, он даст следующий результат:

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.
13

Я думаю, что вы ищете метод locals -


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

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

Python 3.5+:

DeprecationWarning: проверьте.getargspec () устарел, используйте inspect.подпись() вместо

так ранее:

func_args = inspect.getargspec(function).args

теперь:

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

Для теста:

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

учитывая, что у нас есть функция "функция", которая принимает аргумент "arg", это будет оцениваться как True, иначе как False.

пример из консоли 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
5

версия 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}

метод возвращает словарь, содержащий как args, так и kwargs.

4

возвращает список имен аргументов, заботится о частичных и обычные функции:

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

В Python 3.+ с Signature объект под рукой, простой способ получить сопоставление между именами аргументов со значениями, использует подпись bind() способ!

например, вот декоратор для печати такой карты:

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}
2

обновление Брайана!--5-->:

Если функция в Python 3 имеет аргументы только для ключевых слов, то вам нужно использовать inspect.getfullargspec:

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

дает это:

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

насчет dir() и vars() сейчас?

Кажется, делать именно то, что просят супер просто...

(внутри функции/метода)

-2