date: 2020-10-14 21:04:20 +0800
tags:
  - 编程基础
  - Python

本文主要介绍Python中*args和**kwargs参数的使用

1 使用

在Python中，定义函数时可以使用两个特殊符号，以允许它们接受可变数量的参数。这两个特殊符号为*和**。通常*和args一起使用，**和kwargs一起使用。事实上args和kwargs可以用任何名称替代，之所以用args和kwargs仅仅是为了遵从通俗约定。args为arguments的缩写，表示多个参数。kwargs为 keyword arguments 的缩写，表示多个关键字参数。

Python中，（*）会把接收到的参数转为一个元组，而（**）会把接收到的参数转为一个字典。所以*args表示将传入多个参数（包括0个参数）变为元组，**kwargs表示将传入多个带名称的参数（包括0个参数）变为字典。具体例子下面分别介绍。

*args的使用

def func(*args):
    # 打印参数类型
    print(type(args))
    # 打印参数
    print(args)
    
func("a", "b", "c")
func(["a", "b", "c"])
# 将一个列表变为元组，需要在传入参数的前面加上一个*
func(*["a", "b", "c"])

<class 'tuple'>
('a', 'b', 'c')
<class 'tuple'>
(['a', 'b', 'c'],)
<class 'tuple'>
('a', 'b', 'c')

**kwargs的使用

def func(**kwargs):
    # 转为字典
    print(type(kwargs))
    for key, value in kwargs.items():
        print("{} = {}".format(key,value))
    
func(param1="a", param2="b", param3="c")
# 也可以直接传入一个字典
dicts={'param1':"a", 'param2':"b", 'param3':"c"}
func(**dicts)

<class 'dict'>
param1 = a
param2 = b
param3 = c
<class 'dict'>
param1 = a
param2 = b
param3 = c

*args和**kwargs共同使用

def fun(*args, **kwargs):
    print("args:", args)
    print("kwargs:", kwargs)
fun("a", "b", "c", param1="a", param2="b", param3="c")
fun(*["a","b","c"], param1="a", param2="b", param3="c")

args: ('a', 'b', 'c')
kwargs: {'param1': 'a', 'param2': 'b', 'param3': 'c'}
args: ('a', 'b', 'c')
kwargs: {'param1': 'a', 'param2': 'b', 'param3': 'c'}

此外也可以传入其他单独参数名，如下面的例子，传入name和age参数。name参数在第一位，不输入参数名name也会将第一个输入参数视为name。函数中间的参数如age，则需要指定参数名。

def fun(name, *args, age=None, **kwargs):
    print("name:", name)
    print("args:", args)
    print("age:", age)
    print("kwargs:", kwargs)

fun(1, 2, 3, a=1, b=2, c=3)
fun("helloworld", 1, 2, 3, age=12, a=1, b=2, c=3)

name: 1
args: (2, 3)
age: None
kwargs: {'a': 1, 'b': 2, 'c': 3}
name: helloworld
args: (1, 2, 3)
age: 12
kwargs: {'a': 1, 'b': 2, 'c': 3}

**但是要注意的是，*args必须放在**kwargs前面且**kwarg要位于所有参数最后，因为非默认参数必须在默认参数之前处理，不然会出错。

2 拓展

事实上，在Python3.5以上版本，*和**多了一个功能叫做解包(unpacking)。解包的意思就是将迭代对象里面的元素逐个取出来。迭代的意思就是，当对元组，列表，字典，集合，字符串使用for循环语句的时候，可以依次拿到里面的数据，这样的过程称为遍历，也叫迭代。通过解包就是将元组，列表，字典，集合，字符串每一个单独的值拆分开来。其中*可以用于任何一种Python迭代对象，**只能用于字典。如下面的例子通过*解包对象，输出不再是迭代对象的本身，而是迭代对象的内容。但是这类语言结构最好不要使用，可读性较差。

# 元组解包
my_tuple=(1,2,3)
print(*my_tuple)

1 2 3

# 列表解包
my_list=[1,2,3]
print(*my_list)

1 2 3

# 字典解包
my_dir={"a":1,"b":2}
print(*my_dir)

a b

# 字符串解包
my_string="hello"
print(*my_string)

h e l l o

# 集合解包
my_set=set('hello')
print(*my_set)

e l o h

除此之外，还可以单独解包某个值如下所示

my_list = [1, 2, 3, 4, 5]
 
a, *b, c = my_list
 
print(a)
print(b)
print(c)

1
[2, 3, 4]
5

此外解包符还能用于迭代器的合并

# 列表合并
my_list1=[1,2,3]
my_list2=[4,5]
my_list=[*my_list1,*my_list2]
print(my_list)

[1, 2, 3, 4, 5]

# 字典合并
my_dir1={"a":1,"b":2}
my_dir2={"c":3,"d":4,"e":5}
my_dir={**my_dir1, **my_dir2}
print(my_dir)

{'a': 1, 'b': 2, 'c': 3, 'd': 4, 'e': 5}

对于字符串，*也能进行一系列的拆分

# 将字符串变为列表
hello = [*"hello"]
print(hello)

['h', 'e', 'l', 'l', 'o']

# 将字符串变为字典
hello = {*"hello"}
print(hello)

{'e', 'l', 'o', 'h'}

3 参考

Python *args and **kwargs

Python中*和**的区别

Python中的args和kwargs