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

在以下方法定义中, ***param2有何作用?

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

答案

*args**kwargs是一个常见的习惯用法,它允许对函数使用任意数量的参数,如在 Python 文档中有关定义函数的小节中所述。

*args将为您提供所有函数参数为元组

def foo(*args):
    for a in args:
        print(a)        

foo(1)
# 1

foo(1,2,3)
# 1
# 2
# 3

**kwargs将为您提供所有关键字参数,但那些与字典形式参数相对应的参数除外。

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

bar(name='one', age=27)
# age 27
# name one

这两个习惯用法都可以与普通参数混合使用,以允许使用一组固定参数和一些可变参数:

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

也可以以其他方式使用此方法:

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

obj = {'b':10, 'c':'lee'}

foo(100,**obj)
# 100 10 lee

*l惯用语的另一种用法是在调用函数时解压缩参数列表

def foo(bar, lee):
    print(bar, lee)

l = [1,2]

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

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

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}

** (双星)和* (星)对参数有什么作用

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

定义功能

*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 (通常称为 “star-args”)和**kwargs (可以通过说 “kwargs” 来暗示星号,但对于 “double-star 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可以执行代码,我们减少了代码行,提高了可读性和可维护性,并且在程序中的逻辑上拥有唯一的规范位置。如果需要更改此结构的任何部分,则可以在一个位置进行每次更改。

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

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

因此,我们现在知道带有位置参数以及关键字参数的函数定义。

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

请注意,这些运算符可以在两个区域中使用:

a) 函数调用

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.

所以记住

函数调用中使用 “*” 或 “**” 运算符时 -

'*' 运算符将列表或元组等数据结构解压缩为函数定义所需的参数。

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

现在让我们研究函数定义中使用 '*' 运算符。例:

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

在函数定义中 ,“**” 运算符将接收到的参数打包到字典中。

因此请记住:

函数调用中 ,“*” 将元组或列表的数据结构解压缩为位置或关键字参数,以供函数定义接收。

函数调用中 ,“**” 将字典的数据结构解压缩为位置或关键字参数,以供函数定义接收。

函数定义中 ,“*” 位置参数打包到元组中。

函数定义中 ,“**” 关键字参数打包到字典中。

该表非常适合在函数构造和函数调用中使用***

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 的答案,但我发现它很有帮助。

相关:在 Python 3 中已扩展了 star / splat 运算符的用法

***在函数参数列表中有特殊用法。 *表示参数是列表, **表示参数是字典。这允许函数接受任意数量的参数

对于那些通过榜样学习的人!

  1. *的目的是使您能够定义一个函数,该函数可以接受以列表形式提供的任意数量的参数(例如f(*myList) )。
  2. **的目的是通过提供字典(例如f(**{'x' : 1, 'y' : 2}) )使您能够输入函数的参数。

让我们通过定义一个函数来表明这一点,该函数接受两个普通变量xy ,并且可以接受更多参数作为myArgs ,并且可以接受更多参数作为myKW 。稍后,我们将展示如何使用myArgDict来输入y

def f(x, y, *myArgs, **myKW):
    print("# x      = {}".format(x))
    print("# y      = {}".format(y))
    print("# myArgs = {}".format(myArgs))
    print("# myKW   = {}".format(myKW))
    print("# ----------------------------------------------------------------------")

# Define a list for demonstration purposes
myList    = ["Left", "Right", "Up", "Down"]
# Define a dictionary for demonstration purposes
myDict    = {"Wubba": "lubba", "Dub": "dub"}
# Define a dictionary to feed y
myArgDict = {'y': "Why?", 'y0': "Why not?", "q": "Here is a cue!"}

# The 1st elem of myList feeds y
f("myEx", *myList, **myDict)
# x      = myEx
# y      = Left
# myArgs = ('Right', 'Up', 'Down')
# myKW   = {'Wubba': 'lubba', 'Dub': 'dub'}
# ----------------------------------------------------------------------

# y is matched and fed first
# The rest of myArgDict becomes additional arguments feeding myKW
f("myEx", **myArgDict)
# x      = myEx
# y      = Why?
# myArgs = ()
# myKW   = {'y0': 'Why not?', 'q': 'Here is a cue!'}
# ----------------------------------------------------------------------

# The rest of myArgDict becomes additional arguments feeding myArgs
f("myEx", *myArgDict)
# x      = myEx
# y      = y
# myArgs = ('y0', 'q')
# myKW   = {}
# ----------------------------------------------------------------------

# Feed extra arguments manually and append even more from my list
f("myEx", 4, 42, 420, *myList, *myDict, **myDict)
# x      = myEx
# y      = 4
# myArgs = (42, 420, 'Left', 'Right', 'Up', 'Down', 'Wubba', 'Dub')
# myKW   = {'Wubba': 'lubba', 'Dub': 'dub'}
# ----------------------------------------------------------------------

# Without the stars, the entire provided list and dict become x, and y:
f(myList, myDict)
# x      = ['Left', 'Right', 'Up', 'Down']
# y      = {'Wubba': 'lubba', 'Dub': 'dub'}
# myArgs = ()
# myKW   = {}
# ----------------------------------------------------------------------

注意事项

  1. **专为字典保留。
  2. 非可选参数分配首先发生。
  3. 您不能两次使用非可选参数。
  4. 如果适用, **必须始终在*之后。

从 Python 文档中:

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

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

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

* 也可以打开发电机包装

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()接收多个可初始化的参数,并返回一个生成器。

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