在 Python 中,定义一个函数要使用 def 语句,依次写出函数名、括号、括号中的参数和冒号:
,然后,在缩进块中编写函数体,函数的返回值用 return 语句返回。
我们以自定义一个求绝对值的 my_abs
函数为例:
12345 | def my_abs(x): if x >= 0: return x else: return -x |
---|
如果没有 return 语句,函数执行完毕后也会返回结果,只是结果为 None。 return None 可以简写为 return。
如果想定义一个什么事也不做的空函数,可以用 pass
语句:
12 | def nop(): pass |
---|
pass
语句什么都不做,那有什么用?实际上 pass
可以用来作为占位符,比如现在还没想好怎么写函数的代码,就可以先放一个 pass
,让代码能运行起来。
pass
还可以用在其他语句里,比如:
12 | if age >= 18: pass |
---|
因为缺少了
pass
,代码运行就会有语法错误。Python 是不允许空代码的内容的。
Python 中的函数返回值可以是多个,如:
123456 | def demo(a, b): return a, b result = demo(1, 2)print type(result)print result |
---|
运行结果:
<type 'tuple'>
(1, 2)
其实返回的仍然是一个单一值,只不过这是一个Tuple,在 Tuple 的创建 中也提到了这种 Tuple的简便写法。
Python的函数定义非常简单,但灵活度却非常大。除了正常定义的必选参数外,还可以使用默认参数、可变参数和关键字参数,使得函数定义出来的接口,不但能处理复杂的参数,还可以简化调用者的代码。
先来看一个普通的用来计算x的平方的函数:
12 | def power(x): return x * x |
---|
当我们调用power函数时,必须传入有且仅有的一个参数 x,但如果现在要计算 x 的三次方怎么办?可以在定义一个 powre3
函数么,那么四次方,五次方呢。
我们可以把 power(x)
修改为 power(x, n)
,用来计算 x 的 n 次方:
123456 | def power(x, n): s = 1 while n > 0: n = n - 1 s = s * x return s |
---|
对于这个修改后的 power
函数,可以计算任意 n 次方。
但是,旧的只有一个参数的调用就会失败了。这时候默认参数就派上用场了。由于我们经常使用 x
的二次方,所以,完全可以吧第二个参数 n 的默认值设置为 2:
123456 | def power(x, n=2): s = 1 while n > 0: n = n - 1 s = s * 2 return s |
---|
这样,当我们调用 power(5)
时,相当于调用了 power(5, 2)
:
1234 | >>> power(5)25>>> power(5, 2)25 |
---|
而对于 n > 2
的其他情况,就必须明确的传入 n,比如 power(5, 3)
从上面的例子可以看出,默认参数可以简化函数的调用。设置默认参数时,要注意: 必选参数在前,默认参数在后,否则Python的解释器会报错(思考一下为什么默认参数不能放在必选参数前面);
但当有多个默认参数时,如:
12345 | def student(name, age, city='Beijing',dept='Computer'): print 'name:', name print 'age:', age print 'city:', city print 'dept:', dept |
---|
当想要传入 city
参数的时候:
12345 | >>> student('zhangsan', 18, 'ShangHai')name: zhangsanage: 18city: ShangHaidept: Computer |
---|
当要传入 detp
参数的时候:
12345 | >>> student('zhangsan', 18, detp = 'Maths')name: zhangsanage: 18city: Beijingdept: Maths |
---|
可以看到当有多个默认参数的时候,没按照顺序来补全参数的时候就需要指定参数名称了,不然 Python 也无法识别你到底想要给哪个参数传递。
先定义一个函数,传入一个 List,添加一个 'END'
再返回:
123 | def add_end(L=[]): L.append('END') return L |
---|
然后使用 普通方式
调用,看起来似乎没什么问题:
1234 | >>> add_end([1, 2, 3]);[1, 2, 3, 'END']>>> print add_end(['A', 'B', 'C'])['A', 'B', 'C', 'END'] |
---|
但是当多次调用 默认参数
时,结果就不对了:
1234 | >>> add_end()['END', 'END']>>> add_end()['END', 'END', 'END'] |
---|
默认参数是 [ ]
,但是函数好像每次都 “记住了” 上次添加的 "END"
后的 list。
原因解释如下:
Python函数在定义的时候,默认参数L的值就被计算出来了,即[],因为默认参数L也是一个变量,它指向对象[],每次调用该函数,如果改变了L的内容,则下次调用时,默认参数的内容就变了,不再是函数定义时的[]了。
所以,定义默认参数要牢记一点:默认参数必须指向不变对象!
当我们要不确定参数个数的时候,怎么办呢?可以写一个 list 或 tuple:
12345 | def my_sum(nums): n = 0 for num in nums: n += num return n |
---|
这样可以完成不论传递多少个参数,都可以计算它们的和,但是,这样调用的时候我们还要先组装出一个 list 或 tuple:
1234 | >>> my_sum([1, 2, 3 ])6>>> my_sum([1, 2, 3, 4])10 |
---|
但是这样写太麻烦了,还要自己组装成 list 或 tuple,如果利用可变参数,就简单了很多:
1234567 | def my_sum(*nums): n = 0 for num in nums: n += num return nprint my_sum(1, 2, 3, 4, 5) |
---|
定义可变参数和定义 list 和 tuple 参数相比,仅仅在参数面前加一个 *
号即可。在函数内部,参数 numbers
接收到的是一个 tuple。
那么如果已经有了一个 list 或 tuple,要调用一个可变参数怎么办?难道还要全部拆解一遍么,再放进去么,不用的,这些 Python 已经都帮我们想好了,只需要在 list 或 tuple 之前加上一个 *
号即可:
12 | nums = [1, 2, 3, 4]my_sum(*nums) |
---|
可变参数允许你传入 0 个或任意个参数,这些可变参数在函数调用时自动组装为一个 tuple。而关键字参数允许你传入 0 个或任意个含参数名的参数,这些关键字参数在函数内部自动组装为一个 dict。请看示例:
12 | def person(name, age, **kw): print 'name:', name, 'age:', age, 'other:', kw |
---|
函数 person
除了必选参数 name
和 age
外,还接受关键字参数 kw。在调用该函数时,可以只传入必选参数:
12 | >>> person('Michael', 30)name: Michael age: 30 other: {} |
---|
也可以传入任意个数的关键字参数:
1234 | >>> 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转换为关键字参数传进去:
123 | >>> kw = {'city': 'Beijing', 'job': 'Engineer'}>>> person('Jack', 24, city=kw['city'], job=kw['job'])name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'} |
---|
当然,上面复杂的调用可以用简化的写法:
123 | >>> kw = {'city': 'Beijing', 'job': 'Engineer'}>>> person('Jack', 24, **kw)name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'} |
---|
在Python中定义函数,可以用必选参数、默认参数、可变参数和关键字参数,这4种参数都可以一起使用,或者只用其中某些,但是请注意,参数定义的顺序必须是:必选参数、默认参数、可变参数和关键字参数。
比如定义一个函数,包含上述4种参数:
12 | def func(a, b, c=0, *args, **kw): print 'a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw |
---|
在函数调用的时候,Python解释器自动按照参数位置和参数名把对应的参数传进去。
12345678 | >>> 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} |
---|
调用函数时,如果参数个数不对,Python 解析器会自动检查出来,并抛出 TpyeEroor
。
但是如果参数类型不对,Python 解析器就无法帮我们检查。试试我们自己写的 my_abs
和内置函数 abs
的差别:
123456 | >>> 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
的定义,对参数类型做检查,只允许整数和浮点数类型的参数。数据类型检查可以用内置函数 isinstance()
实现:
1234567 | def my_abs(x): if not isinstance(x, (int, float)): raise TypeError('bad operand type') #抛出一个异常 if x >= 0: return x else: return -x |
---|
这样在添加了参数检查后,如果传入错误的参数类型,函数就可以抛出一个错误:
12345 | >>> my_abs('A')Traceback (most recent call last): File "<stdin>", line 1, in <module> File "<stdin>", line 3, in my_absTypeError: bad operand type |
---|
上面用到了 isinstance()
函数,这里来讲一下该函数的用法:
12 | print isinstance(a,(int,str)) ## 判断 a 是否是 int 或 str 类型print isinstance(a,int) ## 判断 a 是否是 int 类型 |
---|
isinstance()
函数还可以判断是否是一个类或子类的一个示例,这个以后学到面向对象在谈。
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 的习惯写法,当然也可以用其他参数名,但最好使用习惯用法。
本文参考:廖雪峰 - Python 函数