python 函数的参数

定义函数的时候，我们把参数的名字和位置确定下来，函数的接口定义就完成了。对于函数的调用者来说，只需要知道如何传递正确的参数，以及函数将返回什么样的值就够了，函数内部的复杂逻辑被封装起来，调用者无需了解。

Python的函数定义非常简单，但灵活度却非常大。除了正常定义的必选参数外，还可以使用默认参数、可变参数和关键字参数，使得函数定义出来的接口，不但能处理复杂的参数，还可以简化调用者的代码。

默认参数

我们仍以具体的例子来说明如何定义函数的默认参数。先写一个计算x2的函数：

def power(x):

   return x * x

 

当我们调用power函数时，必须传入有且仅有的一个参数x：

>>> power(5)

25

>>> power(15)

225

 

现在，如果我们要计算x3怎么办？可以再定义一个power3函数，但是如果要计算x4、x5……怎么办？我们不可能定义无限多个函数。

你也许想到了，可以把power(x)修改为power(x, n)，用来计算xn，说干就干：

def power(x, n):

    s= 1

   while n > 0:

       n = n - 1

       s = s * x

   return s

 

对于这个修改后的power函数，可以计算任意n次方：

>>> power(5, 2)

25

>>> power(5, 3)

125

 

但是，旧的调用代码失败了，原因是我们增加了一个参数，导致旧的代码无法正常调用：

>>> power(5)

Traceback (most recent call last):

 File "<stdin>", line 1, in <module>

TypeError: power() takes exactly 2arguments (1 given)

 

这个时候，默认参数就排上用场了。由于我们经常计算x2，所以，完全可以把第二个参数n的默认值设定为2：

def power(x, n=2):

    s= 1

   while n > 0:

       n = n - 1

       s = s * x

   return s

 

这样，当我们调用power(5)时，相当于调用power(5, 2)：

>>> power(5)

25

>>> power(5, 2)

25

 

而对于n > 2的其他情况，就必须明确地传入n，比如power(5, 3)。

从上面的例子可以看出，默认参数可以简化函数的调用。设置默认参数时，有几点要注意：

一是必选参数在前，默认参数在后，否则Python的解释器会报错（思考一下为什么默认参数不能放在必选参数前面）；

二是如何设置默认参数。

当函数有多个参数时，把变化大的参数放前面，变化小的参数放后面。变化小的参数就可以作为默认参数。

使用默认参数有什么好处？最大的好处是能降低调用函数的难度。

举个例子，假设要在屏幕上画一个圆，由于画圆只需要确定圆心坐标(x, y)和半径r就可以了，所以，我们假设可以这样调用该函数：

>>> x, y = 0, 0

>>> r = 20

>>> draw_circle(x, y, r)

 

画出来的图形是这样：

但是，如果想画一个红色的圆怎么办？幸好，编写draw_circle函数的是一位资深Python开发者，除了x，y，r这3个必选参数外，该函数还提供默认参数linecolor=0x000000，fillcolor=0xffffff，penwidth=1，如果改变默认参数，我们不但能画出红色的圆，还可以控制圆的线条粗细和填充颜色：

>>> draw_circle(0, 0, 20,linecolor=0xff0000)

>>> draw_circle(0, 0, 20,linecolor=0xff0000, penwidth=5)

>>> draw_circle(0, 0, 20,linecolor=0xff0000, fillcolor=0xffff00, penwidth=5)

 

结果如下：

可见，默认参数降低了函数调用的难度，而一旦需要更复杂的调用时，又可以传递更多的参数来实现。无论是简单调用还是复杂调用，函数只需要定义一个。

有多个默认参数时，调用的时候，既可以按顺序提供默认参数，比如调用draw_circle(0, 0, 20, 0xff0000, 0xffff00)，意思是，除了0，0，20这3个必选参数外，后两个参数应用在参数linecolor和fillcolor上，penwidth参数由于没有提供，仍然使用默认值。

也可以不按顺序提供部分默认参数。当不按顺序提供部分默认参数时，需要把参数名写上。比如调用draw_circle(0, 0, 20, fillcolor=0x00ff00)，意思是，fillcolor参数用传进去的值0x00ff00，其他默认参数继续使用默认值。

默认参数很有用，但使用不当，也会掉坑里。默认参数有个最大的坑，演示如下：

先定义一个函数，传入一个list，添加一个END再返回：

def add_end(L=[]):

   L.append('END')

   return L

 

当你正常调用时，结果似乎不错：

>>> add_end([1, 2, 3])

[1, 2, 3, 'END']

>>> add_end(['x', 'y', 'z'])

['x', 'y', 'z', 'END']

 

