Python检查模块：仅关键字参数

Question

Python中的短语“仅关键字args”有点含糊——通常我认为它是指传递给< code>**kwarg参数的args。然而，< code>inspect模块似乎对< code>**kwarg和所谓的“仅关键字参数”进行了区分。

来自文档：

inspect.getfullargspec(func)

获取Python函数参数的名称和默认值。返回一个命名元组：

FullArgSpec（args， varargs， varkw， defaults， kwonlyargs， kwonlydefaults， annotations）

< code>args是参数名称的列表。< code>varargs和< code>varkw是< code>*和< code>**参数或< code>None的名称。defaults是最后n个参数的默认值的n元组，如果没有默认参数，则为None。< code>kwonlyargs是仅包含关键字的参数名称列表。< code>kwonlydefaults是一个将名称从< code>kwonlyargs映射到默认值的字典。< code>annotations是一个将参数名称映射到注释的字典。

所以检查模块有一个名为kwonlyargs和kwonlydefaults的东西。这在实际函数签名中意味着什么？如果你有一个接受 **kwarg 参数的函数签名，那么在运行时之前你无法真正知道关键字参数的名称，因为调用者基本上可以传递任意字典。那么，kwonlyargs 在函数签名的上下文中有什么意义——这就是 inspect.getfullargspec 提供的。

Answer 1

TL；DR:只有关键字的参数不同于普通的关键字参数。

仅关键字参数是函数调用中位于*args之后和*kwargs之前的参数。例如，考虑这个通用函数头：

def func(arg, *args, kwonly, **kwargs):

在上面的代码中，< code>kwonly只接受一个关键字参数。这意味着在给它赋值时，必须提供它的名称。换句话说，您必须显式地编写:

func(..., kwonly=value, ...)

而不仅仅是传递一个值：

func(..., value, ...)

为了更好地解释，考虑上面给出的函数调用示例:

func(1, 2, kwonly=3, kw=4)

当Python解释这个调用时，它会：

>

将 arg 分配给 1，因为它在函数签名中的位置与调用中 1 的位置匹配。

将< code>2放在< code>*args中，因为< code>*args收集任何额外的位置参数，而< code>2是多余的。

将 kwonly 分配给 3，因为我们（必要时）明确告诉它。请注意，如果我们这样做了：

func(1, 2, 3, kw=4)

< code>3也将放在< code>*args中，并且由于没有向< code>kwonly提供参数，将引发一个< code>TypeError(因为在这种情况下我们没有给它一个默认值)。

将 kw=4 放在 **kwargs 中，因为它是一个额外的关键字参数，由 **kwargs 收集。

下面是我上面所说的一个例子：

>>> def func(arg, *args, kwonly, **kwargs):
...     print('arg:', arg)
...     print('args:', args)
...     print('kwonly:', kwonly)
...     print('kwargs:', kwargs)
...
>>> func(1, 2, kwonly=3, kw=4)
arg: 1
args: (2,)
kwonly: 3
kwargs: {'kw': 4}
>>>
>>> func(1, 2, 3, kw=4)  # Should have written: 'kwonly=3'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: func() missing 1 required keyword-only argument: 'kwonly'
>>>

基本上，您可以将仅关键字参数视为关键字参数，在为它们提供值时必须提供参数的名称。位置值是不够的，就像普通的关键字参数一样。

>>> def func(kw=None):
...     print('kw:', kw)
...
>>> func(kw=1)
kw: 1
>>> func(1)  # Do not need the name in this case.
kw: 1
>>>
>>> def func(*, kwonly=None):
...     print('kwonly:', kwonly)
...
>>> func(kwonly=1)
kwonly: 1
>>> func(1)  # Always need the name with keyword-only arguments.
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: func() takes 0 positional arguments but 1 was given
>>>

最后，我知道有些人在想“为什么只有关键字的论点？”答案很简单，在某些情况下（尤其是对于采用可变参数的函数），它们使事情更可读。

例如，请考虑内置的 max 函数及其仅关键字键参数。什么对你来说更具可读性？做这样的事情：

max(lambda x: -x, arg1, arg2, arg3)

让人们记住max的第一个参数始终是关键函数，或者这样做：

max(arg1, arg2, arg3, key=lambda x: -x)

让每个人都明白< code>lambda x: -x是你的关键函数。此外，使< code>key成为一个仅包含关键字的参数允许您在不需要时简单地省略key函数:

max(arg1, arg2, arg3)

而不是做:

max(None, arg1, arg2, arg3)

有关更多信息，您可以查看以下来源：

< Li > https://docs . python . org/3/reference/compound _ stmts . html # function < Li > https://docs . python . org/3/reference/expressions . html # calls < Li > https://docs . python . org/3/glossary . html # term-parameter