デフォルトの引数値を含む関数のシグネチャを読み取るにはどうすればよいですか?


129

関数オブジェクトが与えられた場合、どのようにしてその署名を取得できますか?たとえば、次の場合:

def myMethod(firt, second, third='something'):
    pass

欲しいです"myMethod(firt, second, third='something')"


3
特定の質問について詳しく説明し、期待される結果の例を挙げていただけますか?
jhwist 2010

おそらく彼は、メソッドの名前を指定すると、メソッドのシグネチャ(パラメータの名前とタイプ、および戻り値)を返すPythonまたはサードパーティのライブラリの機能を探しています。
Michael Petrotta 2010

1
それを呼び出す方法などの署名?help(yourmethod)例をお試しくださいhelp(map)
Nick T

回答:


187
import inspect

def foo(a, b, x='blah'):
    pass

print(inspect.getargspec(foo))
# ArgSpec(args=['a', 'b', 'x'], varargs=None, keywords=None, defaults=('blah',))

ただし、inspect.getargspec()Python 3.0以降では非推奨です。

Python 3.0--3.4はを推奨しinspect.getfullargspec()ます。

Python 3.5以降ではが推奨されinspect.signature()ます。


AttributeError:「モジュール」オブジェクトが属性「getargspec」を持っていない
SPI

3
@Spi、inspect.getargspec関数ではなくモジュールを呼び出しています。
マイクグラハム

おかげで、問題はモジュール検査見なかったことのEclipseとあった
SPI

