协慌网

登录 贡献 社区

使用 * args 和 ** kwargs

所以我对*args**kwargs的概念有困难。

到目前为止,我已经了解到:

  • *args = 参数列表 - 作为位置参数
  • **kwargs = dictionary - 其键成为单独的关键字参数,值成为这些参数的值。

我不明白这会对哪些编程任务有所帮助。

也许:

我想输入列表和字典作为函数 AND 的参数同时作为通配符,所以我可以传递任何参数?

是否有一个简单的例子来解释如何使用*args**kwargs

我发现的教程也使用了 “*” 和变量名。

*args**kwargs只是占位符还是在代码中使用*args**kwargs

答案

语法是*** 。名称*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

正如您在本案中所看到的,它会获取项目的列表(或元组)并将其解包。通过这个它将它们与函数中的参数匹配。当然,你可以在函数定义和函数调用中都有*

使用*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 类。

这是一个使用 3 种不同类型参数的示例。

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}