Pythonでメソッドパラメーター名を取得する

Question

Python関数を指定：

def aMethod(arg1, arg2):
    pass

引数の数と名前を抽出するにはどうすればよいですか。つまり、funcへの参照がある場合、func。[something]に（<！> quot; arg1 <！> quot ;, <！> quot; arg2 <！> quot;）を返します。

この使用シナリオは、デコレータを持っているということです。実際の機能に対してキーとして表示されるのと同じ順序でメソッド引数を使用したいと思います。つまり、デコレータは、<！> quot; a、b <！> quot; aMethod（<！> quot; a <！> quot ;, <！> quot; b <！> quot;）を呼び出すとどうなりますか？

Answer 1

inspect モジュールを見てください。これにより、さまざまなオブジェクトプロパティをコーディングします。

>>> inspect.getfullargspec(aMethod)
(['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)>

Answer 2

CPythonでは、引数の数は

aMethod.func_code.co_argcount

およびその名前は先頭にあります

aMethod.func_code.co_varnames

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

<！> quot; pass-through <！> quotを許可する1つのポータブルな方法。引数は、シグネチャfunc(*args, **kwargs)で関数を定義することです。これは、たとえばmatplotlib。外部APIレイヤーは、多くのキーワード引数を下位レベルAPIに渡します。

Answer 3

デコレータメソッドでは、次の方法で元のメソッドの引数をリストできます。

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]

Answer 4

ここに、デコレータを使用して、あなたが望むものに役立つと思うものがあります。

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.

Answer 5

探しているのはローカルメソッドだと思います-

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

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

Answer 6

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の両方を含む辞書を返します。

Answer 7

Python 3.5以降：

  

非推奨警告：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

Answer 8

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}

Answer 9

引数名のリストを返し、部分関数と通常の関数を処理します：

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

Answer 10

ブライアンの回答：

の更新

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

Answer 11

Python 3では、以下で*argsと**kwargsをdictにします（Python <！> ltにはOrderedDictを使用し、<=>順序を維持するには3.6を使用します）：

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

Answer 12

少しブライアンの回答を更新するために、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 プロジェクト。

Answer 13

dir()とvars()はどうですか？

質問されていることを正確に実行しているようです<！>＃8230;

関数スコープ内から呼び出す必要があります。

ただし、 all ローカル変数を返すことに注意してください。必要に応じて、関数の最初で必ず実行してください。

また、コメントで指摘されているように、これはスコープの外からそれを行うことを許可しないことに注意してください。したがって、OPのシナリオと正確には一致しませんが、それでも質問のタイトルと一致します。したがって、私の答え。