当你使用默认参数调用时，一开始结果也是对的：

>>> add_end()

['END']

 

但是，再次调用add_end()时，结果就不对了：

>>> add_end()

['END', 'END']

>>> add_end()

['END', 'END', 'END']

 

很多初学者很疑惑，默认参数是[]，但是函数似乎每次都“记住了”上次添加了'END'后的list。

原因解释如下：

Python函数在定义的时候，默认参数L的值就被计算出来了，即[]，因为默认参数L也是一个变量，它指向对象[]，每次调用该函数，如果改变了L的内容，则下次调用时，默认参数的内容就变了，不再是函数定义时的[]了。

所以，定义默认参数要牢记一点：默认参数必须指向不变对象！

要修改上面的例子，我们可以用None这个不变对象来实现：

def add_end(L=None):

   if L is None:

       L = []

   L.append('END')

   return L

 

现在，无论调用多少次，都不会有问题：

>>> add_end()

['END']

>>> add_end()

['END']

 

为什么要设计str、None这样的不变对象呢？因为不变对象一旦创建，对象内部的数据就不能修改，这样就减少了由于修改数据导致的错误。此外，由于对象不变，多任务环境下同时读取对象不需要加锁，同时读一点问题都没有。我们在编写程序时，如果可以设计一个不变对象，那就尽量设计成不变对象。

可变参数

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

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

要定义出这个函数，我们必须确定输入的参数。由于参数个数不确定，我们首先想到可以把a，b，c……作为一个list或tuple传进来，这样，函数可以定义如下：

def calc(numbers):

   sum = 0

   for n in numbers:

       sum = sum + n * n

   return sum

 

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

>>> calc([1, 2, 3])

14

>>> calc((1, 3, 5, 7))

84

 

如果利用可变参数，调用函数的方式可以简化成这样：

>>> calc(1, 2, 3)

14

>>> calc(1, 3, 5, 7)

84

 

所以，我们把函数的参数改为可变参数：

def calc(*numbers):

   sum = 0

   for n in numbers:

       sum = sum + n * n

   return sum

 

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

>>> calc(1, 2)

5

>>> calc()

0

 

如果已经有一个list或者tuple，要调用一个可变参数怎么办？可以这样做：

>>> nums = [1, 2, 3]

>>> calc(nums[0], nums[1],nums[2])

14

 

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

>>> nums = [1, 2, 3]

>>> calc(*nums)

14

 

这种写法相当有用，而且很常见。

关键字参数

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

def person(name, age, **kw):

   print 'name:', name, 'age:', age, 'other:', kw

 

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

>>> person('Michael', 30)

name: Michael age: 30 other: {}

 

也可以传入任意个数的关键字参数：

>>> person('Bob', 35,city='Beijing')

name: Bob age: 35 other: {'city':'Beijing'}

>>> person('Adam', 45, gender='M',job='Engineer')

name: Adam age: 45 other: {'gender': 'M','job': 'Engineer'}

 

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

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

>>> kw = {'city': 'Beijing','job': 'Engineer'}

>>> person('Jack', 24,city=kw['city'], job=kw['job'])

name: Jack age: 24 other: {'city':'Beijing', 'job': 'Engineer'}

 

当然，上面复杂的调用可以用简化的写法：

>>> kw = {'city': 'Beijing','job': 'Engineer'}

>>> person('Jack', 24, **kw)

name: Jack age: 24 other: {'city':'Beijing', 'job': 'Engineer'}

 

参数组合

在Python中定义函数，可以用必选参数、默认参数、可变参数和关键字参数，这4种参数都可以一起使用，或者只用其中某些，但是请注意，参数定义的顺序必须是：必选参数、默认参数、可变参数和关键字参数。

比如定义一个函数，包含上述4种参数：

def func(a, b, c=0, *args, **kw):

   print 'a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw

 

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

>>> func(1, 2)

a = 1 b = 2 c = 0 args = () kw = {}

>>> func(1, 2, c=3)

a = 1 b = 2 c = 3 args = () kw = {}

>>> func(1, 2, 3, 'a', 'b')

a = 1 b = 2 c = 3 args = ('a', 'b') kw = {}

>>> func(1, 2, 3, 'a', 'b', x=99)

a = 1 b = 2 c = 3 args = ('a', 'b') kw ={'x': 99}

 

最神奇的是通过一个tuple和dict，你也可以调用该函数：

>>> args = (1, 2, 3, 4)

>>> kw = {'x': 99}

>>> func(*args, **kw)

a = 1 b = 2 c = 3 args = (4,) kw = {'x':99}

 

所以，对于任意函数，都可以通过类似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的习惯写法，当然也可以用其他参数名，但最好使用习惯用法。