在学习Python时,总会遇到*args和**kwargs这两个魔法变量,那么它们到底是什么?
首先,并不是必须写成*args和**kwargs
。只有变量前面的*(星号)才是必须的,你也可以写成*var 和**vars
,而写成*args 和**kwargs
只是一个通俗的命名约定。
其次,他们还有一种叫法:参数组.它是通过一个把元祖(非关键字参数)或字典(关键字参数)作为参数组传递给函数,他们是一个没有显式定义参数的函数.
1 .*args
的用法
*args和**kwargs
主要用于函数定义。你可以将不定数量的参数传递给一个函数。
这里的不定的意思是:预先并不知道函数使用者会传递多少个参数给你,所以在这个场景下使用这两个关键字。
*args
是用来发送一个非键值对的可变数量的参数列表给一个函数。
简单举例:
>>> def func1(*args):
... print(args)
...
>>> func1()
()
>>> func1('hao')
('hao',)
>>> func1('hao',123)
('hao',123)
有个例子帮你理解这个概念:
def test_args(arg1, *argv):
print("变量1:", arg1)
for arg in argv:
print("变量参数组参数为:", arg)
test_args('1', '2', '3', '4')
输出结果为:
变量1:: 1
变量参数组参数为: 2
变量参数组参数为: 3
变量参数组参数为: 4
2. **kwargs的用法
kwargs允许你将不定长度的键值对(字典),作为参数传递给一个函数。如果你想要在一个函数里处理带名字的参数,你应该使用kwargs。
简单举例:
>>> def func2(**kwargs):
... print(kwargs)
...
>>> func2()
{
}
>>> func2(name='tom',age=20)
{
'name':'tom','age'=20}
def test_kwargs(**kwargs):
for key, value in kwargs.items():
print("{0} == {1}".format(key, value))
>>> test_kwargs(name="tom")
name == tom
现在你可以看出我们怎样在一个函数里,处理了一个键值对参数了。这就是**kwargs
的基础。
接下来说说怎样使用*args和**kwargs
来调用一个参数为列表或者字典的函数。
3. 使用*args和**kwargs来调用函数
那现在我们将看到怎样使用*args和**kwargs
来调用一个函数。
- 调用函数时,在序列对象前加
*
表示将序列对象拆分开 - 调用函数时,在字典对象前加
**
表示将字典对象拆分成key=val的形式
简单举例 1 :
定义一个简单函数
>>>def get_age(name,age):
... print('%s is %s years old' %(name,age))
首先使用*args:
>>> user = ['tom',20]
>>> get_age(user[0],user[1])
tom is 20 years old
>>> get_age(*user)
tom is 20 years old
现在使用**kwargs:
>>> user_dict = ['name':'tom','age':20]
>>> get_age(name='tom',age=20)
tom is 20 years old
>>> get_age(**user_dict)
tom is 20 years old
举例2:
假设你有这样一个函数:
def test_args_kwargs(arg1, arg2, arg3):
print("arg1:", arg1)
print("arg2:", arg2)
print("arg3:", arg3)
你可以使用*args或**kwargs来给这个函数传递参数。下面是怎样做:
首先使用*args:
>>> args = ("two", 3, 5)
>>> test_args_kwargs(*args)
arg1: two
arg2: 3
arg3: 5
现在使用**kwargs:
>>> kwargs = {
"arg3": 3, "arg2": "two", "arg1": 5}
>>> test_args_kwargs(**kwargs)
arg1: 5
arg2: two
arg3: 3
如果你想在函数里同时使用标准参数、*args和**kwargs这三种参数, 顺序是这样的:
some_func(fargs, *args, **kwargs)
4 使用的场景
视需求而定。最常见的用例是在写函数装饰器的时候。
此外它也可以用来做猴子补丁(monkey patching)。猴子补丁的意思是在程序运行时(runtime)修改某些代码。举个例子,你有一个类,里面有个叫get_info的函数会调用一个API并返回相应的数据。如果想测试它,可以把API调用替换成一些测试数据。例如:
import someclass
def get_info(self, *args):
return "Test data"
someclass.get_info = get_info