メソッドパラメータ名を取得する方法


236

Python関数を考える:

def a_method(arg1, arg2):
    pass

引数の数と名前を抽出するにはどうすればよいですか。つまり、への参照があることを前提としてfuncfunc.[something]を返し("arg1", "arg2")ます。

これの使用シナリオは、デコレータがあり、メソッドの引数を実際の関数にキーとして表示されるのと同じ順序で使用したい場合です。つまり、デコレータは、"a,b"呼び出したときに印刷されたように見えますa_method("a", "b")か?


1
ほぼ同一の質問に対する別の回答リストについては、この他の
スタックオーバーフローの

1
タイトルは誤解を招く可能性があります。「メソッド」について「関数」という言葉を言うとき、通常はクラスメソッドを思い浮かべます。機能については、選択した答え(Jouni K. Seppanenから)が適切です。ただし、(クラス)メソッドの場合は機能せず、(Brianからの)検査ソリューションを使用する必要があります。
Juh_ 2012

回答:


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

一部の呼び出し可能オブジェクトは、Pythonの特定の実装では内省できない場合があることに注意してください。たとえば、CPythonでは、Cで定義されている一部の組み込み関数は、引数に関するメタデータを提供しません。結果として、組み込み関数でValueError使用するinspect.getfullargspec()と、

Python 3.3以降では、を使用inspect.signature()して、呼び出し可能なオブジェクトの呼び出し署名を確認できます。

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

29
どのようにして、コードは、デフォルトの(4,)パラメーターがc具体的にキーワードパラメーターに対応することを知ることができますか?
fatuhoku 2013

63
@fatuhoku同じことを考えていた。隣接するブロックの最後にのみデフォルトの引数を追加できるため、あいまいではありません。ドキュメントから:「このタプルにn個の要素がある場合、それらはargsにリストされている最後のn個の要素に対応します」
Soverman

9
私が考えて以来のPython 3.xのgetargspec(...)inspector.signature(FUNC)に置き換えられて
ディエゴ・アンドレス・ディアスエスピノーザ

2
バージョン2.6で変更:名前付きタプルArgSpec(args、varargs、キーワード、デフォルト)を返します。
アナウンサー2017年

4
その通りである、@DiegoAndrésDíazEspinoza - Pythonの3に、inspect.getargspecされて非推奨が、交換がありますinspect.getfullargspec
j08lue

100

CPythonでは、引数の数は

a_method.func_code.co_argcount

とその名前はの初めにあります

a_method.func_code.co_varnames

これらはCPythonの実装の詳細であるため、おそらくこれはIronPythonやJythonなどの他のPythonの実装では機能しません。

「パススルー」引数を受け入れる移植可能な方法の1つは、シグニチャーを使用して関数を定義することfunc(*args, **kwargs)です。これは、たとえばmatplotlibなどでよく使用されます。外部APIレイヤーは、多くのキーワード引数を低レベルAPIに渡します。


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


代わりに、inspectを使用してください。そうしないと、コードは3.4以降のfunctools.wrapsではうまく機能しません。stackoverflow.com/questions/147816/…を
ブライアン・マッカッション

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]

この回答は部分的に廃止されており、更新する必要があります。
イマゴ

15

あなたが探しているのは地元の方法だと思います-


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

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

7
これは、ここで重要なコンテキストである関数(デコレータ)の外では役に立ちません。
Piotr Dobrogost

8
ここでの質問に対する答えではありませんが、実際に私が探していたものとまったく同じです。
javabeangrinder 2015

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

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

Python 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コンソールからの例:

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

Signature手元にオブジェクトがある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}

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

ブライアンの答えの更新:

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

python 3では、以下を作成*args**kwargsてaにしますdict(注文OrderedDictを維持するためにpython <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

ブライアンの答えを少し更新する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 '}の形式で辞書を返します。誰かが引数変数名を後で関数で使用したい場合は、別のローカル変数を保存する必要があります。別のローカル変数を宣言できる関数で後で呼び出すと、このリストが「汚染」されるためです。関数の外で使用したい場合は、関数を少なくとも1回実行し、グローバル変数に保存する必要があります。したがって、inspectモジュールを使用することをお勧めします。
Peter Majko
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.