web-dev-qa-db-ja.com

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

Python関数が与えられた場合：

def aMethod(arg1, arg2):
    pass

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

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

pythondecoratorintrospectionpython-datamodel
209
Staale

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で定義された一部の組み込み関数は、引数に関するメタデータを提供しません。その結果、組み込み関数でinspect.getfullargspec()を使用する場合、ValueErrorを取得します。

Python 3.3以降では、 inspect.signature（） を使用して、呼び出し可能なオブジェクトの呼び出しシグネチャを知ることもできます。

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

CPythonでは、引数の数は

aMethod.func_code.co_argcount

そして、それらの名前は

aMethod.func_code.co_varnames

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

「パススルー」引数を許可する1つの移植可能な方法は、_func(*args, **kwargs)シグネチャで関数を定義することです。これは、たとえばmatplotlib。外側のAPIレイヤーは、多くのキーワード引数を下位レベルのAPIに渡します。

95
Jouni K. Seppänen

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

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]
22
Mehdi Behrooz

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

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
hlzr

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


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

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

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

8
argaen

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
7
Peter Majko

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}
5
Kfir Eisner

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

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

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

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
user1981531

python 3で、以下は*argsと**kwargsをdictにすることです（python <3.6にはOrderedDictを使用します） 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
Alpha

ブライアンの答え を少し更新するために、pythonバージョンで使用できるinspect.signatureのNiceバックポートがあります： 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 プロジェクトを見ることができます。

0
smarie

モジュールを使用せずに関数パラメーターを取得する別の方法を次に示します。

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'})
0
dildeolupbiten

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
Nikolay Makhalin