使用*args和**kwargs

Question

我对 *args 和 **kwargs 的概念有点困惑。

到目前为止，我了解到：

• *args 是一串参数 - 作为位置参数使用
• **kwargs 是一个字典 - 它的键变成单独的关键字参数，而值则是这些参数的值。

我不太明白这在编程中有什么用。

也许：

我觉得可以把列表和字典作为函数的参数，同时又可以当作通配符，这样我就可以传递任何参数？

有没有简单的例子来解释 *args 和 **kwargs 是怎么用的？

还有，我找到的教程只用了“*”和一个变量名。

*args 和 **kwargs 是不是只是占位符，还是在代码中必须用 *args 和 **kwargs 这个名字？

Answer 1

这里有一个例子，展示了三种不同类型的参数。

def func(required_arg, *args, **kwargs):
    # required_arg is a positional-only parameter.
    print required_arg

    # args is a tuple of positional arguments,
    # because the parameter name has * prepended.
    if args: # If args is not empty.
        print args

    # kwargs is a dictionary of keyword arguments,
    # because the parameter name has ** prepended.
    if kwargs: # If kwargs is not empty.
        print kwargs

>>> func()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: func() takes at least 1 argument (0 given)

>>> func("required argument")
required argument

>>> func("required argument", 1, 2, '3')
required argument
(1, 2, '3')

>>> func("required argument", 1, 2, '3', keyword1=4, keyword2="foo")
required argument
(1, 2, '3')
{'keyword2': 'foo', 'keyword1': 4}

Answer 2

使用 *args 和 **kwargs 的一个好地方是用在子类中。

class Foo(object):
    def __init__(self, value1, value2):
        # do something with the values
        print value1, value2

class MyFoo(Foo):
    def __init__(self, *args, **kwargs):
        # do something else, don't care about the args
        print 'myfoo'
        super(MyFoo, self).__init__(*args, **kwargs)

这样你就可以扩展 Foo 类的功能，而不需要对 Foo 了解太多。如果你在编写一个可能会变化的 API，这样做会非常方便。MyFoo 只是把所有的参数传递给 Foo 类。

Answer 3

这里提到的语法是 * 和 **。*args 和 **kwargs 这两个名字只是约定俗成，并没有硬性规定一定要用这两个名字。

你会在不确定会传入多少个参数时使用 *args，也就是说，它允许你传入任意数量的参数给你的函数。例如：

>>> def print_everything(*args):
        for count, thing in enumerate(args):
...         print( '{0}. {1}'.format(count, thing))
...
>>> print_everything('apple', 'banana', 'cabbage')
0. apple
1. banana
2. cabbage

同样，**kwargs 让你可以处理那些你没有提前定义的命名参数：

>>> def table_things(**kwargs):
...     for name, value in kwargs.items():
...         print( '{0} = {1}'.format(name, value))
...
>>> table_things(apple = 'fruit', cabbage = 'vegetable')
cabbage = vegetable
apple = fruit

你也可以把它们和命名参数一起使用。显式的参数会先获取值，然后其他的参数就会传给 *args 和 **kwargs。命名参数会在列表的最前面。例如：

def table_things(titlestring, **kwargs)

你也可以在同一个函数定义中同时使用这两者，但 *args 必须放在 **kwargs 之前。

在调用函数时，你也可以使用 * 和 ** 的语法。例如：

>>> def print_three_things(a, b, c):
...     print( 'a = {0}, b = {1}, c = {2}'.format(a,b,c))
...
>>> mylist = ['aardvark', 'baboon', 'cat']
>>> print_three_things(*mylist)
a = aardvark, b = baboon, c = cat

如你所见，这种情况下，它会将列表（或元组）中的项目拆开，并将它们与函数中的参数一一对应。当然，你可以在函数定义和函数调用中都使用 *。