在Python的学习过程中,看源码的时候,经常会看到对于函数对于参数的定义有 args和*kwargs,刚开始学习的时候,对这种写法感到非常不理解。下面我们就循序渐进,从实际的需求出发来一步一步的拆解为什么会有这种写法以及其代表的含义。
首先我们知道在Python中,函数的作用将具有独立功能的代码块组织成为一个整体,使其具有特殊功能。在某种程度上函数可以看成是代码的一种封装,它提供了可以被外部调用的接口而可以不用去关心内部的实现细节。函数的最大作用就是代码的可重复利用。这个和大部分编程语言都是类似的,但是和其他语言不一样的是,python中函数的参数种类多,而且使用起来非常灵活。也正是因为其灵活性,在使用时如果不注意细节,也容易出现错误。这次我们就花5分钟搞清楚这些参数背后的意思。
1. 位置参数和关键词参数
函数的参数在定义时为形参,调用时传入实际参数。
如果有多个参数,实际参数在调用时有最基本的按照位置参数和关键词传参。下面举例:
def func(a,b,c):
return int(''.join([str(a), str(b),str(c)]))
print(func(1,2,3))
print(func(2,3,1))
>>>
123
231
上面的函数在定义时,定义了3个形式参数a, b , c, 其功能是输入3个数字后将这个数字按照a-b-c的顺序组成一个3位数输出。在调用时我们可以看到程序在编译时会自动的按顺序传参。
这种传参方式简单明了,但是如果参数过多时,为了防止出错,调用函数时,我们可以直接指定某个参数的取值,这时这个参数即为关键词传参,如下:
#通过关键词传参
print(func(c = 3, b = 2, a = 1))
print(func(1,2, c = 3))
>>>
123
123
从上面的代码可以看出,用关键词传参时,可以不按照函数定义时参数的顺序,但是如果参数中同时有位置参数和关键词参数,关键词参数必须放在位置参数后面。这个也很合理,防止编译时实参和形参匹配不上。如下:
# 混搭传参, 原则: 关键词参数必须位置位置参数之后
func(a = 3, 4,5)
File "", line 2
func(a = 3, 4,5)
^
SyntaxError: positional argument follows keyword argument
可以看到报错信息中提示位置参数位于关键词参数之后的错误!
1. 这里总结第一条原则:函数调用时如果同时传入位置参数和关键词参数,则必须位置参数在前,关键词参数在后!
2. 强制关键词参数
由于通过位置关系来传入参数可能会出错,python中的函数提供了强制关键词参数定义。具体形式为在函数参数定义时,通过‘*’来标识后面的参数为关键词参数,调用时必须通过关键词传参,下面举例:
# 强制关键词参数, 函数定义参数时,使用'*""标识
def func_kw(*, a, b, c):
return int(''.join([str(a), str(b), str(c)]))
print(func_kw(a = 11, b = 22, c=33))
print(func_kw(11, 22,33))
>>>
112233
---------------------------------------------------------------------------
TypeError Traceback (most recent call last)
in
5
6 print(func_kw(a = 11, b = 22, c=33))
----> 7 print(func_kw(11, 22,33))
TypeError: func_kw() takes 0 positional arguments but 3 were given
可以看到第一次调用时严格按照关键词传参可以顺利调用,后面意图使用位置传参时,报错。报错信息为函数定义参数没有位置参数,即‘’后面的参数均为关键词参数。
当然了,位置参数也可以和强制关键词参数同时存在,但是调用时一样,‘’后面的参数必须按照关键词参数传参,如下:
# 位置参数和强制关键词参数混搭
def func_kw(x, *, a, b, c):
return int(''.join([str(x),str(a), str(b), str(c)]))
print(func_kw(123, a = 11, b = 22, c=33))
print(func_kw(11,22, a = 11, b = 22, c=33))
>>>
123112233
---------------------------------------------------------------------------
TypeError Traceback (most recent call last)
in
4
5 print(func_kw(123, a = 11, b = 22, c=33))
----> 6 print(func_kw(11,22, a = 11, b = 22, c=33))
TypeError: func_kw() takes 1 positional argument but 2 positional arguments (and 3 keyword-only arguments) were given
分析上面的代码,函数定义时,‘*’前面的为位置参数,只有一个x,但是在调用时,第二行代码传入了两个位置参数从而引起了报错。这样混搭时同样遵循第一条原则,即位置参数在前,关键词参数在后。
3. 默认参数
函数在定义时,可以直接指定参数的取值,即默认参数。
def func_default(a, b, c = 999):
return int(''.join([str(a), str(b), str(c)]))
print('不指定默认参数取值时,该参数取默认值: ')
print(func_default(1,2))
print("*-*" * 10)
print('也可以指定默认参数的值,覆盖默认值:')
print(func_default(1,2,666))
>>>
不指定默认参数取值时,该参数取默认值:
12999
*-**-**-**-**-**-**-**-**-**-*
也可以指定默认参数的值,覆盖默认值:
12666
原则二: 使用默认参数时,同样需要把默认参数定义在最后,否则声明时即会报错,如下:
def f_with_default(a = 5, b, c = 10):
pass
>>>
File "", line 1
def f_with_default(a = 5, b, c = 10):
^
SyntaxError: non-default argument follows default argument
4. 可变参数
说完了位置参数,关键词参数,默认参数之后,就来到了我们本次的重点——可变参数。可变参数包含两种:
- *args: 可变位置参数
- **kwargs: 可变关键词参数
上面的写法中args只是一个按惯例的写法,即参数arguments的缩写,kwargs时key word arguments的缩写。而"可变"表示参数的数量不固定,不像上面的例子那样定义多少个,调用时传入多少个。为什么会有这样的设计?我们从下面的一个例子出发,带着大家了解一下这个设计背后的应用场景。
4.1 可变位置参数
假设我们现在设计一个函数计算输入两个数的和:
def add(a, b):
return a + b
add(250,250)
>>>
2B
现在要求任意多个参数实现加总求和,怎么解决? 如果是三个,可以直接定义 add(a,b,c), 但是要求现在是任意多,怎么办?
我们可以设置一个元组来接收除了前面两个参数之外的参数,来实现这个任意多:
def add(a, b, args = None):
res = a + b
if args:
for arg in args:
res += arg
return res
print(add(1,2, (3,4)))
print(add(1,2, (i for i in range(3, 101))))
>>>
10
5050
上面的写法虽然满足了需求,但是写法不够优雅,在调用时对于前面两个参数可以直接传入,但是后面任意多的参数需要传入一个元组,不符合Python的优雅原则,这时可以使用*args来代替!下面举例:
def prety_add(a,b, *args):
res = a + b
if args:
print(args)
for arg in args:
res += arg
return res
上面的代码中,我们增加了print(args)来验证一下编译器是否会将输入的参数除去前面两个之后的所有参数放入一个元组(除去前面两个是因为在*args之前有两个位置参数a,b),下面调用来验证一下:
prety_add(3,4,5,6,7,8,9)
>>>(5, 6, 7, 8, 9)
42
prety_add('Hello ', 'Pyton' , 'Open ', 'the ', 'world ', 'beyond ')
>>>('Open ', 'the ', 'world ', 'beyond ')
'Hello PytonOpen the world beyond '
可以看到代码中先输出args,即除去a,b之后的所有参数。从上面的代码我们稍微思考一下可以知道传参时,除了前两个参数之外的所有参数传给了一个元组,即args = (x1.x2....),而args前面加了一个'*"号,其作用是拆包。
从上面的例子也可以看到,在使用可变参数时,同样要遵循位置参数在前,可变参数在后的原则。如果把位置参数放在后面,声明时没有问题,但是编译的时会出错。如下:
def func_star(a, b, *args, c):
print(args)
print(a+b+c)
func_star(1,2,3,4,5)
---------------------------------------------------------------------------
TypeError Traceback (most recent call last)
in
----> 1 func_star(1,2, 3,4,5)
TypeError: func_star() missing 1 required keyword-only argument: 'c'
这个也很好理解,因为中间的args可以接受任意多的参数,调用时1,2后面的3,4,5都被args吃掉了,那么后面的c就没有了,报错信息提示args后面的参数为关键词参数,没有取值。
从报错信息我们可以知道,在*args后面可以增加关键词参数,那么可以有两种方法解决上面的报错:
-
- 调用时,将c作用关键词参数
def func_star(a, b, *args, c):
print(args)
print(c)
func_star(1,2,3,4,5, c = 6)
>>>
(3, 4, 5)
6
-
- 函数定义时,将c作为默认参数处理,给予默认值
def func_star(a, b, *args, c=10):
print(args)
print(c)
func_star(1,2,3,4,5,6)
>>>
(3, 4, 5, 6)
10
可以看到虽然除去args接收了后面的所有参数,但是因为c有默认值,所以不会出错。
综上,我们总结出第三条原则:
原则三: 当有可变参数时,同样需要把可变参数放在位置参数之后。且可变参数之后的必须为关键词参数
4.2 **kwargs可变关键词参数
kwargs可变关键词参数的用法大体和 上面的args可变位置参数类似,只不过args可变位置参数使用一个元组来接收参数,而kwargs因为使用key-value键字对来存储参数,相应的kwargs可变关键词参数采用一个字典来接收参数。由于本次的篇幅限制,我们下次单独来讲解kwargs可变关键词参数以及他的用法.
更多内容可以VX搜索公+众 +号“Pythong数据科学家之路”关注!