Як я можу прочитати підпис функції, включаючи значення аргументу за замовчуванням?


129

Як дано об’єкт функції, як я можу отримати його підпис? Наприклад, для:

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

Я хотів би отримати "myMethod(firt, second, third='something')".


3
Чи можете ви детально розібратися з вашим конкретним питанням і, можливо, навести приклад із очікуваним результатом?
jhwist

Імовірно, він шукає функціональність у Python або сторонніх бібліотеках, які повернуть підпис методу (імена та типи параметрів та повернене значення) з урахуванням імені методу.
Майкл Петротта

1
Підпис як у тому, як його називати і таке? Спробуйте, help(yourmethod)наприклад,help(map)
Нік Т

Відповіді:


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: об’єкт 'module' не має атрибута 'getargspec'
Spì

3
@Spi, ви викликаєте inspect.getargspecмодуль, а не функцію.
Майк Грем

Дякую, проблема була у Eclipse, який не побачив модуль перевірки
Spì

Якщо функція містить анотації аргументів або аргументи лише для ключових слів (= якщо ви використовуєте Python 3), вам потрібно зателефонувати getfullargspec. ( ValueError: Function has keyword-only arguments or annotations, use getfullargspec() API which can support them)
badp

2
@darth_coder: У Python2 getargspecпідвищується, TypeErrorякщо вхід не розпізнається як функція Python - тобто функція, реалізована в Python. У CPython Exception.__init__реалізується в C, отже, the TypeError. Вам потрібно буде перевірити вихідний код, щоб зрозуміти підпис дзвінка. У Python3 getargspecреалізується по-різному, і там inspect.getargspec(Exception.__init__)повертається ArgSpecекземпляр.
unutbu

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.signatureтакож доступний для Python 2 через funcsigsпроект backport: 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

1
Додані коментарі до зразка коду, сподіваюся, що це допоможе.
Arup Malakar

Прекрасні речі. Було б ще краще, якби ви могли налаштувати його на роботу з def foo(a, *, b:int, **kwargs)foo(4, b=3.3)
дзвінками

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


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

Використовуйте% pdef у командному рядку (IPython), він надрукує лише підпис.

напр %pdef np.loadtxt

 np.loadtxt(fname, dtype=<class 'float'>, comments='#', delimiter=None, converters=None, skiprows=0, usecols=None, unpack=False, ndmin=0, encoding='bytes')
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.