定义函数
Python中定义函数要使用def语句(同样让人想起数据库中函数定义),依次写出函数名、括号、括号中的参数和冒号,然后再缩进块(Python语法比较简单,采用缩进方式。即每一行都是一个语句,当语句以冒号结尾时,所进的语句视为代码块。按照约定俗成的惯例,应该始终坚持使用4个空格的缩进。基础内容中有提到过,以后有机会要把前面的一点基础知识的笔记补全。。)中编写函数体,函数的返回值用return语句返回。
以自定义一个求绝对值得my_abs函数为例:
def my_abs(x): if x >= 0: return x else: return -x
注意如果没有return语句,函数执行完毕后也会返回结果,只是结果为None。
return None可以简写成return。
空函数
如果想定义一个什么事也不做的空函数,可以用pass语句:
def nop(): pass
pass语句的作用实际上是作为占位符,比如现在还没想好怎么写函数体,就可以先放一个pass,让代码运行起来。
pass还可以放在其他语句里,如:
if age >= 18: pass
缺少了pass,代码运行就会有语法错误。
参数检查
调用函数时,如果参数个数不对,Python解释器会自动检查出来,并抛出TypeError(前面已经提到)。但是参数类型不对,Python解释器就无法帮我们检查。自定义函数my_abs和内置函数abs的区别如下:
>>> my_abs('A') 'A' >>> abs('A') Traceback (most recent call last): File "<stdin>", line 1, in <module> TypeError: bad operand type for abs(): 'str'
即当传入不恰当参数时,内置函数abs会检查出参数错误,而我们定义的my_abs没有参数检查,所以,这个函数定义不够完善。
修改my_abs的定义,对参数类型做检查,只允许整数和浮点数类型的参数。数据类型检查可以用内置函数isinsttance实现:
def my_abs(x): if not isinstance(x, (int, float)): raise TypeError('bad operand type') if x >= 0: return x else: return -x
添加了参数检查后,如果传入错误参数类型,寒暑就会报错:
>>> my_abs('A') Traceback (most recent call last): File "<stdin>", line 1, in <module> File "<stdin>", line 3, in my_abs TypeError: bad operand type
返回多个值
Python的函数可以返回多个值。比如在游戏中经常需要从一个点移动到另一个点,给出坐标、位移和角度,就可以计算出新的坐标:
import math def move(x, y, step, angle=0); nx = x + step * math.cos(angle) ny = y - step * math.sin(angle) return nx, ny
这样我们就可以同时获得两个返回值:
>>> x, y = move(100, 100, 60, math.pi / 6) >>> print x, y 151.961524227 70.0
但其实这只是一种假象,Python函数返回的仍然是单一值:
>>> r = move(100, 100, 60, math.pi / 6) >>> print r (151.96452422706632, 70.0)
可见返回值其实是一个tuple!但是,在语法上,返回一个tuple可以省略括号,而多个变量可以同时接收一个tuple,按位置赋予对应的值。所以,Python的函数返回多值其实就是返回一个tuple,但写起来更方便。
函数的参数
Python的函数定义非常简单,但灵活度却非常大。除了正常定义的必选参数外,还可以使用默认参数、可变参数和关键字参数,使得函数定义出来的接口不但能处理复杂的参数,还可以简化调用者的代码。
默认参数
结合具体例子说明如何定义函数的默认参数。
当我们需要计算x平方时,定义一个函数如下:
def power(x): return x*x
注意,当我们调用power函数时,能且只能传入一个参数x。但如果我们需要计算x的三次方、四次方、五次方呢?当然我们可以重新定义函数,但如果我们想要计算x的任意次方呢,显然创建无限多个函数是不可行的。
我们可以把power(x)修改成power(x, n),用来计算x的n次方:
def power(x, n): s = 1 while n > 0: n = n - 1 s = s * x return s
此修改后的power函数可以计算x的任意次方。但是此时旧的调用代码就失败了,原因是我们增加了一个参数,导致旧的代码无法正常调用。于是,默认参数就派上用场了。由于我们经常计算x的平方,所以完全可以把第二个参数n的默认值设定为2,即在定义函数添加如下代码:def power(x, n=2)。这样,当我们调用power(5)时,相当于调用了power(5, 2)。而对于n>2的其他情况,就必须明确地传入n,比如power(5, 3)。
从上面的例子可以看出,默认参数可以简化函数的调用。设置默认参数时,有几点要注意:
一是必选参数在前,默认参数在后,否则Python的解释器会报错 ;
二是如何设置默认参数。
当函数有多个参数时,把变化大参数放在前面,变化小的参数放在后面。变化小的参数就可以作为默认参数。
使用默认参数最大的好处就是能降低调用函数的难度。上面的例子只是需要传入两个参数,而当有更多的参数需要传入且其中有几个参数是不常改变的时候,设置默认参数会大大降低函数调用的难度。而一旦需要复杂的调用时,又可以传递更多的参数来实现。无论是简单调用还是复杂调用,函数值需要定义一个。
有多个默认参数时,调用的时候,既可以按顺序提供默认参数,也可以不按顺序提供部分默认参数。当不按顺序提供部分默认参数时,需要把参数名写上。
默认参数很有用,但使用不当也会造成错误。默认参数最常见错误如下:
先定义一个函数,传入一个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() ['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
这样,无论调用多少次都不会有问题了。
为什么要涉及str、None这样的不变对象呢?因为不变对象一旦创建,对象内部的数据就不能修改,这样就减少了由于修改数据导致的错误。此外,由于对象不变,多任务环境下同时读取对象不需要加锁,同时读一点问题都没有。我们在编写程序时,如果可以设计一个不变对象,那就尽量设计成不变对象。
可变参数
在Python函数中,还可以定义可变参数。顾名思义,可变参数就是传入的参数个数是可变的。可以是1个、2个到任意个,还可以是0个。
我们以数学题为例子,给定一组数字a, b, c...,请计算它们的平方和。
要定义这个函数,我们必须确定输入的参数。由于参数个数不确定,我们首先想到可以把a, b, c...作为一个list或tuple传进来,这样,函数可以定义如下:
def calc(numbers): sun = 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):函数体不变。
定义可变参数和定义list或tuple参数相比,仅仅在参数前面加了一个*号。在函数内部,参数numbers接收到的是一个tuple,因此,函数代码完全不变。但是调用该函数时,可以传入人一个参数,包括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')
关键字参数的作用其实就是扩展函数的功能。比如,在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': 'Enginner'} >>> person('Jack', 24, **kw) name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
参数组合
在Python中定义函数,可以用必选参数、默认参数、可变参数和关键字参数,这四种参数都可以一起使用,或者只用其中某些,但参数定义的顺序必须是:必选参数、默认参数、可变参数和关键字参数。
比如定义一个函数,包含上述四种参数:
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的习惯写法,当然也可以用其他参数名,但最好使用习惯用法。