如何在Python中使用可变长度参数(*args, **kwargs)?

商业

下面的函数参数可能是最常见的,当你看Python代码时,你会问:”这是什么?

  • *args
  • **kwargs

任何数量的参数(可变长度的参数)都可以通过在函数定义中的参数后面加上星号来指定,如下所示

  • *
  • **

*args,**kwargs这些名字经常被用作惯例。然而,只要*和**在开头,其他的名字也可以接受。下面的示例代码使用了*args,**kwargs的名字。

下文将详细介绍。

  • *args:接受多个参数为一个元组
  • **kwargs:接受多个关键字参数作为一个字典

*args: 接受多个参数为一个元组

可以通过用*定义参数来指定任意数量的参数,如*args。

def my_sum(*args):
    return sum(args)

print(my_sum(1, 2, 3, 4))
# 10

print(my_sum(1, 2, 3, 4, 5, 6, 7, 8))
# 36

多个参数在函数中被作为一个元组接收。在这个例子中,sum()函数被传递一个元组来计算总和。

def my_sum2(*args):
    print('args: ', args)
    print('type: ', type(args))
    print('sum : ', sum(args))

my_sum2(1, 2, 3, 4)
# args:  (1, 2, 3, 4)
# type:  <class 'tuple'>
# sum :  10

它也可以与位置参数相结合。

位置参数后面(右边)指定的值作为一个元组传递给args。如果只有一个位置参数,它就是一个空元组。

def func_args(arg1, arg2, *args):
    print('arg1: ', arg1)
    print('arg2: ', arg2)
    print('args: ', args)

func_args(0, 1, 2, 3, 4)
# arg1:  0
# arg2:  1
# args:  (2, 3, 4)

func_args(0, 1)
# arg1:  0
# arg2:  1
# args:  ()

标有*的参数可以先被定义。然而,在这种情况下,在*args之后定义的参数必须以关键字的形式指定。顺便说一下,关键字的格式是 “参数名=值 “的形式。

最后一个值不会自动传递给位置参数。因此,如果它没有被指定为一个关键字参数,将导致TypeError错误。

def func_args2(arg1, *args, arg2):
    print('arg1: ', arg1)
    print('arg2: ', arg2)
    print('args: ', args)

# func_args2(0, 1, 2, 3, 4)
# TypeError: func_args2() missing 1 required keyword-only argument: 'arg2'

func_args2(0, 1, 2, 3, arg2=4)
# arg1:  0
# arg2:  4
# args:  (1, 2, 3)

如果只指定了*参数,后面的参数必须总是被指定为关键字参数。(keyword-only argument)

def func_args_kw_only(arg1, *, arg2):
    print('arg1: ', arg1)
    print('arg2: ', arg2)

# func_args_kw_only(100, 200)
# TypeError: func_args_kw_only() takes 1 positional argument but 2 were given

func_args_kw_only(100, arg2=200)
# arg1:  100
# arg2:  200

**kwargs: 接受多个关键字参数作为一个字典

可以通过用,**定义参数来指定任意数量的关键字参数,如**kwargs。

在这个函数中,参数的名称被作为一个字典接收,其键为key,其值为value。

def func_kwargs(**kwargs):
    print('kwargs: ', kwargs)
    print('type: ', type(kwargs))

func_kwargs(key1=1, key2=2, key3=3)
# kwargs:  {'key1': 1, 'key2': 2, 'key3': 3}
# type:  <class 'dict'>

它也可以与立场论证结合使用。

def func_kwargs_positional(arg1, arg2, **kwargs):
    print('arg1: ', arg1)
    print('arg2: ', arg2)
    print('kwargs: ', kwargs)

func_kwargs_positional(0, 1, key1=1)
# arg1:  0
# arg2:  1
# kwargs:  {'key1': 1}

通过在调用函数时指定带**的字典对象作为参数,可以将其展开并作为相应的参数传递。

d = {'key1': 1, 'key2': 2, 'arg1': 100, 'arg2': 200}

func_kwargs_positional(**d)
# arg1:  100
# arg2:  200
# kwargs:  {'key1': 1, 'key2': 2}

标有**的参数只能在参数的末尾定义。在标有**的参数之后定义另一个参数将导致SyntaxError错误。

# def func_kwargs_error(**kwargs, arg):
#     print(kwargs)

# SyntaxError: invalid syntax