### 简介
定义函数的时候,我们把参数的名字和位置确定下来,函数的接口定义就完成了。对于函数的调用者来说,只需要知道如何传递正确的参数,以及函数将返回什么样的值就够了,函数内部的复杂逻辑被封装起来,调用者无需了解。
Python的函数定义非常简单,但灵活度却非常大。除了正常定义的必选参数外,还可以使用默认参数、可变参数和关键字参数,使得函数定义出来的接口,不但能处理复杂的参数,还可以简化调用者的代码。
### 位置参数
**我们先写一个计算 $$x^{2}$$ 的函数:**
~~~
def power(x):
return x * x
~~~
对于`power(x)`函数,参数x就是一个位置参数。
当我们调用`power`函数时,必须传入有且仅有的一个参数`x`:
~~~
>>> power(5)
25
>>> power(15)
225
~~~
现在,如果我们要计算 $$x^{3}$$ 怎么办?可以再定义一个`power3`函数,但是如果要计算 $$x^{4}$$、$$x^{5}$$……怎么办?我们不可能定义无限多个函数。
你也许想到了,可以把`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, n)`函数,可以计算任意`n`次方:**
~~~
>>> power(5, 2)
25
>>> power(5, 3)
125
~~~
>[info]修改后的`power(x, n)`函数有两个参数:`x`和`n`,这两个参数都是位置参数,调用函数时,传入的两个值按照位置顺序依次赋给参数`x`和`n`。
### 默认参数
新的`power(x, n)`函数定义没有问题,但是,旧的调用代码失败了,原因是我们增加了一个参数,导致旧的代码因为缺少一个参数而无法正常调用:
~~~
>>> power(5)
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
TypeError: power() missing 1 required positional argument: 'n'
~~~
Python的错误信息很明确:调用函数`power()`缺少了一个位置参数n。
这个时候,默认参数就排上用场了。由于我们经常计算 $$x^{2}$$,所以,完全可以把第二个参数`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的解释器会报错(思考一下为什么默认参数不能放在必选参数前面);
- 二是如何设置默认参数。
当函数有多个参数时,把变化大的参数放前面,变化小的参数放后面。变化小的参数就可以作为默认参数。
#### 设置默认参数的好处
使用默认参数有什么好处?最大的好处是能降低调用函数的难度。
举个例子,我们写个一年级小学生注册的函数,需要传入`name`和`gender`两个参数:
~~~
def enroll(name, gender):
print('name:', name)
print('gender:', gender)
~~~
这样,调用`enroll()`函数只需要传入两个参数:
~~~
>>> enroll('Sarah', 'F')
name: Sarah
gender: F
~~~
如果要继续传入年龄、城市等信息怎么办?这样会使得调用函数的复杂度大大增加。
我们可以把年龄和城市设为默认参数:
~~~
def enroll(name, gender, age=6, city='Beijing'):
print('name:', name)
print('gender:', gender)
print('age:', age)
print('city:', city)
~~~
这样,大多数学生注册时不需要提供年龄和城市,只提供必须的两个参数:
~~~
>>> enroll('Sarah', 'F')
name: Sarah
gender: F
age: 6
city: Beijing
~~~
只有与默认参数不符的学生才需要提供额外的信息:
~~~
enroll('Bob', 'M', 7)
enroll('Adam', 'M', city='Tianjin')
~~~
可见,默认参数降低了函数调用的难度,而一旦需要更复杂的调用时,又可以传递更多的参数来实现。无论是简单调用还是复杂调用,函数只需要定义一个。
#### 多个默认参数的调用
有多个默认参数时,调用的时候,既可以按顺序提供默认参数,比如调用`enroll('Bob', 'M', 7)`,意思是,除了`name`,`gender`这两个参数外,最后`1`个参数应用在参数`age`上,`city`参数由于没有提供,仍然使用默认值。
也可以不按顺序提供部分默认参数。当不按顺序提供部分默认参数时,需要把参数名写上。比如调用`enroll('Adam', 'M', city='Tianjin')`,意思是,`city`参数用传进去的值,其他默认参数继续使用默认值。
#### 默认参数的大坑
默认参数很有用,但使用不当,也会掉坑里。默认参数有个最大的坑,演示如下:
先定义一个函数,传入一个`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`的内容,则下次调用时,默认参数的内容就变了,不再是函数定义时的`[]`了。
###### **牢记默认参数指向不变对象**
>[warning]**所以,定义默认参数要牢记一点:默认参数必须指向不变对象!**
要修改上面的例子,我们可以用`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……`,请计算 $$a^{2}$$ + $$b^{2}$$ + $$c^{2}$$+ ……。
要定义出这个函数,我们必须确定输入的参数。由于参数个数不确定,我们首先想到可以把`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允许你在`lis`t或`tuple`前面加一个`*`号,把`list`或`tuple`的元素变成可变参数传进去:
~~~
>>> nums = [1, 2, 3]
>>> calc(*nums)
14
~~~
`*nums`表示把`nums`这个`list`的所有元素作为可变参数传进去。这种写法相当有用,而且很常见。
### 关键字参数 **
可变参数允许你传入`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`转换为关键字参数传进去:
~~~
>>> extra = {'city': 'Beijing', 'job': 'Engineer'}
>>> person('Jack', 24, city=extra['city'], job=extra['job'])
name: Jack age: 24 other: {'city': 'Beijing', 'job': 'Engineer'}
~~~
当然,上面复杂的调用可以用简化的写法:
~~~
>>> 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`。
### 命名关键字参数
对于关键字参数,函数的调用者可以传入任意不受限制的关键字参数。至于到底传入了哪些,就需要在函数内部通过kw检查。
仍以`person()`函数为例,我们希望检查是否有`city`和`job`参数:
~~~
def person(name, age, **kw):
if 'city' in kw:
# 有city参数
pass
if 'job' in kw:
# 有job参数
pass
print('name:', name, 'age:', age, 'other:', kw)
~~~
但是调用者仍可以传入不受限制的关键字参数:
`>>> person('Jack', 24, city='Beijing', addr='Chaoyang', zipcode=123456)`
#### 限制关键参数的接收
如果要限制关键字参数的名字,就可以用命名关键字参数,例如,只接收`city`和`job`作为关键字参数。这种方式定义的函数如下:
~~~
def person(name, age, *, city, job):
print(name, age, city, job)
~~~
和关键字参数`**kw`不同,命名关键字参数需要一个特殊分隔符`*`,`*`后面的参数被视为命名关键字参数。
调用方式如下:
~~~
>>> person('Jack', 24, city='Beijing', job='Engineer')
Jack 24 Beijing Engineer
~~~
如果函数定义中已经有了一个可变参数,后面跟着的命名关键字参数就不再需要一个特殊分隔符`*`了:
~~~
def person(name, age, *args, city, job):
print(name, age, args, city, job)
~~~
命名关键字参数必须传入参数名,这和位置参数不同。如果没有传入参数名,调用将报错:
~~~
>>> person('Jack', 24, 'Beijing', 'Engineer')
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
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`参数:
~~~
>>> person('Jack', 24, job='Engineer')
Jack 24 Beijing Engineer
~~~
使用命名关键字参数时,要特别注意,如果没有可变参数,就必须加一个`*`作为特殊分隔符。如果缺少`*`,`Python`解释器将无法识别位置参数和命名关键字参数:
~~~
def person(name, age, city, job):
# 缺少 *,city和job被视为位置参数
pass
~~~
### 参数组合
在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)
~~~
在函数调用的时候,Python解释器自动按照参数位置和参数名把对应的参数传进去。
~~~
>>> f1(1, 2)
a = 1 b = 2 c = 0 args = () kw = {}
>>> f1(1, 2, c=3)
a = 1 b = 2 c = 3 args = () kw = {}
>>> f1(1, 2, 3, 'a', 'b')
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {}
>>> f1(1, 2, 3, 'a', 'b', x=99)
a = 1 b = 2 c = 3 args = ('a', 'b') kw = {'x': 99}
>>> f2(1, 2, d=99, ext=None)
a = 1 b = 2 c = 0 d = 99 kw = {'ext': None}
~~~
最神奇的是通过一个tuple和dict,你也可以调用上述函数:
~~~
>>> args = (1, 2, 3, 4)
>>> kw = {'d': 99, 'x': '#'}
>>> f1(*args, **kw)
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': '#'}
~~~
所以,对于任意函数,都可以通过类似`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})`。
>[info]使用`*args`和`**kw`是Python的习惯写法,当然也可以用其他参数名,但最好使用习惯用法。
#### 命名的关键字参数
命名的关键字参数是为了限制调用者可以传入的参数名,同时可以提供默认值。
定义命名的关键字参数在没有可变参数的情况下不要忘了写分隔符`*`,否则定义的将是位置参数。
- Python教程
- Python简介
- 安装Python
- Python解释器
- 第一个 Python 程序
- 使用文本编辑器
- Python代码运行助手
- 输入和输出
- 源码
- learning.py
- Python基础
- 数据类型和变量
- 字符串和编码
- 使用list和tuple
- 条件判断
- 循环
- 使用dict和set
- 函数
- 调用函数
- 定义函数
- 函数的参数
- 递归函数
- 高级特性
- 切片
- 迭代
- 列表生成式
- 生成器
- 迭代器
- 函数式编程
- 高阶函数
- map/reduce
- filter
- sorted
- 返回函数
- 匿名函数
- 装饰器
- 偏函数
- Python函数式编程——偏函数(来自博客)
- 模块
- 使用模块
- 安装第三方模块
- 面向对象编程
- 类和实例
- 访问限制
- 继承和多态
- 获取对象信息
- 实例属性和类属性
- 面向对象高级编程
- 使用__slots__
- 使用@property
- 多重继承
- 定制类
- 使用枚举类
- 使用元类
- 错误、调试和测试
- 错误处理
- 调试
- 单元测试
- 文档测试
- IO编程
- 文件读写
- StringIO和BytesIO
- 操作文件和目录
- 序列化
- 进程和线程
- 多进程
- 多线程
- ThreadLocal
- 进程 vs. 线程
- 分布式进程
- 正则表达式
- 常用内建模块
- datetime
- collections
- base64
- struct
- hashlib
- itertools
- contextlib
- XML
- HTMLParser
- urllib
- 常用第三方模块
- PIL
- virtualenv
- 图形界面
- 网络编程
- TCP/IP简介
- TCP编程
- UDP编程
- 电子邮件
- SMTP发送邮件
- POP3收取邮件
- 访问数据库
- 使用SQLite
- 使用MySQL
- 使用SQLAlchemy
- Web开发
- HTTP协议简介
- HTML简介
- WSGI接口
- 使用Web框架
- 使用模板
- 异步IO
- 协程
- asyncio
- async/await
- aiohttp
- 实战
- Day 1 - 搭建开发环境
- Day 2 - 编写Web App骨架
- Day 3 - 编写ORM
- Day 4 - 编写Model
- Day 5 - 编写Web框架
- Day 6 - 编写配置文件
- Day 7 - 编写MVC
- Day 8 - 构建前端
- Day 9 - 编写API
- Day 10 - 用户注册和登录
- Day 11 - 编写日志创建页
- Day 12 - 编写日志列表页
- Day 13 - 提升开发效率
- Day 14 - 完成Web App
- Day 15 - 部署Web App
- Day 16 - 编写移动App
- FAQ
- 期末总结