上下文

python 3.x使用打开包装**与字符串格式一起使用

与字符串格式一起使用

除了本主题中的答案之外，还有一个其他地方没有提到的细节。这扩展了Brad Solomon的答案

使用python str.format时，使用**解包也很有用。

这有点类似于使用python f-string f-string所做的操作，但增加了声明dict以保存变量的开销（f-string不需要dict）。

快速示例

  ## init vars
  ddvars = dict()
  ddcalc = dict()
  pass
  ddvars['fname']     = 'Huomer'
  ddvars['lname']     = 'Huimpson'
  ddvars['motto']     = 'I love donuts!'
  ddvars['age']       = 33
  pass
  ddcalc['ydiff']     = 5
  ddcalc['ycalc']     = ddvars['age'] + ddcalc['ydiff']
  pass
  vdemo = []

  ## ********************
  ## single unpack supported in py 2.7
  vdemo.append('''
  Hello {fname} {lname}!

  Today you are {age} years old!

  We love your motto "{motto}" and we agree with you!
  '''.format(**ddvars)) 
  pass

  ## ********************
  ## multiple unpack supported in py 3.x
  vdemo.append('''
  Hello {fname} {lname}!

  In {ydiff} years you will be {ycalc} years old!
  '''.format(**ddvars,**ddcalc)) 
  pass

  ## ********************
  print(vdemo[-1])

**（双星）和*（星）对参数有什么作用？

它们允许定义函数以接受，并允许用户传递任意数量的参数、位置（*）和关键字（**）。

定义函数

*args允许任意数量的可选位置参数（参数），这些参数将分配给名为args的元组。

**kwargs允许任意数量的可选关键字参数（参数），这些参数将在名为kwargs的dict中。

您可以（也应该）选择任何合适的名称，但如果目的是让参数具有非特定语义，args和kwargs是标准名称。

扩展，传递任意数量的参数

您还可以使用*args和**kwargs分别从列表（或任何可迭代的）和dicts（或任何映射）传递参数。

接收参数的函数不必知道它们正在扩展。

例如，Python 2的xrange不明确期望*args，但因为它接受3个整数作为参数：

>>> x = xrange(3) # create our *args - an iterable of 3 integers
>>> xrange(*x)    # expand here
xrange(0, 2, 2)

作为另一个例子，我们可以在str.format中使用dict扩展：

>>> foo = 'FOO'
>>> bar = 'BAR'
>>> 'this is foo, {foo} and bar, {bar}'.format(**locals())
'this is foo, FOO and bar, BAR'

Python 3中的新功能：使用仅关键字的参数定义函数

您可以在*args之后使用仅关键字的参数，例如，在这里，kwarg2必须作为关键字参数给出，而不是位置：

def foo(arg, kwarg=None, *args, kwarg2=None, **kwargs): 
    return arg, kwarg, args, kwarg2, kwargs

用法：

>>> foo(1,2,3,4,5,kwarg2='kwarg2', bar='bar', baz='baz')
(1, 2, (3, 4, 5), 'kwarg2', {'bar': 'bar', 'baz': 'baz'})

此外，*可以单独使用，表示后面只有关键字参数，而不允许无限制的位置参数。

def foo(arg, kwarg=None, *, kwarg2=None, **kwargs): 
    return arg, kwarg, kwarg2, kwargs

这里，kwarg2也必须是显式命名的关键字参数：

>>> foo(1,2,kwarg2='kwarg2', foo='foo', bar='bar')
(1, 2, 'kwarg2', {'foo': 'foo', 'bar': 'bar'})

而且我们不能再接受无限制的位置参数，因为我们没有*args*：

>>> foo(1,2,3,4,5, kwarg2='kwarg2', foo='foo', bar='bar')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() takes from 1 to 2 positional arguments 
    but 5 positional arguments (and 1 keyword-only argument) were given

同样，更简单地说，这里我们要求kwarg按名称而不是按位置给出：

def bar(*, kwarg=None): 
    return kwarg

在这个例子中，我们看到，如果我们试图在位置上传递kwarg，我们会得到一个错误：

>>> bar('kwarg')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: bar() takes 0 positional arguments but 1 was given

我们必须将kwarg参数作为关键字参数显式传递。

>>> bar(kwarg='kwarg')
'kwarg'

Python 2兼容演示

*args（通常称为“星号args”）和**kwargs（星号可以通过表示“kwargs”来暗示，但要明确表示为“双星kwargs）是Python使用*和**表示法的常见习惯用法。这些特定的变量名是不需要的（例如，您可以使用*foos和**bars），但背离惯例可能会激怒您的Python程序员。

