python星号元组 - python星号表达式




**(双星/星号)和*(星号/星号)对参数做什么? (10)

** (双星)和* (星星)对参数做什么?

它们允许函数被定义为接受并且让用户传递任意数量的参数,位置( * )和关键字( ** )。

定义函数

*args允许任意数量的可选位置参数(参数),它们将被分配给一个名为args的元组。

**kwargs允许任意数量的可选关键字参数(参数),这些参数将在一个名为kwargs的字典中。

您可以(也应该)选择任何适当的名称,但如果参数的意图是非特定语义的,则argskwargs是标准名称。

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

您也可以使用*args**kwargs分别从列表(或任何可迭代的)和字符串(或任何映射)传入参数。

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

例如,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之后有关键字 *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 (通常称为“星形参数”)和**kwargs (星号可以用“kwargs”来表示,但用“double-star kwargs”来表示)是使用***符号的Python常见成语。 这些特定的变量名称不是必需的(例如,您可以使用*foos**bars ),但与惯例背离可能会让您的Python编码人员*foos

当我们不知道我们的函数将会接收什么或者我们可能传递多少个参数时,我们通常会使用这些参数,有时甚至当单独命名每个变量会变得非常混乱和冗余(但这通常是明确的比隐含更好)。

例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

我们也可以使用另一个函数来调用它,我们只提供a函数:

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()) 

bar(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允许我们执行这些代码,我们减少了代码行,提高了可读性和可维护性,并为我们的程序中的逻辑提供了唯一的规范位置。 如果我们需要改变这个结构的任何部分,我们就有一个地方可以做出每一个改变。

在下面的方法定义中, ***param2做了什么?

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

* args = * aList =列表中的所有元素

** args = ** aDict =字典中的所有项目


*args**kwargs是一个常见的习惯用法,它允许任意数量的函数参数,如本节更多关于定义 Python文档中的函数所述。

*args会给你所有的函数参数作为元组

In [1]: def foo(*args):
   ...:     for a in args:
   ...:         print a
   ...:         
   ...:         

In [2]: foo(1)
1


In [4]: foo(1,2,3)
1
2
3

**kwargs会给你所有的关键字参数,除了那些对应于形式参数的字典。

In [5]: def bar(**kwargs):
   ...:     for a in kwargs:
   ...:         print a, kwargs[a]
   ...:         
   ...:         

In [6]: bar(name='one', age=27)
age 27
name one

这两种习语都可以和普通的参数混合使用,以允许一组固定参数和一些可变参数:

def foo(kind, *args, **kwargs):
   pass

*l成语的另一个用法是在调用函数时解开参数列表

In [9]: def foo(bar, lee):
   ...:     print bar, lee
   ...:     
   ...:     

In [10]: l = [1,2]

In [11]: foo(*l)
1 2

在Python 3中,可以在赋值左侧使用*lExtended Iterable Unpacking ),尽管它在此上下文中提供了一个列表而不是元组:

first, *rest = [1,2,3,4]
first, *l, last = [1,2,3,4]

另外Python 3增加了新的语义(参考PEP 3102 ):

def func(arg1, arg2, arg3, *, kwarg1, kwarg2):
    pass

这样的函数只接受3个位置参数, *之后的所有内容只能作为关键字参数传递。


从Python文档:

如果有更多的位置参数比形式参数槽更多,则会引发TypeError异常,除非使用语法“* identifier”的形式参数存在; 在这种情况下,该形式参数接收包含多余位置参数的元组(或者如果没有多余的位置参数,则为空元组)。

如果任何关键字参数不符合形式参数名称,则会引发TypeError异常,除非使用语法“** identifier”的形式参数存在; 在这种情况下,该形式参数将接收包含多余关键字参数(使用关键字作为关键字并将参数值作为相应值)的字典,如果没有多余的关键字参数,则会接收(新)空字典。


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

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'

在Python 3.5中,您还可以在listdicttupleset显示中使用此语法(有时也称为文字)。 见PEP 488:附加解包概括

>>> (0, *range(1, 4), 5, *range(6, 8))
(0, 1, 2, 3, 5, 6, 7)
>>> [0, *range(1, 4), 5, *range(6, 8)]
[0, 1, 2, 3, 5, 6, 7]
>>> {0, *range(1, 4), 5, *range(6, 8)}
{0, 1, 2, 3, 5, 6, 7}
>>> d = {'one': 1, 'two': 2, 'three': 3}
>>> e = {'six': 6, 'seven': 7}
>>> {'zero': 0, **d, 'five': 5, **e}
{'five': 5, 'seven': 7, 'two': 2, 'one': 1, 'three': 3, 'six': 6, 'zero': 0}

