python - 如何检查函数/方法采用哪些参数？

Question

为了使我在 Python 中构建的几个模块保持一致，我想做一些自动代码检查。为此，我想检查模块的功能以及函数采用的参数。我可以使用 hasattr() 检查模块是否实际包含预期的功能。到目前为止，一切都很好。

我现在想看看函数采用哪些参数。只需查看变量名称就足够了。我不知道我怎么能做到这一点。有谁知道我怎样才能得到一个函数的参数名称？

Answer 1

您可以使用inspect.getargspec()来查看接受了哪些参数，以及关键字参数的任何默认值。

演示：

>>> def foo(bar, baz, spam='eggs', **kw): pass
... 
>>> import inspect
>>> inspect.getargspec(foo)
ArgSpec(args=['bar', 'baz', 'spam'], varargs=None, keywords='kw', defaults=('eggs',))
>>> inspect.getargspec(foo).args
['bar', 'baz', 'spam']

在 Python 3 中，您希望使用此方法，inspect.getfullargspec()因为此方法支持新的 Python 3 函数参数特性：

>>> def foo(bar: str, baz: list, spam: str = 'eggs', *, monty: str = 'python', **kw) -> None: pass
... 
>>> import inspect
>>> inspect.getfullargspec(foo)
FullArgSpec(args=['bar', 'baz', 'spam'], varargs=None, varkw='kw', defaults=('eggs',), kwonlyargs=['monty'], kwonlydefaults={'monty': 'python'}, annotations={'baz': <class 'list'>, 'return': None, 'spam': <class 'str'>, 'monty': <class 'str'>, 'bar': <class 'str'>})

inspect.getargspec()应该被认为在 Python 3 中已弃用。

Python 3.4 添加了inspect.Signature()对象：

>>> inspect.signature(foo)
<inspect.Signature object at 0x100bda588>
>>> str(inspect.signature(foo))
"(bar:str, baz:list, spam:str='eggs', *, monty:str='python', **kw) -> None"
>>> inspect.signature(foo).parameters
mappingproxy(OrderedDict([('bar', <Parameter at 0x100bd67c8 'bar'>), ('baz', <Parameter at 0x100bd6ea8 'baz'>), ('spam', <Parameter at 0x100bd69f8 'spam'>), ('monty', <Parameter at 0x100bd6c28 'monty'>), ('kw', <Parameter at 0x100bd6548 'kw'>)]))

以及更多有趣的签名选项。