当我们不知道函数将接收什么或传递多少参数时，我们通常会使用这些参数，有时甚至在单独命名每个变量时，也会变得非常混乱和冗余（但这是一种通常显式优于隐式的情况）。

示例1

以下函数描述如何使用它们，并演示其行为。请注意，命名的b参数将被前面的第二个位置参数使用：

def foo(a, b=10, *args, **kwargs):
    '''
    this function takes required argument a, not required keyword argument b
    and any number of unknown positional arguments and keyword arguments after
    '''
    print('a is a required argument, and its value is {0}'.format(a))
    print('b not required, its default value is 10, actual value: {0}'.format(b))
    # we can inspect the unknown arguments we were passed:
    #  - args:
    print('args is of type {0} and length {1}'.format(type(args), len(args)))
    for arg in args:
        print('unknown arg: {0}'.format(arg))
    #  - kwargs:
    print('kwargs is of type {0} and length {1}'.format(type(kwargs),
                                                        len(kwargs)))
    for kw, arg in kwargs.items():
        print('unknown kwarg - kw: {0}, arg: {1}'.format(kw, arg))
    # But we don't have to know anything about them 
    # to pass them to other functions.
    print('Args or kwargs can be passed without knowing what they are.')
    # max can take two or more positional args: max(a, b, c...)
    print('e.g. max(a, b, *args) \n{0}'.format(
      max(a, b, *args))) 
    kweg = 'dict({0})'.format( # named args same as unknown kwargs
      ', '.join('{k}={v}'.format(k=k, v=v) 
                             for k, v in sorted(kwargs.items())))
    print('e.g. dict(**kwargs) (same as {kweg}) returns: \n{0}'.format(
      dict(**kwargs), kweg=kweg))

我们可以通过help（foo）查看函数签名的在线帮助，它告诉我们

foo(a, b=10, *args, **kwargs)

让我们用foo（1，2，3，4，e＝5，f＝6，g＝7）调用这个函数

其打印：

a is a required argument, and its value is 1
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 2
unknown arg: 3
unknown arg: 4
kwargs is of type <type 'dict'> and length 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: g, arg: 7
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args) 
4
e.g. dict(**kwargs) (same as dict(e=5, f=6, g=7)) returns: 
{'e': 5, 'g': 7, 'f': 6}

示例2

我们也可以使用另一个函数来调用它，我们只需在其中提供一个：

def bar(a):
    b, c, d, e, f = 2, 3, 4, 5, 6
    # dumping every local variable into foo as a keyword argument 
    # by expanding the locals dict:
    foo(**locals()) 

条形图（100）打印：

a is a required argument, and its value is 100
b not required, its default value is 10, actual value: 2
args is of type <type 'tuple'> and length 0
kwargs is of type <type 'dict'> and length 4
unknown kwarg - kw: c, arg: 3
unknown kwarg - kw: e, arg: 5
unknown kwarg - kw: d, arg: 4
unknown kwarg - kw: f, arg: 6
Args or kwargs can be passed without knowing what they are.
e.g. max(a, b, *args) 
100
e.g. dict(**kwargs) (same as dict(c=3, d=4, e=5, f=6)) returns: 
{'c': 3, 'e': 5, 'd': 4, 'f': 6}

示例3：装饰器中的实际用法

好吧，也许我们还没有看到实用程序。因此，假设您在区分代码之前和/或之后有多个冗余代码的函数。以下命名函数只是用于说明目的的伪代码。

def foo(a, b, c, d=0, e=100):
    # imagine this is much more code than a simple function call
    preprocess() 
    differentiating_process_foo(a,b,c,d,e)
    # imagine this is much more code than a simple function call
    postprocess()

def bar(a, b, c=None, d=0, e=100, f=None):
    preprocess()
    differentiating_process_bar(a,b,c,d,e,f)
    postprocess()

def baz(a, b, c, d, e, f):
    ... and so on

我们可能能够以不同的方式处理这一点，但我们肯定可以使用装饰器提取冗余，因此下面的示例演示了*args和**kwargs是如何非常有用的：

def decorator(function):
    '''function to wrap other functions with a pre- and postprocess'''
    @functools.wraps(function) # applies module, name, and docstring to wrapper
    def wrapper(*args, **kwargs):
        # again, imagine this is complicated, but we only write it once!
        preprocess()
        function(*args, **kwargs)
        postprocess()
    return wrapper

