使用*args和**kwargs

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

到目前为止,我了解到:

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

我不明白这对什么编程任务有帮助。

也许:

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

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

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

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

906814 次浏览

名称*args**kwargs**kw纯粹是惯例。它使我们更容易阅读彼此的代码

一个方便的地方是使用struct模块时

struct.unpack()返回一个元组,而struct.pack()使用可变数量的参数。当操作数据时,能够将元组传递给struck.pack()是很方便的,例如。

tuple_of_data = struct.unpack(format_str, data)# ... manipulate the datanew_data = struct.pack(format_str, *tuple_of_data)

没有这个能力你就会被迫写作

new_data = struct.pack(format_str, tuple_of_data[0], tuple_of_data[1], tuple_of_data[2],...)

这也意味着如果format_str改变,元组的大小改变,我将不得不回去编辑那很长的一行

语法是#0和#1.名称*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. apple1. banana2. 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 = vegetableapple = 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 valuesprint value1, value2
class MyFoo(Foo):def __init__(self, *args, **kwargs):# do something else, don't care about the argsprint 'myfoo'super(MyFoo, self).__init__(*args, **kwargs)

通过这种方式,您可以扩展Foo类的行为,而不必对Foo了解太多。如果您正在为可能发生变化的API编程,这可能非常方便。MyFoo只是将所有参数传递给Foo类。

*args和**kwargs是Python的特殊魔法特性。想象一个可能有未知数量参数的函数。例如,无论出于何种原因,你想要一个求和未知数量数字的函数(并且你不想使用内置的sum函数)。所以你写了这个函数:

def sumFunction(*args):result = 0for x in args:result += xreturn result

并像这样使用它:sum Function(3,4,6,3,6,8,9)。

**kwargs有一个不同的函数。使用**kwargs,您可以为函数提供任意关键字参数,并且可以将它们作为字典访问。

def someFunction(**kwargs):if 'text' in kwargs:print kwargs['text']

调用一些函数(text="foo")将打印foo。

假设你有一个函数,但你不想限制它需要的参数数量。示例:

>>> import operator>>> def multiply(*args):...  return reduce(operator.mul, args)

然后你可以像这样使用这个函数:

>>> multiply(1,2,3)6
or
>>> numbers = [1,2,3]>>> multiply(*numbers)6

*args和**kwargs有用的一种情况是在编写包装函数(例如装饰器)时,这些包装函数需要能够接受任意参数以传递给被包装的函数。例如,一个简单的装饰器打印被包装函数的参数和返回值:

def mydecorator( f ):@functools.wraps( f )def wrapper( *args, **kwargs ):print "Calling f", args, kwargsv = f( *args, **kwargs )print "f returned", vreturn vreturn wrapper

你可以看一下python文档(docs.python.orgFAQ中),但更具体地说是为了一个好的解释神秘的Args小姐和Kwargs先生(由archive.org提供)(原始的死链接是这里)。

简而言之,当使用函数或方法的可选参数时,两者都使用。正如Dave所说,当您不知道可以传递多少参数时使用*args,当您想处理由名称和值指定的参数时使用**kwargs,如:

myfunction(myarg=1)

这些参数通常用于代理函数,因此代理可以将任何输入参数传递给目标函数。

def foo(bar=2, baz=5):print bar, baz
def proxy(x, *args, **kwargs): # reqire parameter x and accept any number of additional argumentsprint xfoo(*args, **kwargs) # applies the "non-x" parameter to foo
proxy(23, 5, baz='foo') # calls foo with bar=5 and baz=fooproxy(6)# calls foo with its default argumentsproxy(7, bar='asdas') # calls foo with bar='asdas' and leave baz default argument

但由于这些参数隐藏了实际的参数名称,因此最好避免使用它们。

这是一个使用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}

以下是我最喜欢使用**语法的地方之一,就像Dave Webb的最后一个例子一样:

mynum = 1000mystr = 'Hello World!'print("{mystr} New-style formatting is {mynum}x more fun!".format(**locals()))

我不确定与仅仅使用名称本身相比,它是否非常快,但它更容易输入!

请注意,*args/**kwargs是函数调用语法的一部分,而不是真正的运算符。这有一个我遇到的特殊副作用,那就是你不能在print语句中使用*args扩展,因为print不是函数。

这似乎是合理的:

def myprint(*args):print *args

不幸的是,它不编译(语法错误)。

这编译了:

def myprint(*args):print args

但是将参数打印为元组,这不是我们想要的。

这是我选择的解决方案:

def myprint(*args):for arg in args:print arg,print