所以我对 "*args "和 "**kwargs "的概念感到困难。
到目前为止,我已经了解到。
*args
= 参数列表 - 作为位置参数**kwargs
= 字典 - 其键成为单独的关键字参数,其值成为这些参数的值。我不明白这对什么编程任务有帮助。
也许吧。
我想把列表和字典作为函数的参数输入,同时作为通配符,所以我可以传递任何参数?
有没有一个简单的例子来解释*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}
有一种情况下,*args和**kwargs很有用,那就是在编写封装函数(比如装饰函数)时,需要能够接受任意的参数来传递给被封装的函数。 例如,一个简单的装饰器,它可以打印被包装函数的参数和返回值。
def mydecorator( f ):
@functools.wraps( f )
def wrapper( *args, **kwargs ):
print "Calling f", args, kwargs
v = f( *args, **kwargs )
print "f returned", v
return v
return wrapper
*args 和 **kwargs 是 Python 的特殊魔法特性。 想一想一个可以有未知数参数的函数。 例如,无论出于什么原因,你想有一个函数来求未知数的和 (而且你不想使用内置的和函数)。 所以你写了这样一个函数:{{{7316999}}。
def sumFunction(*args):
result = 0
for x in args:
result += x
return result
并像这样使用它。 sumFunction(3,4,6,3,6,8,9).
kwargs有一个不同的功能。 有了kwargs,你可以给一个函数赋予任意的关键字参数,并且你可以把它们作为一个口令来访问。
def someFunction(**kwargs):
if 'text' in kwargs:
print kwargs['text']
调用someFunction(text="foo")将打印foo。
想象一下,你有一个函数,但你不想限制它的参数数量。 例如:
>>> import operator
>>> def multiply(*args):
... return reduce(operator.mul, args)
。
>>> 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'或`kw'的名称纯属惯例。它使我们更容易阅读对方的代码。
有一个地方很方便,就是在使用结构模块的时候
struct.unpack()
返回一个元组,而struct.pack()
使用一个可变数量的参数。在处理数据时,能够将一个元组传递给struck.pack()
是很方便的,例如。
tuple_of_data = struct.unpack(format_str, data)
... manipulate the data
new_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发生变化,元组的大小发生变化,我将不得不回去编辑那条很长的线。
注意/*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
这些参数通常用于代理函数,因此代理函数可以将任何输入参数传递给目标函数。
def foo(bar=2, baz=5):
print bar, baz
def proxy(x, *args, **kwargs): # reqire parameter x and accept any number of additional arguments
print x
foo(*args, **kwargs) # applies the "non-x" parameter to foo
proxy(23, 5, baz='foo') # calls foo with bar=5 and baz=foo
proxy(6)# calls foo with its default arguments
proxy(7, bar='asdas') # calls foo with bar='asdas' and leave baz default argument
但由于这些参数隐藏了实际的参数名称,所以最好避免使用。
你可以看看python文档(docs.python.org中的FAQ),但更具体的是要好好解释一下【神秘的miss args和mister kwargs(由archive.org提供)】[2](原文,死链接是[这里][2])。
简而言之,两者都是在使用函数或方法的可选参数时使用的。 正如 Dave 所说,当你不知道可以传递多少个参数时,使用 *args,当你想处理由名称和值指定的参数时,使用 **kwargs,如:{{7317004}}。
myfunction(myarg=1)
[1]: http://pypatterns.net/post/2009/10/the-mysterious-miss-args-and-mister-kwargs [2]: https://web.archive.org/web/20101017032628/http://pypatterns.net/post/2009/10/the-mysterious-miss-args-and-mister-kwargs