Pobieranie nazw parametrów metod w Pythonie

Biorąc pod uwagę funkcję Pythona:

def aMethod(arg1, arg2):
    pass

Jak mogę wyodrębnić liczbę i nazwy argumentów. Czyli, biorąc pod uwagę, że mam odniesienie do func, chcę func.[something] to return ("arg1","arg2").

Scenariusz użycia jest taki, że mam dekorator i chcę używać argumentów metody w tej samej kolejności, w jakiej występują dla rzeczywistej funkcji jako klucza. Czyli jak wyglądałby dekorator, który wydrukował "a, b", gdy nazywam aMethod("a", "b")?

Author: Peter Mortensen, 2008-10-20

11 answers

Spójrz na moduł inspect - spowoduje to sprawdzenie różnych właściwości obiektu kodu.

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

Pozostałe wyniki to nazwa zmiennych * args i * * kwargs oraz podane wartości domyślne. ie.

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

Zauważ, że niektóre wywołania mogą nie być introspektywne w niektórych implementacjach Pythona. Na przykład w Cpythonie niektóre wbudowane funkcje zdefiniowane w C nie zawierają metadanych dotyczących ich argumentów. W rezultacie uzyskasz ValueError w przypadek, którego używasz inspect.getargspec() z wbudowaną funkcją.

Od wersji Pythona 3.3, możesz używać również inspect.signature () w celu poznania sygnatury wywołania obiektu, który można wywołać:

>>> inspect.signature(foo)
<Signature (a, b, c=4, *arglist, **keywords)>
 291
Author: Brian,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2018-01-17 13:35:17

W Cpythonie liczba argumentów wynosi

aMethod.func_code.co_argcount

A ich nazwy są na początku

aMethod.func_code.co_varnames

Są to szczegóły implementacji CPython, więc prawdopodobnie nie działa to w innych implementacjach Pythona, takich jak IronPython i Jython.

Jednym z przenośnych sposobów na przyznanie argumentów "pass-through" jest zdefiniowanie funkcji za pomocą podpisu func(*args, **kwargs). Jest to często używane np. w matplotlib, gdzie zewnętrzna warstwa API przekazuje wiele argumentów słów kluczowych do niższego poziomu API.

 90
Author: Jouni K. Seppänen,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2008-10-20 14:37:20

W metodzie dekoratora możesz wypisać argumenty oryginalnej metody w następujący sposób:

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)

Jeśli {[3] } są dla Ciebie ważne, to będzie to nieco skomplikowane:

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

Przykład:

@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
Author: Mehdi Behrooz,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2013-05-14 11:36:45

Tutaj jest coś, co myślę, że zadziała na to, co chcesz, używając dekoratora.

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

Uruchom GO, da następujące Wyjście:

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
Author: hlzr,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2008-10-21 00:08:23

Myślę, że to, czego szukasz, to metoda tubylców -


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

In [7]: test(1,2)              
{'a': 1, 'b': 2}
 10
Author: Damian,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2010-06-07 16:37:20

Python 3.5+:

DeprecationWarning: inspect.getargspec() jest przestarzała, użyj inspect.signature() zamiast

So previously:

func_args = inspect.getargspec(function).args

Teraz:

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

Do testu:

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

Biorąc pod uwagę, że mamy funkcję 'function', która przyjmuje argument 'arg', będzie ona oceniana jako True, w przeciwnym razie jako False.

Przykład z konsoli Pythona:

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
Author: Peter Majko,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2018-05-20 13:19:37

Wersja Pythona 3 to:

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

Metoda zwraca słownik zawierający zarówno args jak i kwargs.

 4
Author: argaen,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2018-05-20 13:16:51

Zwraca listę nazw argumentów, zajmuje się funkcjami częściowymi i regularnymi:

def get_func_args(f):
    if hasattr(f, 'args'):
        return f.args
    else:
        return list(inspect.signature(f).parameters)
 2
Author: lovesh,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2017-05-30 11:52:53

W Pythonie 3.+ z obiektem Signature pod ręką, łatwym sposobem na mapowanie między nazwami argumentów do wartości, jest użycie metody bind() podpisu!

Na przykład, oto dekorator do wydrukowania takiej mapy:

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
Author: Kfir Eisner,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2018-05-20 13:20:41

Aktualizacja dla odpowiedź Briana:

Jeśli funkcja w Pythonie 3 ma argumenty tylko dla słów kluczowych, musisz użyć inspect.getfullargspec:

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

Daje to:

FullArgSpec(args=['a', 'b'], varargs=None, varkw=None, defaults=(10,), kwonlyargs=['c', 'd'], kwonlydefaults={'c': 20, 'd': 30}, annotations={})
 1
Author: user1981531,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2018-05-20 13:18:49

A co z dir() i vars() teraz?

Wygląda na to, że robi dokładnie to, o co prosi się po prostu...]}

(z wnętrza funkcji / metody)

 -2
Author: JeromeJ,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2017-01-07 21:34:51