题 **(双星/星号)和*(星号/星号)对参数有什么作用?


在以下方法定义中,有什么用 * 和 ** 做 param2

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

1579
2017-08-31 15:04


起源


也可以看看 stackoverflow.com/questions/6967632/... - Aaron Hall♦
有关: 为什么使用packed * args / ** kwargs而不是传递list / dict? - Steven Vascellaro


答案:


*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中可以使用 *l 在作业的左侧(扩展的可迭代解包),虽然在这种情况下它给出了一个列表而不是一个元组:

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个位置参数,之后的所有内容 * 只能作为关键字参数传递。


1555
2017-08-31 15:17



[6]的输出顺序相反。名字一岁27岁 - thanos.a
@ thanos.a Python dicts,在语义上用于关键字参数传递,是任意排序的。但是,在Python 3.6中,关键字参数可以保证记住插入顺序。 “元素的顺序 **kwargs 现在对应于关键字参数传递给函数的顺序。“ - docs.python.org/3/whatsnew/3.6.html 实际上,CPython 3.6中的所有dicts都会记住插入顺序,但这是现在的实现细节,用户不应该依赖它。 - Aaron Hall♦
“该 **kwargs 会给你所有关键字参数,除了那些与形式参数相对应的关键字参数作为字典。“我是否正确理解正式参数是对关键字参数的补充,同时对函数进行所有输入? - Post169
非常精确,干净,易于理解。我感谢您注意到它是一个“解包操作符”,因此我可以区别于C中的引用传递+1 - bballdave025


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

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'

451
2017-08-31 15:47



你应该指出,那里的钥匙 mydict 必须准确命名为参数 foo。否则会抛出一个 typeError。 - winklerrr
这不回答这个问题。在这种格式中,它应该是一个评论。 - styrofoam fly
@styrofoamfly看来这样的代码块不能放在评论中。 - MeadowMuffins
@MeadowMuffins所以我们有一个冗长的文字,这不是一个答案...... - styrofoam fly
@styrofoamfly看到这个问题后,值得了解。尽管违反了SO的规则,但它应该更好地成为最高投票答案的附录。 - MeadowMuffins


单*表示可以有任意数量的额外位置参数。 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}

128
2017-08-31 15:20





是什么 ** (双星)和 * (明星)为参数做

他们允许 要定义接受的函数 并为 用户通过 任意数量的论点,位置(*)和关键字(**)。

定义功能

*args 允许任意数量的可选位置参数(参数),这些参数将分配给名为的元组 args

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

您可以(并且应该)选择任何适当的名称,但如果参数的意图是非特定语义, 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)

另一个例子,我们可以使用dict扩展 str.format

>>> 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 (通常说“star-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

我们也可以使用我们刚刚提供的另一个函数来调用它 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 允许我们这样做,我们减少代码行数,提高可读性和可维护性,并在程序中为逻辑提供唯一的规范位置。如果我们需要改变这个结构的任何部分,我们有一个地方可以进行每次更改。


107
2017-10-14 16:34





让我们首先了解什么是位置参数和关键字参数。 下面是一个函数定义的例子 位置参数。

def test(a,b,c):
     print(a)
     print(b)
     print(c)

test(1,2,3)
#output:
1
2
3

所以这是一个带位置参数的函数定义。 您也可以使用关键字/命名参数调用它:

def test(a,b,c):
     print(a)
     print(b)
     print(c)

test(a=1,b=2,c=3)
#output:
1
2
3

现在让我们研究一下函数定义的例子 关键字参数

def test(a=0,b=0,c=0):
     print(a)
     print(b)
     print(c)
     print('-------------------------')

test(a=1,b=2,c=3)
#output :
1
2
3
-------------------------

您也可以使用位置参数调用此函数:

def test(a=0,b=0,c=0):
    print(a)
    print(b)
    print(c)
    print('-------------------------')

test(1,2,3)
# output :
1
2
3
---------------------------------

所以我们现在知道具有位置和关键字参数的函数定义。

现在让我们研究'*'运算符和'**'运算符。

请注意,这些运营商可以在两个方面使用:

一个) 功能调用

