【廖雪峰】python函数的参数：可变参数、关键字参数、命名关键字参数

可变参数

可变参数就是传入的参数个数是可变的，可以是1个、2个到任意个，还可以是0个。

给定一组数字a，b，c……，请计算a² + b² + c² + …….。函数定义如下：

# 可变参数
def calc(*numbers):
    sum = 0
    for n in numbers:
       sum += n ** 2
    return sum

在函数内部，参数numbers接收到的是一个 tuple。调用该函数时，可以传入任意个参数，包括0个参数：

print(calc(1, 2))  # 5
print(calc())  # 0

重点掌握

Python允许在 list 或 tuple 前面加一个*号，把 list 或 tuple 的元素变成可变参数传进去：

# *nums 把 nums 这个 list 中的所有元素作为可变参数传进去。
nums = [1, 2, 3, 4]
print(calc(*nums))  # 30

关键字参数

关键字参数允许传入0个或任意个含参数名的参数，这些关键字参数在函数内部自动组装为一个 dict 。

# 关键字参数
def person(name, age, **kwargs):
    print('name:', name, '\tage:', age, '\tother:', kwargs)

person('Alen', 8, gender='M', job='Student')

# 与可变参数类似，可以先组装出一个dict，然后将该dict转换为关键字参数传进去
extra = {'city': 'Beijing', 'job': 'Student'}
person('Jack', 9, **extra)

结果如下：

name: Alen   age: 8     other: {'gender': 'M', 'job': 'Student'}
name: Jack   age: 9     other: {'city': 'Beijing', 'job': 'Student'}

命名关键字参数

对于关键字参数，函数的调用者可以传入任意不受限制的关键字参数。至于到底传入了哪些，就需要在函数内部通过kw检查。

仍以person()函数为例，我们希望检查是否有city和job参数：

# 检查是否有 city 和 job 参数
def person(name, age, **kwargs):
    if 'city' in kwargs:
        pass
    if 'job' in kwargs:
        pass
    print('name:', name, '\tage:', age, '\tother:', kwargs)
    
# 仍然可以传入不受限制的关键字参数
person('Rose', 24, city='Shanghai', height=166, weight=50)

调用者仍可以传入不受限制的关键字参数，结果如下：

name: Rose 	age: 24 	other: {'city': 'Shanghai', 'height': 166, 'weight': 50}

因此，引入了命名关键字参数。

如果要限制关键字参数的名字，就可以用命名关键字参数，例如，只接收city和job作为关键字参数。这种方式定义的函数如下：

# * 号后面的参数被视为命名关键字参数
def person(name, age, *, city, job):
    print(name, age, city, job)

正确的调用:

person('Alex', 24, city='Tianjin', job='Teacher')

正确的结果：

Alex 24 Tianjin Teacher

以下均为会发生报错的调用方式：

person('Alex', 24, city='Tianjin')
person('Alex', 24, city='Tianjin', weight=60)
person('Alex', 24, 'Tianjin', 'Teacher')

命名关键字参数的缺省值

命名关键字参数可以有缺省值，从而简化调用：

def person(name, age, *, city='Beijing', job):
    print(name, age, city, job)

person('Lucy', 28, job='Engineer')

由于命名关键字参数city具有默认值，调用时，可不传入city参数。结果如下：

Lucy 28 Beijing Engineer

参数组合

在Python中定义函数，可以用必选参数、默认参数、可变参数、关键字参数和命名关键字参数，这5种参数都可以组合使用。但是请注意，参数定义的顺序必须是：必选参数、默认参数、可变参数、命名关键字参数、关键字参数。

比如定义f1()、f2()函数，包含上述若干种参数：

def f1(a, b, c=0, *args, **kwargs):
    print('a=', a, '\tb=', b, '\tc=', c, '\targs=', args, '\tkwargs=', kwargs)


def f2(a, b, c=0, *, d, **kwargs):
    print('a=', a, '\tb=', b, '\tc=', c, '\td=', d, '\tkwargs=', kwargs)

在函数调用的时候，Python解释器自动按照参数位置和参数名把对应的参数传进去。

f1(1, 2)
f1(1, 2, c=3)
f1(1, 2, 4, 'a', 'b', x=99)
f1(1, 2, d=99, name='xiaohong')
f2(5, 3, d=99, name="Mark", age=18)

结果如下：

a= 1 	b= 2 	c= 0 	args= () 	kwargs= {}
a= 1 	b= 2 	c= 3 	args= () 	kwargs= {}
a= 1 	b= 2 	c= 4 	args= ('a', 'b') 	kwargs= {'x': 99}
a= 1 	b= 2 	c= 0 	args= () 	kwargs= {'d': 99, 'name': 'xiaohong'}
a= 5 	b= 3 	c= 0 	d= 99 	kwargs= {'name': 'Mark', 'age': 18}

同样，可以通过一个 tuple 和 dict 调用上述函数：

args = (1, 2, 3, 4)
kw = {'d': 99, 'name': 'Jack'}
f1(*args, **kw)

args = (1, 3, 5)
f2(*args, **kw)

将元组 args 中的前三个数分别一一分配给了 a，b，c。结果如下：

a= 1 	b= 2 	c= 3 	args= (4,) 	kwargs= {'d': 99, 'name': 'Jack'}
a= 1 	b= 3 	c= 5 	d= 99 	kwargs= {'name': 'Jack'}

虽然可以组合多达5种参数，但不要同时使用太多的组合，否则函数接口的可理解性很差。

参考链接：https://www.liaoxuefeng.com/wiki/1016959663602400/1017261630425888