* args 和 ** kwargs 的使用

所以我很难理解*args**kwargs的概念。

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

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

我不知道这对您有什么帮助。

也许:

我认为要输入列表和字典作为函数的参数,并与通配符同时输入,因此我可以传递 ANY 参数吗?

有一个简单的示例来说明如何使用*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传递给*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}

这是我最喜欢的使用**语法的地方之一,如 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 的特殊魔术功能。考虑一个可能具有未知数量参数的函数。例如,无论出于何种原因,您都希望具有对未知数量的数字求和的函数(并且您不想使用内置的 sum 函数)。所以你写这个函数:

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)

然后,您可以使用以下功能:

>>> multiply(1,2,3)
6

or

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

名称*args**kwargs**kw完全是约定俗成的。它使我们更容易阅读彼此的代码

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

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

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