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

Question

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

Учитывая объект функции, как я могу получить его подпись? Например, для:

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

Я хотел бы получить "myMethod(firt, second, third='something')",

188

python arguments inspect

Источник

user286352 20 апр '10 в 17:17

9 ответов

Решение

Возможно, самый простой способ найти подпись для функции будет 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'>

61

Источник

user2521769 01 авг '14 в 09:17

#! /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")

15

Источник

user154279 26 июн '12 в 07:15

Попробуйте позвонить help on an object to find out about it.

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

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

11

Источник

user192839 20 апр '10 в 17:19

Может быть, немного опоздал на вечеринку, но если вы также хотите сохранить порядок аргументов и их значения по умолчанию, то вы можете использовать модуль Абстрактного синтаксического дерева (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

8

Источник

user222529 02 июл '15 в 17:05

Используйте%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')

7

Источник

user5120376 13 июл '18 в 12:12

Если все, что вы пытаетесь сделать, это напечатать функцию, используйте 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 модуля проверки. Я должен был сделать это при проверке функции скрипта хука пользователя в общей структуре.

7

Источник

user3457624 11 авг '16 в 14:28

Пример кода:

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")])
    )

6

Источник

user5281824 24 авг '18 в 11:01

Еще одна поздняя запись. Я не хочу, опять же, печатать знак или отображать справку. Это программный анализ параметров функции (когда я добрался до этого вопроса, я хотел проверить функции просмотра Django, просматривая функции сrequestкак имя первого параметра).

Ключом является атрибут Signature.parameters , который на самом деле не так уж и сложен (обратите внимание, чтоinspect._emptyсродниNoneв концепции).

      import inspect
from typing import Any, cast

def check_signature(func : "Callable") -> None:
    funcname = func.__name__
    try:
        # class inspect.Signature(parameters=None, *, return_annotation=Signature.empty)
        # see https://docs.python.org/3/library/inspect.html#inspect.Signature
        sig = inspect.signature(func)
    except (ValueError,) as e: 
        print(f"\n\n`{funcname}` has no signature")
        return
    
    print(f"\n\n`{funcname}{sig}` parameters:")
    for position, (name,param) in enumerate(sig.parameters.items()):
        # class inspect.Parameter(name, kind, *, default=Parameter.empty, annotation=Parameter.empty)
        # see https://docs.python.org/3/library/inspect.html#inspect.Parameter
        print(f"  {position} {name:30.30}  kind={param.kind.description.replace(' ','_')} / default={param.default if param.default is not inspect._empty else ''} / annotation={param.annotation if param.annotation is not inspect._empty else ''}")

class Foo:
    def bar(self, zoom : int =2):
        pass

for func in [Any, check_signature, print, Foo.bar, Foo().bar, isinstance, issubclass, cast]:
    check_signature(func)

выход:

      

`Any(*args, **kwds)` parameters:
  0 args                            kind=variadic_positional / default= / annotation=
  1 kwds                            kind=variadic_keyword / default= / annotation=


`check_signature(func: 'Callable') -> None` parameters:
  0 func                            kind=positional_or_keyword / default= / annotation=Callable


`print` has no signature


`bar(self, zoom: int = 2)` parameters:
  0 self                            kind=positional_or_keyword / default= / annotation=
  1 zoom                            kind=positional_or_keyword / default=2 / annotation=<class 'int'>


`bar(zoom: int = 2)` parameters:
  0 zoom                            kind=positional_or_keyword / default=2 / annotation=<class 'int'>


`isinstance(obj, class_or_tuple, /)` parameters:
  0 obj                             kind=positional-only / default= / annotation=
  1 class_or_tuple                  kind=positional-only / default= / annotation=


`issubclass(cls, class_or_tuple, /)` parameters:
  0 cls                             kind=positional-only / default= / annotation=
  1 class_or_tuple                  kind=positional-only / default= / annotation=


`cast(typ, val)` parameters:
  0 typ                             kind=positional_or_keyword / default= / annotation=
  1 val                             kind=positional_or_keyword / default= / annotation=

В случае с OP вы бы просто проверилиparam.default is not inspect._empty. Я бы предпочел вернутьdict[str, Any]из тех.

Чтобы немного облегчить себе жизнь, я добавил ко всему этому оболочку pydantic:

      class FuncSignature(BaseModel):

    class Config:
        arbitrary_types_allowed = True

    funcname: str
    sig : inspect.Signature
    by_pos : dict[int,inspect.Parameter]
    by_name: dict[str,inspect.Parameter]

    undefined = inspect._empty

def get_signature(func : "Callable") -> FuncSignature:
    """return signature for a function"""
    funcname = func.__name__
    sig = inspect.signature(func)
    by_name, by_pos = {},{}

    for position, (name,param) in enumerate(sig.parameters.items()):
        by_name[name] = param
        by_pos[position] = param

    return FuncSignature(funcname=funcname, sig=sig,by_name=by_name,by_pos=by_pos)

что позволило мне

      def myview(request, rdbname):
    pass

res = check_signature(myview)
print(res.by_pos[0].name == "request")  # True

0

Источник

user1394353 18 ноя '22 в 02:40

Другие вопросы по тегам python arguments inspect

user190597 20 апр '10 в 17:29 2010-04-20 17:29 · Accepted Answer · 2010-04-20 17:29

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() is deprecated since Python 3.0.

Python 3.0--3.4 recommends inspect.getfullargspec(),

Python 3.5+ recommends inspect.signature(),

259

Источник

user190597 20 апр '10 в 17:29