如何确定函数的有效调用形式?
例如,假设我们有一个函数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'} }
info
函数应适用于任何函数。我不确定如何为每种模式编写示例返回:例如,help(range.__init__)
显示
# __init__(self, /, *args`, **kwargs)
我不确定/
是什么意思。
info
的返回值必须是(以合理的努力)计算得出的,以产生对info
的论证的任意正确调用,例如,用于随机测试。
答案 0 :(得分:3)
已经有一个用于此目的的函数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
中的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
,您可以轻松地访问不同的字段,并且如果您想要一个字典,则可以执行以下操作:
>>> 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': {}}