関数に引数注釈またはキーワードのみの引数がある場合(= Python 3を使用している場合)、getfullargspec代わりに呼び出す必要があります。(ValueError: Function has keyword-only arguments or annotations, use getfullargspec() API which can support them
badp '13

2
@darth_coder:でPython2、getargspecレイズTypeError入力として認識されない場合のPython - 、Pythonで実現される機能である機能。CPythonではException.__init__、Cで実装されているため、TypeErrorです。コールシグネチャを理解するには、ソースコードを確認する必要があります。Python3では、getargspec実装が異なり、インスタンスがinspect.getargspec(Exception.__init__)返されArgSpecます。
unutbu 2018

44

おそらく、関数のシグネチャを見つける最も簡単な方法はhelp(function)次のとおりです。

>>> def function(arg1, arg2="foo", *args, **kwargs): pass
>>> help(function)
Help on function function in module __main__:

function(arg1, arg2='foo', *args, **kwargs)

また、Python 3では、inspectと呼ばれるモジュールにメソッドが追加されましたsignature。これは、呼び出し可能なオブジェクトのシグネチャとその戻りアノテーションを表すように設計されています

>>> from inspect import signature
>>> def foo(a, *, b:int, **kwargs):
...     pass

>>> sig = signature(foo)

>>> str(sig)
'(a, *, b:int, **kwargs)'

>>> str(sig.parameters['b'])
'b:int'

>>> sig.parameters['b'].annotation
<class 'int'>

3
inspect.signaturePython 2のfuncsigsバックポートプロジェクト経由でも利用可能です:pypi.python.org/pypi/funcsigs
ncoghlan

14
#! /usr/bin/env python

import inspect
from collections import namedtuple

DefaultArgSpec = namedtuple('DefaultArgSpec', 'has_default default_value')

def _get_default_arg(args, defaults, arg_index):
    """ Method that determines if an argument has default value or not,
    and if yes what is the default value for the argument

    :param args: array of arguments, eg: ['first_arg', 'second_arg', 'third_arg']
    :param defaults: array of default values, eg: (42, 'something')
    :param arg_index: index of the argument in the argument array for which,
    this function checks if a default value exists or not. And if default value
    exists it would return the default value. Example argument: 1
    :return: Tuple of whether there is a default or not, and if yes the default
    value, eg: for index 2 i.e. for "second_arg" this function returns (True, 42)
    """
    if not defaults:
        return DefaultArgSpec(False, None)

    args_with_no_defaults = len(args) - len(defaults)

    if arg_index < args_with_no_defaults:
        return DefaultArgSpec(False, None)
    else:
        value = defaults[arg_index - args_with_no_defaults]
        if (type(value) is str):
            value = '"%s"' % value
        return DefaultArgSpec(True, value)

def get_method_sig(method):
    """ Given a function, it returns a string that pretty much looks how the
    function signature would be written in python.

    :param method: a python method
    :return: A string similar describing the pythong method signature.
    eg: "my_method(first_argArg, second_arg=42, third_arg='something')"
    """

    # The return value of ArgSpec is a bit weird, as the list of arguments and
    # list of defaults are returned in separate array.
    # eg: ArgSpec(args=['first_arg', 'second_arg', 'third_arg'],
    # varargs=None, keywords=None, defaults=(42, 'something'))
    argspec = inspect.getargspec(method)
    arg_index=0
    args = []

    # Use the args and defaults array returned by argspec and find out
    # which arguments has default
    for arg in argspec.args:
        default_arg = _get_default_arg(argspec.args, argspec.defaults, arg_index)
        if default_arg.has_default:
            args.append("%s=%s" % (arg, default_arg.default_value))
        else:
            args.append(arg)
        arg_index += 1
    return "%s(%s)" % (method.__name__, ", ".join(args))


if __name__ == '__main__':
    def my_method(first_arg, second_arg=42, third_arg='something'):
        pass

    print get_method_sig(my_method)
    # my_method(first_argArg, second_arg=42, third_arg="something")

これが何をすることになっているのかについての説明はありますか?
grantmcconnaughey 2015年

1
コードサンプルにコメントを追加しました。
Arup Malakar、2015年

素敵なもの。def foo(a, *, b:int, **kwargs)呼び出し元で動作するように調整できればさらに良いでしょうfoo(4, b=3.3)
ofer.sheffer

8

helpオブジェクトを呼び出して、それについて調べてください。

>>> foo = [1, 2, 3]
>>> help(foo.append)
Help on built-in function append:

append(...)
    L.append(object) -- append object to end

7

パーティーに少し遅れるかもしれませんが、引数とそのデフォルトの順序も維持したい場合は、抽象構文ツリーモジュール(ast)を使用できます。

ここに概念の証明があります(引数を並べ替えてそれらをデフォルトに一致させるコードに間違いなく改善/明確化できることに注意してください):

import ast

for class_ in [c for c in module.body if isinstance(c, ast.ClassDef)]:
    for method in [m for m in class_.body if isinstance(m, ast.FunctionDef)]:
        args = []
        if method.args.args:
            [args.append([a.col_offset, a.id]) for a in method.args.args]
        if method.args.defaults:
            [args.append([a.col_offset, '=' + a.id]) for a in method.args.defaults]
        sorted_args = sorted(args)
        for i, p in enumerate(sorted_args):
            if p[1].startswith('='):
                sorted_args[i-1][1] += p[1]
        sorted_args = [k[1] for k in sorted_args if not k[1].startswith('=')]

        if method.args.vararg:
            sorted_args.append('*' + method.args.vararg)
        if method.args.kwarg:
            sorted_args.append('**' + method.args.kwarg)

        signature = '(' + ', '.join(sorted_args) + ')'

        print method.name + signature

デフォルト以外の引数はデフォルト引数の後に続くことができないので、末尾からそれらを単純に一致させることができることに注意してください。
Evgeni Sergeev

5

あなたがやろうとしているのが関数を表示することだけなら、pydocを使ってください。

import pydoc    

def foo(arg1, arg2, *args, **kwargs):                                                                    
    '''Some foo fn'''                                                                                    
    pass                                                                                                 

>>> print pydoc.render_doc(foo).splitlines()[2]
foo(arg1, arg2, *args, **kwargs)

関数シグネチャを実際に分析する場合は、検査モジュールのargspecを使用してください。ユーザーのフックスクリプト関数を一般的なフレームワークに検証するときに、それを行わなければなりませんでした。


3

コード例:

import inspect
from collections import OrderedDict


def get_signature(fn):
    params = inspect.signature(fn).parameters
    args = []
    kwargs = OrderedDict()
    for p in params.values():
        if p.default is p.empty:
            args.append(p.name)
        else:
            kwargs[p.name] = p.default
    return args, kwargs


def test_sig():
    def fn(a, b, c, d=3, e="abc"):
        pass

    assert get_signature(fn) == (
        ["a", "b", "c"], OrderedDict([("d", 3), ("e", "abc")])
    )

2

コマンドライン(IPython)で%pdefを使用すると、署名のみが出力されます。

例えば %pdef np.loadtxt

 np.loadtxt(fname, dtype=<class 'float'>, comments='#', delimiter=None, converters=None, skiprows=0, usecols=None, unpack=False, ndmin=0, encoding='bytes')
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.