메소드 매개 변수 이름을 얻는 방법?


236

파이썬 함수가 주어지면 :

def a_method(arg1, arg2):
    pass

인수의 수와 이름을 추출하는 방법 즉,에 대한 참조가 있으면를 반환 func하고 싶습니다 .func.[something]("arg1", "arg2")

이것의 사용법 시나리오는 데코레이터가 있고 실제 함수에 대해 키로 나타나는 것과 동일한 순서로 메소드 인수를 사용하고 싶습니다. 즉, "a,b"내가 전화 할 때 데코레이터는 어떻게 인쇄 된 것처럼 보 a_method("a", "b")입니까?


1
거의 동일한 질문에 대한 다른 답변 목록을 보려면 이 다른 stackoverflow 게시물
dan mackinlay

1
당신의 제목은 오해의 소지가 있습니다 : '방법'이라는 단어를 '방법'이라고 말하면 보통 클래스 방법을 생각합니다. 기능을 위해 선택한 답변 (Jouni K. Seppanen에서)이 좋습니다. 그러나 (클래스) 방법의 경우 작동하지 않으며 Brian의 inspect 솔루션을 사용해야합니다.
Juh_

답변:


351

inspect모듈을 살펴보십시오 -다양한 코드 객체 속성을 검사합니다.

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

다른 결과는 * args 및 ** kwargs 변수의 이름과 제공된 기본값입니다. 즉.

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

파이썬의 특정 구현에서는 일부 콜 러블을 조사 할 수 없을 수도 있습니다. 예를 들어 CPython에서 C로 정의 된 일부 내장 함수는 인수에 대한 메타 데이터를 제공하지 않습니다. 결과적으로 내장 함수 ValueError를 사용 하면를 얻을 수 있습니다 inspect.getfullargspec().

Python 3.3부터는 inspect.signature()호출 가능한 객체의 호출 서명을 볼 수 있습니다 .

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

29
코드가 기본 매개 변수 (4,)가 키워드 매개 변수에 해당 한다는 것을 어떻게 알 수 c있습니까?
fatuhoku

63
@ fatuhoku 나는 똑같은 것을 궁금해했다. 연속 블록의 끝에 기본 인수 만 추가 할 수 있기 때문에 모호하지 않습니다. 문서에서 : "이 튜플에 n 개의 요소가 있으면 args에 나열된 마지막 n 개의 요소에 해당합니다"
Soverman

9
내 생각부터 파이썬 3.x를 getargspec (...) inspector.signature (FUNC)로 대체
디에고 안드레스 디아즈 에스피 노자

2
버전 2.6으로 변경 : 명명 된 튜플 ArgSpec (args, varargs, 키워드, 기본값)을 반환합니다.
아나운서

4
파이썬 3에서 @ DiegoAndrésDíazEspinoza- inspect.getargspec더 이상 사용되지 않지만 대체는 inspect.getfullargspec입니다.
j08lue

100

CPython에서 인수의 수는

a_method.func_code.co_argcount

그들의 이름은 시작 부분에 있습니다

a_method.func_code.co_varnames

이것들은 CPython의 구현 세부 사항이므로 IronPython 및 Jython과 같은 다른 Python 구현에서는 작동하지 않을 수 있습니다.

"통과"인수를 승인하는 한 가지 휴대용 방법은 signature로 함수를 정의하는 것 func(*args, **kwargs)입니다. 이것은 외부 API 계층이 많은 키워드 인수를 하위 레벨 API에 전달하는 matplotlib 과 같이 많이 사용됩니다 .


co_varnames는 표준 Python에서 작동하지만이 방법은 내부 인수도 표시하므로 바람직하지 않습니다.
MattK

11
왜 aMethod.func_code.co_varnames [: aMethod.func_code.co_argcount]를 사용하지 않습니까?
hochl

*args예를 들어 다음 과 같은 인수로 작업하지 않습니다 .def foo(x, *args, y, **kwargs): # foo.__code__.co_argcount == 1
Nikolay Makhalin


대신 inspect를 사용하십시오. 그렇지 않으면 코드가 3.4+의 functools.wraps에서 제대로 작동하지 않습니다. 참조 stackoverflow.com/questions/147816/...
브라이언 McCutchon

