Определите аргументы и аргументы ключевого слова функции - PullRequest
Новая
       62

Определите аргументы и аргументы ключевого слова функции

3 голосов
/ 01 августа 2020

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

Например, скажем, у нас есть функция info, которая выполняет это; info может работать следующим образом (я открыт для предложений относительно более полного и последовательного способа представления возвращаемой информации): 

def foo():
    pass

info(foo)
# { 'args': (), 'kwargs': {} }

def bar(a):
    pass

info(bar)
# { 'args': ('a',), 'kwargs': {} }

def baz(a, b=42):
    pass

info(baz)
# { 'args': ('a',), 'kwargs': { 'b': 42 } }

def qux(a, *args, b=42, **kwargs):
    pass

info(qux)
# { 'args': ('a',), 'kwargs': { 'b': 42 }, 'optional': {'*args', '**kwargs'} }

The info функция должна работать для любой функции. Я не уверен, как написать пример возврата для каждого шаблона: например, help(range.__init__) отображает 

# __init__(self, /, *args`, **kwargs)

, и я не уверен, что означает /.

Возврат from info должно быть чем-то, что должно быть вычислено (с разумными усилиями) для производства произвольных, правильных вызовов аргумента info, например, для рандомизированного тестирования.

1 Ответ

3 голосов
/ 01 августа 2020

Для этой цели уже существует функция inspect.getfullargspec, которая возвращает namedtuples: 

>>> import inspect
>>> inspect.getfullargspec(foo)
FullArgSpec(args=[], varargs=None, varkw=None, defaults=None, kwonlyargs=[], kwonlydefaults=None, annotations={})
>>> inspect.getfullargspec(qux)
FullArgSpec(args=['a'], varargs='args', varkw='kwargs', defaults=None, kwonlyargs=['b'], kwonlydefaults={'b': 42}, annotations={})
>>> inspect.getfullargspec(bar)
FullArgSpec(args=['a'], varargs=None, varkw=None, defaults=None, kwonlyargs=[], kwonlydefaults=None, annotations={})
>>> inspect.getfullargspec(baz)
FullArgSpec(args=['a', 'b'], varargs=None, varkw=None, defaults=(42,), kwonlyargs=[], kwonlydefaults=None, annotations={})

Однако, если вы хотите, вы можете построить функцию из этого: 

def info(func):
    """returns function argument info"""
    specs = inspect.getfullargspec(func)
    dict_ = {}
    dict_['args'] = tuple(specs.args)
    dict_['kwargs'] = {} if specs.kwonlydefaults is None else specs.kwonlydefaults
    dict_['optional'] = set()
    dict_['defaults'] = {} if specs.defaults is None else specs.defaults
    if specs.varargs is not None:
        dict_['optional'].add(f"*{specs.varargs}")
    if specs.varkw is not None:
        dict_['optional'].add(f"*{specs.varkw}")
    if not dict_['optional']:
        dict_['optional'] = {}
    return dict_

>>> info(foo)
{'args': (), 'kwargs': {}, 'optional': {}, 'defaults': {}}

>>> info(qux)
{'args': ('a',), 'kwargs': {'b': 42}, 'optional': {'*args', '*kwargs'}, 'defaults': {}}

>>> info(bar)
{'args': ('a',), 'kwargs': {}, 'optional': {}, 'defaults': {}}

>> info(baz)
{'args': ('a', 'b'), 'kwargs': {}, 'optional': {}, 'defaults': (42,)}

42 in baz не является аргументом ключевого слова, это аргумент по умолчанию. Потому что при вызове нет необходимости указывать ключевое слово b.

* в help(__init__) относится только к параметрам ключевого слова, которым нужно следовать, т.е. он сообщает, что следующие аргументы должны быть keyword-only аргументами , и аналогично любой аргумент перед / должен быть positional argument, подробнее см. PEP457, PEP570, PEP3102.

Многие из этих сведений могут быть получены из встроенного code объекта функции, который имеет следующие атрибуты: 

for attr in dir(qux.__code__):
    if not attr.startswith('_'):
        print(attr,':',getattr(qux.__code__, attr))

co_argcount : 1
co_cellvars : ()
co_code : b'd\x00S\x00'
co_consts : (None,)
co_filename : <ipython-input-43-6608913c4d65>
co_firstlineno : 1
co_flags : 79
co_freevars : ()
co_kwonlyargcount : 1
co_lnotab : b'\x00\x01'
co_name : qux
co_names : ()
co_nlocals : 4
co_stacksize : 1
co_varnames : ('a', 'b', 'args', 'kwargs')

Однако они недостаточно описательны. , труднодоступный и предназначен для внутреннего использования для python. Следовательно, если вам не нужна особая функция, inspect.getfullargspec, вероятно, лучший вариант.

fullargspec будучи namedtuple, вы можете легко получить доступ к различным полям, и если вам нужен dict, вы можете сделать: 

>>> inspect.getfullargspec(qux)._asdict()  #gives OrderedDict
OrderedDict([('args', ['a']),
             ('varargs', 'args'),
             ('varkw', 'kwargs'),
             ('defaults', None),
             ('kwonlyargs', ['b']),
             ('kwonlydefaults', {'b': 42}),
             ('annotations', {})])
>>> dict(inspect.getfullargspec(qux)._asdict()) #call dict to get regular dict
{'args': ['a'],
 'varargs': 'args',
 'varkw': 'kwargs',
 'defaults': None,
 'kwonlyargs': ['b'],
 'kwonlydefaults': {'b': 42},
 'annotations': {}}
...