本文是廖雪峰教程的笔记。
函数的定义
定义函数时,需要确定函数名和参数个数
def fun(x1,x2,x3):
;如果有必要,可以先对参数的数据类型做检查;
函数体内部可以用
return
随时返回函数结果;函数执行完毕也没有
return
语句时,自动return None
。函数可以同时返回多个值,但其实就是一个
tuple
。
函数的参数
Python的函数具有非常灵活的参数形态,既可以实现简单的调用,又可以传入非常复杂的参数。
默认参数
默认参数可以简化函数的调用。设置默认参数时,有几点要注意:
- 必选参数在前,默认参数在后,否则Python的解释器会报错;
- 默认参数降低了函数调用的难度,而一旦需要更复杂的调用时,又可以传递更多的参数来实现。
- 默认参数一定要用不可变对象,如果是可变对象,程序运行时会有逻辑错误!例如:
def add_end(L=[]):
L.append('END')
return L
默认参数L是一个空list,是一个可变对象。当使用默认参数调用时,会发现
>>> add_end()
['END']
>>> add_end()
['END', 'END']
>>> add_end()
['END', 'END', 'END']
这显然是有问题的,要修改上面的例子,我们可以用None
这个不变对象来实现:
def add_end(L=None):
if L is None:
L = []
L.append('END')
return L
此时调用结果为
>>> add_end()
['END']
>>> add_end()
['END']
所以,我们在编写程序时,如果可以设计一个不变对象,那就尽量设计成不变对象。
可变参数
- 可变参数就是传入的参数个数是可变的,可以是1个、2个到任意个,还可以是0个。
- 定义可变参数和定义一个list或tuple参数相比,仅仅在参数前面加了一个
*
号。在函数内部,参数numbers接收到的是一个tuple,因此,函数代码完全不变。但是,调用该函数时,可以传入任意个参数,包括0个参数: - 可变参数允许你传入0个或任意个参数,这些可变参数在函数调用时自动组装为一个tuple。 例如:
def calc(*numbers):
sum = 0
for n in numbers:
sum = sum + n * n
return sum
运行结果
>>> calc(1, 2)
5
>>> calc()
0
如果已经有一个list或者tuple,可以这么调用可变参数:
>>> nums = [1, 2, 3]
>>> calc(*nums)
14
*nums
表示把nums
这个list的所有元素作为可变参数传进去。这种写法相当有用,而且很常见。
关键字参数
- 关键字参数和可变参数类似,关键字参数允许你传入0个或任意个含参数名的参数,这些关键字参数在函数内部自动组装为一个
dict
,而可变参数中自动组成一个tuple
。 - 关键字参数可以扩展函数的功能。试想你正在做一个用户注册的功能,除了用户名和年龄是必填项外,其他都是可选项,利用关键字参数来定义这个函数就能满足注册的需求。例如:
def person(name, age, **kw):
print('name:', name, 'age:', age, 'other:', kw)
运行
>>> extra = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, **extra)
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
**extra
表示把extra
这个dict
的所有key-value用关键字参数传入到函数的**kw
参数,kw
将获得一个dict
,注意kw
获得的dict
是extra
的一份拷贝,对kw
的改动不会影响到函数外的extra
。
命名关键字参数
- 如果要限制关键字参数的名字,就可以用命名关键字参数,例如:
def person(name, age, *, city, job):
print(name, age, city, job)
和位置参数不同,命名关键字参数必须传入参数名。调用方式如下:
>>> person('Jack', 24, city='Beijing', job='Engineer')
Jack 24 Beijing Engineer
和关键字参数**kw
不同,命名关键字参数需要一个特殊分隔符*
,*
后面的参数被视为命名关键字参数,前面的参数是普通的位置参数。上面定义的函数就只接收city和job作为关键字参数。
- 如果函数定义中已经有了一个可变参数,后面跟着的命名关键字参数就不再需要一个特殊分隔符*了:
def person(name, age, *args, city, job):
print(name, age, args, city, job)
上面的函数定义中,*args
代表可变参数,跟着的city
,job
是命名关键字参数。
- 命名关键字参数可以有缺省值,从而简化调用:
def person(name, age, *, city='Beijing', job):
print(name, age, city, job)
调用结果:
>>> person('Jack', 24, job='Engineer')
Jack 24 Beijing Engineer
参数组合
- 在Python中定义函数,可以用必选参数、默认参数、可变参数、关键字参数和命名关键字参数,这5种参数都可以组合使用。但是请注意,参数定义的顺序必须是:必选参数、默认参数、可变参数、命名关键字参数和关键字参数。
def f1(a, b, c=0, *args, **kw):
print('a =', a, 'b =', b, 'c =', c, 'args =', args, 'kw =', kw)
def f2(a, b, c=0, *, d, **kw):
print('a =', a, 'b =', b, 'c =', c, 'd =', d, 'kw =', kw)
在f1中,a
,b
是必选参数(位置参数),c=0
是默认参数,*args
是可变参数,**kw
是关键字参数;
在f2中,d是命名关键字参数。
- 对于任意函数,都可以通过类似
func(*args, **kw)
的形式调用它,无论它的参数是如何定义的。例如:
>>> args = (1, 2, 3, 4) #这是一个tuple
>>> kw = {'d': 99, 'x': '#'} #这是一个dict
>>> f1(*args, **kw) #*args可以将args中的元素作为可选参数传入,**kw可以将kw中的元素作为key-value形式传入。
a = 1 b = 2 c = 3 args = (4,) kw = {'d': 99, 'x': '#'}
>>> args = (1, 2, 3)
>>> kw = {'d': 88, 'x': '#'}
>>> f2(*args, **kw)
a = 1 b = 2 c = 3 d = 88 kw = {'x': '#'}
上面的函数中,f1(*args, **kw)
可以看作是f1(args[1],args[2],args[3],args[4], d=kw['d'],x=kw['x'])
f2(*args, **kw)
可以看作f2(args[1],args[2],args[3], d=kw['d'],x=kw['x'])
。
注意事项总结
要注意定义可变参数和关键字参数的语法:
- *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的习惯写法,当然也可以用其他参数名,但最好使用习惯用法。- 命名的关键字参数是为了限制调用者可以传入的参数名,同时可以提供默认值。
- 定义命名的关键字参数在没有可变参数的情况下不要忘了写分隔符*,否则定义的将是位置参数。