现在，每个包装的函数都可以写得更简洁，因为我们已经考虑了冗余：

@decorator
def foo(a, b, c, d=0, e=100):
    differentiating_process_foo(a,b,c,d,e)

@decorator
def bar(a, b, c=None, d=0, e=100, f=None):
    differentiating_process_bar(a,b,c,d,e,f)

@decorator
def baz(a, b, c=None, d=0, e=100, f=None, g=None):
    differentiating_process_baz(a,b,c,d,e,f, g)

@decorator
def quux(a, b, c=None, d=0, e=100, f=None, g=None, h=None):
    differentiating_process_quux(a,b,c,d,e,f,g,h)

通过分解我们的代码（*args和**kwargs允许我们这样做），我们减少了代码行，提高了可读性和可维护性，并为程序中的逻辑提供了唯一的规范位置。如果我们需要改变这个结构的任何一部分，我们有一个地方可以做每一个改变。

TL；博士

以下是python编程中*和**的6种不同用例：

要使用*args:def foo（*args）：pass接受任意数量的位置参数，这里foo接受任意数目的位置参数，即，以下调用是有效的foo（1）、foo（2，'bar'）若要使用**kwargs:def foo（**kwargs）：pass接受任意数量的关键字参数，此处“foo”接受任意数量关键字参数，即，以下调用是有效的foo（name='Tom'）、foo（name='Tom'，age=33）要使用*args，**kwargs:def foo（*args、**kwargs）：pass接受任意数量的位置和关键字参数，这里foo接受任意数目的位置和关键词参数，即，以下调用是有效的foo（1，name='Tom'）、foo（2，'bar'，name='Tom'，age=33）要使用*：def foo（pos1，pos2，*，kwarg1）：pass强制只接受关键字参数，这里*表示foo只接受pos2之后的关键字参数，因此foo（1，2，3）引发TypeError，但foo（1,2，kwarg1=3）正常。为了表示对更多位置参数不再感兴趣，请使用*_（注意：这只是一个约定）：def foo（bar，baz，*_）：pass表示（按照约定）foo在工作中只使用bar和baz参数，而忽略其他参数。为了表示对更多关键字参数不再感兴趣，请使用**_（注意：这只是一个约定）：def foo（bar，baz，**_）：pass意味着（按照约定）foo在工作中只使用bar和baz参数，而忽略其他参数。

好处：从python 3.8开始，可以在函数定义中使用/来强制执行仅限位置的参数。在以下示例中，参数a和b仅是位置性的，而c或d可以是位置性或关键字，e或f必须是关键字：

def f(a, b, /, c, d, *, e, f):
    pass

好处2：对同一个问题的回答也带来了一个新的视角，它分享了*和**在函数调用、函数签名、for循环等方面的含义。

*args是一个特殊的参数，可以将0个或多个（位置）参数作为元组。**kwargs是一个特殊的参数，可以将0个或多个（关键字）参数作为字典。

*在Python中，有两种参数位置参数和关键字参数：

*参数：

例如，*args可以采用0个或多个参数作为元组，如下所示：

           ↓
def test(*args):
    print(args)

test() # Here
test(1, 2, 3, 4) # Here
test((1, 2, 3, 4)) # Here
test(*(1, 2, 3, 4)) # Here

输出：

()
(1, 2, 3, 4)
((1, 2, 3, 4),)
(1, 2, 3, 4)

并且，当打印*参数时，将打印4个数字，不带括号和逗号：

def test(*args):
    print(*args) # Here
 
test(1, 2, 3, 4)

输出：

1 2 3 4

并且，args具有元组类型：

def test(*args):
    print(type(args)) # Here
 
test(1, 2, 3, 4)

输出：

<class 'tuple'>

但是，*参数没有类型：

def test(*args):
    print(type(*args)) # Here
 
test(1, 2, 3, 4)

输出（错误）：

TypeError:type（）需要1或3个参数

并且，正常参数可以放在*args之前，如下所示：

          ↓     ↓
def test(num1, num2, *args):
    print(num1, num2, args)
    
test(1, 2, 3, 4)

输出：

1 2 (3, 4)

但是，**kwargs不能放在*args之前，如下所示：

             ↓     
def test(**kwargs, *args):
    print(kwargs, args)
    
test(num1=1, num2=2, 3, 4)

输出（错误）：

语法错误：无效语法

而且，正常参数不能放在*args之后，如下所示：

                 ↓     ↓
def test(*args, num1, num2):
    print(args, num1, num2)
    
