So easy：python *args *kwargs 参数详解

(望结交天下才士 ，Contact：UVEgMTkwNDUyOTQzOA==)

可变参数

在Python函数中，还能够定义可变参数。顾名思义，可变参数就是传入的参数个数是可变的，能够是1个、2个到任意个，还能够是0个。

咱们以数学题为例子，给定一组数字a，b，c……，请计算a2 + b2 + c2 + ……。

要定义出这个函数，咱们必须肯定输入的参数。因为参数个数不肯定，咱们首先想到能够把a，b，c……做为一个list或tuple传进来，这样，函数能够定义以下：

1 def calc(numbers):
2     sum = 0
3     for n in numbers:
4         sum = sum + n * n
5     return sum

可是调用的时候，须要先组装出一个list或tuple：

1 >>> calc([1, 2, 3])
2 14
3 >>> calc((1, 3, 5, 7))
4 84

若是利用可变参数，调用函数的方式能够简化成这样：

1 >>> calc(1, 2, 3)
2 14
3 >>> calc(1, 3, 5, 7)
4 84

因此，咱们把函数的参数改成可变参数：

1 def calc(*numbers):
2     sum = 0
3     for n in numbers:
4         sum = sum + n * n
5     return sum

定义可变参数和定义一个list或tuple参数相比，仅仅在参数前面加了一个*号。在函数内部，参数numbers接收到的是一个tuple，所以，函数代码彻底不变。可是，调用该函数时，能够传入任意个参数，包括0个参数：

1 >>> calc(1, 2)
2 5
3 >>> calc()
4 0

若是已经有一个list或者tuple，要调用一个可变参数怎么办？能够这样作：

1 >>> nums = [1, 2, 3]
2 >>> calc(nums[0], nums[1], nums[2])
3 14

这种写法固然是可行的，问题是太繁琐，因此Python容许你在list或tuple前面加一个*号，把list或tuple的元素变成可变参数传进去：

1 >>> nums = [1, 2, 3]
2 >>> calc(*nums)
3 14

*nums表示把nums这个list的全部元素做为可变参数传进去。这种写法至关有用，并且很常见。

关键字参数

可变参数容许你传入0个或任意个参数，这些可变参数在函数调用时自动组装为一个tuple,而关键字参数容许你传入0个或任意个含参数名的参数，这些关键字参数在函数内部自动组装为一个dict。请看示例：

1 def person(name, age, **kw):
2     print('name:', name, 'age:', age, 'other:', kw)

函数person除了必选参数name和age外，还接受关键字参数kw。在调用该函数时，能够只传入必选参数：

1 >>> person('Michael', 30)
2 name: Michael age: 30 other: {}

也能够传入任意个数的关键字参数：

1 >>> person('Bob', 35, city='Beijing')
2 name: Bob age: 35 other: {'city': 'Beijing'}
3 >>> person('Adam', 45, gender='M', job='Engineer')
4 name: Adam age: 45 other: {'gender': 'M', 'job': 'Engineer'}

关键字参数有什么用？它能够扩展函数的功能。好比，在person函数里，咱们保证能接收到name和age这两个参数，可是，若是调用者愿意提供更多的参数，咱们也能收到。试想你正在作一个用户注册的功能，除了用户名和年龄是必填项外，其余都是可选项，利用关键字参数来定义这个函数就能知足注册的需求。

和可变参数相似，也能够先组装出一个dict，而后，把该dict转换为关键字参数传进去：

1 >>> extra = {'city': 'Beijing', 'job': 'Engineer'}
2 >>> person('Jack', 24, city=extra['city'], job=extra['job'])
3 name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

固然，上面复杂的调用能够用简化的写法：

1 >>> extra = {'city': 'Beijing', 'job': 'Engineer'}
2 >>> person('Jack', 24, **extra)
3 name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}

**extra表示把extra这个dict的全部key-value用关键字参数传入到函数的**kw参数，kw将得到一个dict，注意kw得到的dict是extra的一份拷贝，对kw的改动不会影响到函数外的extra。

命名关键字参数

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

仍以person()函数为例，咱们但愿检查是否有city和job参数：

