* args和** kwargs?
所以我对* args和** kwargs的概念有困难。
到目前为止,我已经了解到:
-
*args
=参数列表 – 作为位置参数 -
**kwargs
= dictionary – 其键值变成单独的关键字参数,并且这些值成为这些参数的值。
??
说实话,我不明白,并没有得到什么编程任务,这将有所帮助。 (我确定有,但我无法理解。)
也许:
我想input列表和字典作为函数的参数,同时作为通配符,所以我可以通过任何参数?
有一个简单的例子来解释如何使用*args
和**kwargs
?
另外我经历的教程只使用了“*”和一个variables名。
*args
和**kwargs
只是一个占位符,或者你在代码中使用了*args
和**kwargs
?
语法是*
和**
。 名字*args
和**kwargs
只是惯例,但没有硬性要求使用它们。
当你不确定有多less个参数可以传递给你的函数时,你会使用*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只是将所有parameter passing给Foo类。
这是一个使用3种不同types的参数的例子。
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 = 1000 mystr = 'Hello World!' print "{mystr} New-style formatting is {mynum}x more fun!".format(**locals())
我不确定与使用自己的名字相比,它的速度是非常快的,但是键入起来要容易得多!
其中* 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的特殊魔法特性。 想想一个函数可能有一个未知数量的参数。 例如,无论出于什么原因,你想要的function总和未知的数字(你不想使用内置的总和function)。 所以你写这个函数:
def sumFunction(*args): result = 0 for x in args: result += x return result
并使用它:sumFunction(3,4,6,3,6,8,9)。
** kwargs有一个不同的function。 使用** 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)
然后你使用这个function,如:
>>> 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是函数调用语法的一部分,而不是真正的运算符。 这有一个特别的副作用,我碰到了,这是你不能使用* args扩展与打印语句,因为打印不是一个函数。
这似乎是合理的:
def myprint(*args): print *args
不幸的是,它不能编译(语法错误)。
这编译:
def myprint(*args): print args
但是将参数打印为一个元组,这不是我们想要的。
这是我解决的解决scheme:
def myprint(*args): for arg in args: print arg, print
这些参数通常用于代理函数,所以代理可以将任何inputparameter passing给目标函数。
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),但更具体地说,是为了解释神秘的miss args和kwargs先生(礼貌的archive.org) (原始的,死链接在这里 )。
简而言之,当使用对函数或方法的可选参数时,两者都被使用。 正如Dave所说,当你不知道可以传递多less个参数时,就会使用* args,而当你想要处理由name和value指定的参数时,可以使用* kwargs,如下所示:
myfunction(myarg=1)