test(1, 2, 3, 4)

输出（错误）：

TypeError:test（）缺少2个必需的仅关键字参数：“num1”和“num2”

但是，如果正常参数具有默认值，则可以将它们放在*args之后，如下所示：

                      ↓         ↓
def test(*args, num1=100, num2=None):
    print(args, num1, num2)
    
test(1, 2, num1=3, num2=4)

输出：

(1, 2) 3 4

此外，**kwargs可以放在*args之后，如下所示：

                    ↓
def test(*args, **kwargs):
    print(args, kwargs)
    
test(1, 2, num1=3, num2=4)

输出：

(1, 2) {'num1': 3, 'num2': 4}

**克瓦格斯：

例如，**kwargs可以使用0个或多个参数作为字典，如下所示：

             ↓
def test(**kwargs):
    print(kwargs)

test() # Here
test(name="John", age=27) # Here
test(**{"name": "John", "age": 27}) # Here

输出：

{}
{'name': 'John', 'age': 27}
{'name': 'John', 'age': 27}

并且，当打印*kwargs时，将打印两个键：

def test(**kwargs):
    print(*kwargs) # Here
 
test(name="John", age=27)

输出：

name age

并且，kwargs具有dict类型：

def test(**kwargs):
    print(type(kwargs)) # Here
 
test(name="John", age=27)

输出：

<class 'dict'>

但是，*kwargs和**kwargs没有类型：

def test(**kwargs):
    print(type(*kwargs)) # Here
 
test(name="John", age=27)

def test(**kwargs):
    print(type(**kwargs)) # Here
 
test(name="John", age=27)

输出（错误）：

TypeError:type（）需要1或3个参数

并且，正常参数可以放在**kwargs之前，如下所示：

          ↓     ↓
def test(num1, num2, **kwargs):
    print(num1, num2, kwargs)

test(1, 2, name="John", age=27)

输出：

1 2 {'name': 'John', 'age': 27}

此外，*args可以放在**kwargs之前，如下所示：

           ↓
def test(*args, **kwargs):
    print(args, kwargs)

test(1, 2, name="John", age=27)

输出：

(1, 2) {'name': 'John', 'age': 27}

并且，正常参数和*args不能放在**kwargs之后，如下所示：

                    ↓     ↓
def test(**kwargs, num1, num2):
    print(kwargs, num1, num2)

test(name="John", age=27, 1, 2)

                     ↓
def test(**kwargs, *args):
    print(kwargs, args)

test(name="John", age=27, 1, 2)

输出（错误）：

语法错误：无效语法

对于*args和**kwargs：

实际上，您可以为*args和**kwargs使用其他名称，如下所示*args和**kwargs通常使用：

            ↓        ↓
def test(*banana, **orange):
    print(banana, orange)
    
test(1, 2, num1=3, num2=4)

输出：

(1, 2) {'num1': 3, 'num2': 4}

还值得注意的是，在调用函数时也可以使用*和**。这是一个快捷方式，允许您直接使用列表/元组或字典将多个参数传递给函数。例如，如果您具有以下功能：

def foo(x,y,z):
    print("x=" + str(x))
    print("y=" + str(y))
    print("z=" + str(z))

您可以执行以下操作：

>>> mylist = [1,2,3]
>>> foo(*mylist)
x=1
y=2
z=3

>>> mydict = {'x':1,'y':2,'z':3}
>>> foo(**mydict)
x=1
y=2
z=3

>>> mytuple = (1, 2, 3)
>>> foo(*mytuple)
x=1
y=2
z=3

注意：mydict中的键必须与函数foo的参数完全相同。否则将抛出TypeError：

>>> mydict = {'x':1,'y':2,'z':3,'badnews':9}
>>> foo(**mydict)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: foo() got an unexpected keyword argument 'badnews'

单*表示可以有任意数量的额外位置参数。foo（）可以像foo（1,2,3,4,5）一样调用。在foo（）的主体中，param2是一个包含2-5的序列。

双**表示可以有任意数量的额外命名参数。bar（）可以像bar（1，a=2，b=3）一样调用。在bar（）的主体中，param2是一个字典，其中包含｛‘a‘：2，‘b‘：3｝

使用以下代码：

def foo(param1, *param2):
    print(param1)
    print(param2)

def bar(param1, **param2):
    print(param1)
    print(param2)

foo(1,2,3,4,5)
bar(1,a=2,b=3)

输出为

1
(2, 3, 4, 5)
1
{'a': 2, 'b': 3}