b) 功能定义

使用'*'运算符和'**'运算符 功能调用。 

让我们直接举一个例子然后讨论它。

def sum(a,b):  #receive args from function calls as sum(1,2) or sum(a=1,b=2)
    print(a+b)

my_tuple = (1,2)
my_list = [1,2]
my_dict = {'a':1,'b':2}

# Let us unpack data structure of list or tuple or dict into arguments with help of '*' operator
sum(*my_tuple)   # becomes same as sum(1,2) after unpacking my_tuple with '*'
sum(*my_list)    # becomes same as sum(1,2) after unpacking my_list with  '*'
sum(**my_dict)   # becomes same as sum(a=1,b=2) after unpacking by '**' 

# output is 3 in all three calls to sum function.

所以记住

当a中使用'*'或'**'运算符时 功能调用  -

'*'运算符将数据结构(如列表或元组)解包为函数定义所需的参数。

'**'运算符将字典解包为函数定义所需的参数。

现在让我们研究一下'*'运算符的用法 功能定义。 例:

def sum(*args): #pack the received positional args into data structure of tuple. after applying '*' - def sum((1,2,3,4))
    sum = 0
    for a in args:
        sum+=a
    print(sum)

sum(1,2,3,4)  #positional args sent to function sum
#output:
10

在功能上 定义 '*'运算符将接收的参数打包到元组中。

现在让我们看一下函数定义中使用的'**'的示例:

def sum(**args): #pack keyword args into datastructure of dict after applying '**' - def sum({a:1,b:2,c:3,d:4})
    sum=0
    for k,v in args.items():
        sum+=v
    print(sum)

sum(a=1,b=2,c=3,d=4) #positional args sent to function sum

在功能上 定义 '**'运算符将接收的参数打包到字典中。

所以请记住:

在一个 功能调用 '*' 解包 元组的数据结构或列表到函数定义要接收的位置或关键字参数。

在一个 功能调用 '**' 解包 字典的数据结构为函数定义接收的位置或关键字参数。

在一个 功能定义 '*'  元组的位置参数。

在一个 功能定义 '**'  关键字参数进入字典。


37
2018-01-20 11:40





* 和 ** 在函数参数列表中有特殊用法。 * 意味着参数是一个列表和 ** 意味着这个论点 是一本字典。这允许函数采用任意数量的 参数


20
2017-09-11 04:33





从Python文档:

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

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


11
2017-08-31 15:07





我想举一个其他人没有提到过的例子

*也可以打开包装 发电机

Python3文档中的一个示例

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 args,并返回一个生成器。

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

7
2017-11-08 16:50





虽然使用星形/啪啪声操作员 扩大 在Python 3中,我喜欢下表,因为它与这些运算符的使用有关 有功能。 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的 回答 但我觉得它很有帮助。


7
2017-11-30 18:28





在Python 3.5中,您也可以使用此语法 listdicttuple,和 set 显示(有时也称为文字)。看到 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链接。)


6
2017-12-08 21:38



我不确定这是否违反了“只有一种方法”。没有其他方法可以从多个迭代中初始化列表/元组 - 您当前需要将它们链接到单个迭代中,这并不总是很方便。你可以阅读关于理性的内容 PEP-0448。此外,这不是python3.x功能,它是一个python3.5 +功能:-)。 - mgilson
@mgilson,这可以解释为什么以前没有提到过。 - leewz


除了函数调用之外,* args和** kwargs在类层次结构中也很有用,也避免了编写 __init__ Python中的方法。在类似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')

完整的代码是 这里


4
2017-08-16 04:23



1.基本上 在里面 是一种方法,所以(在这种情况下)它并没有真正不同。 2.使用#作为注释,而不是“”“,它只标记文字字符串.3。使用super应该是首选方式,特别是对于具有多级继承的示例。 - 0xc0de