它还允许在单个函数调用中解开多个迭代。

>>> range(*[1, 10], *[2])
range(1, 10, 2)

(感谢mgilson为PEP链接。)


尽管在Python 3中expanded了star / splat运算符的用途,但我喜欢下表,因为它涉及到使用这些运算符和函数 。 可以在函数构造和函数调用中使用splat运算符:

            In function *construction*      In function *call*
=======================================================================
          |  def f(*args):                 |  def f(a, b):
*args     |      for arg in args:          |      return a + b
          |          print(arg)            |  args = (1, 2)
          |  f(1, 2)                       |  f(*args)
----------|--------------------------------|---------------------------
          |  def f(a, b):                  |  def f(a, b):
**kwargs  |      return a + b              |      return a + b
          |  def g(**kwargs):              |  kwargs = dict(a=1, b=2)
          |      return f(**kwargs)        |  f(**kwargs)
          |  g(a=1, b=2)                   |
-----------------------------------------------------------------------

这真的只是用来总结Lorin Hochstein的answer但我觉得这很有帮助。


我想举一个别人没有提到的例子

*还可以解压一个发电机

Python3 Document的一个例子

x = [1, 2, 3]
y = [4, 5, 6]

unzip_x, unzip_y = zip(*zip(x, y))

unzip_x将会是[1,2,3],unzip_y将会是[4,5,6]

zip()接收多个iretable参数,并返回一个生成器。

zip(*zip(x,y)) -> zip((1, 4), (2, 5), (3, 6))

这个例子可以帮助你一次记住*args**kwargs ,甚至super和继承。

class base(object):
    def __init__(self, base_param):
        self.base_param = base_param


class child1(base): # inherited from base class
    def __init__(self, child_param, *args) # *args for non-keyword args
        self.child_param = child_param
        super(child1, self).__init__(*args) # call __init__ of the base class and initialize it with a NON-KEYWORD arg

class child2(base):
    def __init__(self, child_param, **kwargs):
        self.child_param = child_param
        super(child2, self).__init__(**kwargs) # call __init__ of the base class and initialize it with a KEYWORD arg

c1 = child1(1,0)
c2 = child2(1,base_param=0)
print c1.base_param # 0
print c1.child_param # 1
print c2.base_param # 0
print c2.child_param # 1

除了函数调用之外,* args和** kwargs在类层次结构中很有用,也避免了必须在Python中编写__init__方法。 类似的用法可以在像Django代码这样的框架中看到。

例如,

def __init__(self, *args, **kwargs):
    for attribute_name, value in zip(self._expected_attributes, args):
        setattr(self, attribute_name, value)
        if kwargs.has_key(attribute_name):
            kwargs.pop(attribute_name)

    for attribute_name in kwargs.viewkeys():
        setattr(self, attribute_name, kwargs[attribute_name])

然后可以是子类

class RetailItem(Item):
    _expected_attributes = Item._expected_attributes + ['name', 'price', 'category', 'country_of_origin']

class FoodItem(RetailItem):
    _expected_attributes = RetailItem._expected_attributes +  ['expiry_date']

该子类然后被实例化为

food_item = FoodItem(name = 'Jam', 
                     price = 12.0, 
                     category = 'Foods', 
                     country_of_origin = 'US', 
                     expiry_date = datetime.datetime.now())

此外,具有仅对该子类实例有意义的新属性的子类可以调用Base类__init__以卸载属性设置。 这是通过* args和** kwargs完成的。 主要使用kwargs,以便使用命名参数来读取代码。 例如,

class ElectronicAccessories(RetailItem):
    _expected_attributes = RetailItem._expected_attributes +  ['specifications']
    # Depend on args and kwargs to populate the data as needed.
    def __init__(self, specifications = None, *args, **kwargs):
        self.specifications = specifications  # Rest of attributes will make sense to parent class.
        super(ElectronicAccessories, self).__init__(*args, **kwargs)

这可以作为

usb_key = ElectronicAccessories(name = 'Sandisk', 
                                price = '$6.00', 
                                category = 'Electronics',
                                country_of_origin = 'CN',
                                specifications = '4GB USB 2.0/USB 3.0')

完整的代码在here





kwargs