确定函数的参数和关键字参数。

Question

你如何确定一个有效函数调用的形式？

举个例子，假设我们有一个名为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 的参数进行任意、正确 的调用，例如进行随机化测试。

- Ana Nimbus

Answer 1

已经存在一个这个目的的函数，inspect.getfullargspec，它返回一个namedtuple：

>>> 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,)}

baz中的42不是关键字参数，而是默认参数。因为在调用时不需要提供关键字b。

help(__init__)中的*指的是后面必须跟随关键字参数，即告诉接下来的参数必须是仅关键字参数，同样，在/之前的任何参数都必须是位置参数，更多信息请参见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 ，您可以轻松访问不同的字段：

>>> argspecs = inspect.getfullargspec(qux)
>>> argspecs.args
['a']
>>> argspecs.kwonlydefaults
{'b': 42}

如果你想得到一个字典，你可以调用结果的namedtuple的_asdict方法：

>>> 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': {}}

- Sayandip Dutta

---

谢谢。对于其他的问题，当你在搜索 inspect.getfullargspec with the python tag 时，在 StackOverflow 上可以找到更多信息，_现在我知道该搜索什么了_。谢谢。 - Ana Nimbus