在Python中的代码中,经常会见到args 和 kwargs两个词,前面通常还会加上一个或者两个星号。其实,这只是编程人员约定的变量名字,args 是 arguments 的缩写,表示位置参数;kwargs 是 keyword arguments 的缩写,表示关键字参数。
这其实就是 Python 中可变参数的两种形式,并且 *args 必须放在 **kwargs 的前面(python语法规定:位置参数放在关键字参数的前面)。
一、*args的用法
*args传递一个可变参数列表(类型为元组tuple)给函数实参,这个参数列表的数目未知,甚至长度可以为0。下面这段代码演示了如何使用args:
def test_args(first, *args):
print('Required argument: ', first)
print(type(args))
for v in args:
print ('Optional argument: ', v)
test_args(1, 2, 3, 4)
代码的运行结果,如下所示:
Required argument: 1
<class 'tuple'>
Optional argument: 2
Optional argument: 3
Optional argument: 4
二、**kwargs
**kwargs是将一个可变的关键字参数的字典(类型为字典dict)传给函数实参,参数列表长度可以为0或为其他值。下面这段代码演示了如何使用kwargs:
def test_kwargs(first, *args, **kwargs):
print('Required argument: ', first)
print(type(kwargs))
for v in args:
print ('Optional argument (args): ', v)
for k, v in kwargs.items():
print ('Optional argument %s (kwargs): %s' % (k, v))
test_kwargs(1, 2, 3, 4, k1=5, k2=6)
代码的运行结果,如下所示:
Required argument: 1
<class 'dict'>
Optional argument (args): 2
Optional argument (args): 3
Optional argument (args): 4
Optional argument k2 (kwargs): 6
Optional argument k1 (kwargs): 5
三、打包和解包调用函数参数
args和kwargs不仅可以在函数定义中使用,还可以在函数调用中使用。在函数调用中使用,就相当于pack(打包)和unpack(解包),类似于元组的打包和解包。
下面这段代码演示了使用args来解包调用函数的参数:
def test_args_kwargs(arg1, arg2, arg3):
print("arg1:", arg1)
print("arg2:", arg2)
print("arg3:", arg3)
args = ("two", 3, 5)
test_args_kwargs(*args)
代码的运行结果,如下所示:
arg1: two
arg2: 3
arg3: 5
args和kwargs组合起来可以传入任意的参数,在参数未知的情况下,这是很有效的,加强了函数的可拓展性。
注意:args类型是一个tuple,而kwargs则是一个字典dict,并且args只能位于kwargs的前面。