1 def person(name, age, **kw):
2     if 'city' in kw:
3         # 有city参数
4         pass
5     if 'job' in kw:
6         # 有job参数
7         pass
8     print('name:', name, 'age:', age, 'other:', kw)

可是调用者仍能够传入不受限制的关键字参数：

1 >>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)

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

1 def person(name, age, *, city, job):
2     print(name, age, city, job)

和关键字参数不一样，命名关键字参数须要一个特殊分隔符，后面的参数被视为命名关键字参数。**kw

调用方式以下：

1 >>> person('Jack', 24, city='Beijing', job='Engineer')
2 Jack 24 Beijing Engineer

命名关键字参数必须传入参数名，这和位置参数不一样。若是没有传入参数名，调用将报错：

1 >>> person('Jack', 24, 'Beijing', 'Engineer')
2 Traceback (most recent call last):
3   File "<stdin>", line 1, in <module>
4 TypeError: person() takes 2 positional arguments but 4 were given

因为调用时缺乏参数名city和job，Python解释器把这4个参数均视为位置参数，但person()函数仅接受2个位置参数。

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

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

因为命名关键字参数city具备默认值，调用时，可不传入city参数：

1 >>> person('Jack', 24, job='Engineer')
2 Jack 24 Beijing Engineer

使用命名关键字参数时，要特别注意，不是参数，而是特殊分隔符。若是缺乏，Python解释器将没法识别位置参数和命名关键字参数：

1 def person(name, age, city, job):
2     # 缺乏 *，city和job被视为位置参数
3     pass

参数组合

在Python中定义函数，能够用必选参数、默认参数、可变参数、关键字参数和命名关键字参数，这5种参数均可以组合使用，除了可变参数没法和命名关键字参数混合。可是请注意，参数定义的顺序必须是：必选参数、默认参数、可变参数/命名关键字参数和关键字参数。

好比定义一个函数，包含上述若干种参数：

1 def f1(a, b, c=0, *args, **kw):
2     print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw)
3 
4 def f2(a, b, c=0, *, d, **kw):
5     print('a =', a, 'b =', b, 'c =', c, 'd =', d, 'kw =', kw)

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

 1 >>> f1(1, 2)
 2 a = 1 b = 2 c = 0 args = () kw = {}
 3 >>> f1(1, 2, c=3)
 4 a = 1 b = 2 c = 3 args = () kw = {}
 5 >>> f1(1, 2, 3, 'a', 'b')
 6 a = 1 b = 2 c = 3 args = ('a', 'b') kw = {}
 7 >>> f1(1, 2, 3, 'a', 'b', x=99)
 8 a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99}
 9 >>> f2(1, 2, d=99, ext=None)
10 a = 1 b = 2 c = 0 d = 99 kw = {'ext': None}

最神奇的是经过一个tuple和dict，你也能够调用上述函数：

因此，对于任意函数，均可以经过相似func(*args, **kw)的形式调用它，不管它的参数是如何定义的。

小结

Python的函数具备很是灵活的参数形态，既能够实现简单的调用，又能够传入很是复杂的参数。

默认参数必定要用不可变对象，若是是可变对象，程序运行时会有逻辑错误！

要注意定义可变参数和关键字参数的语法：

*args是可变参数，args接收的是一个tuple；

**kw是关键字参数，kw接收的是一个dict。

以及调用函数时如何传入可变参数和关键字参数的语法：

可变参数既能够直接传入：func(1, 2, 3)，又能够先组装list或tuple，再经过*args传入：func(*(1, 2, 3))；

关键字参数既能够直接传入：func(a=1, b=2)，又能够先组装dict，再经过**kw传入：func(**{'a': 1, 'b': 2})。

使用*args和**kw是Python的习惯写法，固然也能够用其余参数名，但最好使用习惯用法。

命名的关键字参数是为了限制调用者能够传入的参数名，同时能够提供默认值。

定义命名的关键字参数不要忘了写分隔符*，不然定义的将是位置参数。

做者：东皇Amrzs连接：http://www.jianshu.com/p/98f7e34845b5來源：简书著做权归做者全部。