22

데코레이터 메소드에서 다음과 같은 방식으로 원래 메소드의 인수를 나열 할 수 있습니다.

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]

이 답변은 부분적으로 사용되지 않으며 업데이트해야합니다.
Imago

15

나는 당신이 찾고있는 것이 locals 방법이라고 생각합니다.


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

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

7
이것은 여기서 관심있는 문맥 (장식 자) 밖에서는 쓸모가 없습니다.
Piotr Dobrogost

8
실제로 내가 찾던 것은 정확히 여기에있는 질문에 대한 대답이 아닙니다.
javabeangrinder

15

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를 모두 포함하는 사전을 리턴합니다.


(가) 통지 [:fn.__code__.co_argcount]는 함수 인수를 찾고 있다면 매우 중요합니다은 - 그렇지 않으면뿐만 아니라 함수 내에서 생성 된 이름이 포함됩니다.
Soren Bjornstad 2016

13

다음은 데코레이터를 사용하여 원하는 것에 효과가 있다고 생각합니다.

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.

11

파이썬 3.5 이상 :

DeprecationWarning : inspect.getargspec ()은 더 이상 사용되지 않습니다. 대신 inspect.signature ()를 사용하십시오.

이전에는

func_args = inspect.getargspec(function).args

지금:

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

테스트하려면 :

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

인수 'arg'를 취하는 함수 'function'이 있다고 가정하면 True로, 그렇지 않으면 False로 평가됩니다.

파이썬 콘솔의 예 :

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

8

Python 3. +에서 Signature객체를 사용하면 인수 이름을 값으로 쉽게 매핑하는 bind()방법 은 Signature의 방법을 사용하는 것입니다!

예를 들어, 다음과 같은 맵을 인쇄하기위한 데코레이터는 다음과 같습니다.

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}

6

다음은 모듈을 사용하지 않고 함수 매개 변수를 얻는 또 다른 방법입니다.

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

산출:

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

2

인수 이름 목록을 리턴하고 부분 및 일반 함수를 처리합니다.

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

2

Brian의 답변 업데이트 :

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={})

2

파이썬 3에서, 아래에 만드는 것이다 *args**kwargs(A) 내로 dict(사용 OrderedDict유지할 파이썬 <3.6 dict주문)

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

1

inspect.signature매우 느립니다. 가장 빠른 방법은

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

0

Brian의 답변을 약간 업데이트하기 inspect.signature위해 이전 Python 버전에서 사용할 수 있는 멋진 백 포트가 있습니다 funcsigs. 그래서 제 개인적 취향은

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

def aMethod(arg1, arg2):
    pass

sig = signature(aMethod)
print(sig)

재미있게도, Signature객체 를 가지고 놀고 무작위 서명을 가진 함수를 동적으로 만드는 데 관심이 있다면 내 makefun프로젝트를 살펴볼 수 있습니다 .


-3

무엇에 대한 dir()그리고 vars()지금은?

간단하게 요구되는 것을 정확하게하는 것 같습니다…

함수 범위 내에서 호출해야합니다.

그러나 모든 지역 변수 를 반환하므로주의해야 할 경우 함수의 맨 처음에 수행해야합니다.

또한 주석에서 지적했듯이 범위 외부에서 수행 할 수는 없습니다. 따라서 OP의 시나리오는 아니지만 질문 제목과 여전히 일치합니다. 따라서 내 대답.


dir ()은 모든 변수 이름 [ 'var1', 'var2']의 목록을 반환하고 vars ()는 현재 로컬 범위 내에서 { 'var1': 0, 'var2': 'something'} 형식의 사전을 반환합니다. 함수에서 나중에 인수 변수 이름을 사용하려는 경우 다른 로컬 변수를 선언 할 수있는 함수에서 나중에 호출하면이 목록이 "오염"되므로 다른 로컬 변수에 저장해야합니다. 함수 외부에서 사용하려면 함수를 한 번 이상 실행 한 후 전역 변수에 저장해야합니다. 따라서 inspect 모듈을 사용하는 것이 좋습니다.
Peter Majko
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.