# 三、函数的参数 # ## 1、函数的参数类型 ## 设置与传递参数是函数的重点，而 Python 的函数对参数的支持非常的灵活。 主要的参数类型有：默认参数、关键字参数（位置参数）、不定长参数。 下面我们将一一了解这几种参数。 ## 2、默认参数 ## 有时候，我们自定义的函数中，如果调用的时候没有设置参数，需要给个默认值，这时候就需要用到默认值参数了。 默认参数，只要在构造函数参数的时候，给参数赋值就可以了 例如： ```python # -*- coding: UTF-8 -*- def print_user_info( name , age , sex = '男' ): # 打印用户信息 print(f'昵称：{name}' , end = ' ') print(f'年龄：{age}' , end = ' ') print(f'性别：{sex}') return; # 调用 print_user_info 函数 print_user_info( '两点水' , 18 , '女') print_user_info( '三点水' , 25 ) ``` 输出结果： ```txt 昵称：两点水 年龄：18 性别：女 昵称：三点水 年龄：25 性别：男 ``` 从输出结果可以看到，当你设置了默认参数的时候，在调用函数的时候，不传该参数，就会使用默认值。 但是这里需要注意的一点是：**只有在形参表末尾的那些参数可以有默认参数值**，也就是说你不能在声明函数形参的时候，先声明有默认值的形参而后声明没有默认值的形参。 这是因为赋给形参的值是根据位置而赋值的。例如，def func(a, b=1) 是有效的，但是 def func(a=1, b) 是 无效 的。 默认值参数就这样结束了吗？ 还没有的，细想一下，如果参数中是一个可修改的容器比如一个 lsit （列表）或者 dict （字典），那么我们使用什么来作为默认值呢？ 我们可以使用 None 作为默认值。就像下面这个例子一样： ```python # 如果 b 是一个 list ，可以使用 None 作为默认值 def print_info( a , b = None ): if b is None : b=[] return; ``` 认真看下例子，会不会有这样的疑问呢？在参数中我们直接 `b=[]` 不就行了吗？ 也就是写成下面这个样子： ```python def print_info( a , b = [] ): return; ``` 对不对呢？ 运行一下也没发现错误啊，可以这样写吗？ 这里需要特别注意的一点：**默认参数的值是不可变的对象，比如None、True、False、数字或字符串**，如果你像上面的那样操作，当默认值在其他地方被修改后你将会遇到各种麻烦。 这些修改会影响到下次调用这个函数时的默认值。 示例如下： ```python # -*- coding: UTF-8 -*- def print_info( a , b = [] ): print(b) return b ; result = print_info(1) result.append('error') print_info(2) ``` 输出的结果： ```txt [] ['error'] ``` 认真观察，你会发现第二次输出的值根本不是你想要的，因此切忌不能这样操作。 还有一点，有时候我就是不想要默认值啊，只是想单单判断默认参数有没有值传递进来，那该怎么办？ 我们可以这样做： ```python _no_value =object() def print_info( a , b = _no_value ): if b is _no_value : print('b 没有赋值') return; ``` 这里的 `object` 是 python 中所有类的基类。 你可以创建 `object` 类的实例，但是这些实例没什么实际用处，因为它并没有任何有用的方法， 也没有任何实例数据(因为它没有任何的实例字典，你甚至都不能设置任何属性值)。 你唯一能做的就是测试同一性。也正好利用这个特性，来判断是否有值输入。 ## 3、关键字参数（位置参数） ## 一般情况下，我们需要给函数传参的时候，是要按顺序来的，如果不对应顺序，就会传错值。 不过在 Python 中，可以通过参数名来给函数传递参数，而不用关心参数列表定义时的顺序，这被称之为关键字参数。 使用关键参数有两个优势 ： * 由于我们不必担心参数的顺序，使用函数变得更加简单了。 * 假设其他参数都有默认值，我们可以只给我们想要的那些参数赋值 具体看例子： ```python # -*- coding: UTF-8 -*- def print_user_info( name , age , sex = '男' ): # 打印用户信息 print(f'昵称：{name}' , end = ' ') print(f'年龄：{age}' , end = ' ') print(f'性别：{sex}') return; # 调用 print_user_info 函数 print_user_info( name = '两点水' ,age = 18 , sex = '女') print_user_info( name = '两点水' ,sex = '女', age = 18 ) ``` 输出的值： ```txt 昵称：两点水 年龄：18 性别：女 昵称：两点水 年龄：18 性别：女 ``` ## 4、不定长参数 ## 或许有些时候，我们在设计函数的时候，我们有时候无法确定传入的参数个数。 那么我们就可以使用不定长参数。 Python 提供了一种元组的方式来接受没有直接定义的参数。这种方式在参数前边加星号 `*` 。 如果在函数调用时没有指定参数，它就是一个空元组。我们也可以不向函数传递未命名的变量。 例如： ```python # -*- coding: UTF-8 -*- def print_user_info( name , age , sex = '男' , * hobby): # 打印用户信息 print(f'昵称：{name}' , end = ' ') print(f'年龄：{age}' , end = ' ') print(f'性别：{sex}' ,end = ' ' ) print(f'爱好：{hobby}') return; # 调用 print_user_info 函数 print_user_info( '两点水' ,18 , '女', '打篮球','打羽毛球','跑步') ``` 输出的结果： ```python 昵称：两点水 年龄：18 性别：女 爱好：('打篮球', '打羽毛球', '跑步') ``` 通过输出的结果可以知道，`*hobby`是可变参数，且 hobby 其实就是一个 tuple （元祖） 可变长参数也支持关键字参数（位置参数），没有被定义的关键参数会被放到一个字典里。 这种方式即是在参数前边加 `**`,更改上面的示例如下： ```python # -*- coding: UTF-8 -*- def print_user_info( name , age , sex = '男' , ** hobby ): # 打印用户信息 print(f'昵称：{name}' , end = ' ') print(f'年龄：{age}' , end = ' ') print(f'性别：{sex}' ,end = ' ' ) print(f'爱好：{hobby}') return; # 调用 print_user_info 函数 print_user_info( name = '两点水' , age = 18 , sex = '女', hobby = ('打篮球','打羽毛球','跑步')) ``` 输出的结果： ```txt 昵称：两点水 年龄：18 性别：女 爱好：{'hobby': ('打篮球', '打羽毛球', '跑步')} ``` 通过对比上面的例子和这个例子，可以知道，`*hobby`是可变参数，且 hobby其实就是一个 tuple （元祖），`**hobby`是关键字参数，且 hobby 就是一个 dict （字典） ## 5、只接受关键字参数 ## 关键字参数使用起来简单，不容易参数出错，那么有些时候，我们定义的函数希望某些参数强制使用关键字参数传递，这时候该怎么办呢？ 将强制关键字参数放到某个`*`参数或者单个`*`后面就能达到这种效果,比如： ```python # -*- coding: UTF-8 -*- def print_user_info( name , *, age , sex = '男' ): # 打印用户信息 print(f'昵称：{name}' , end = ' ') print(f'年龄：{age}' , end = ' ') print(f'性别：{sex}') return; # 调用 print_user_info 函数 print_user_info( name = '两点水' ,age = 18 , sex = '女' ) # 这种写法会报错，因为 age ，sex 这两个参数强制使用关键字参数 #print_user_info( '两点水' , 18 , '女' ) print_user_info('两点水',age='22',sex='男') ``` 通过例子可以看，如果 `age` , `sex` 不使用关键字参数是会报错的。 很多情况下，使用强制关键字参数会比使用位置参数表意更加清晰，程序也更加具有可读性。使用强制关键字参数也会比使用 `**kw` 参数更好且强制关键字参数在一些更高级场合同样也很有用。 ## 6、 Python 3.10+ 的类型注解写法 ## 各位童鞋，看了上面这么多种参数，大家有没有想过一个问题：函数光看名字和参数列表，我们其实并不知道每个参数到底是什么类型？ 比如下面这个函数，你能一眼看出 `name` 是字符串、 `age` 是整数吗？ ```python def print_user_info(name, age, sex='男'): print(f'昵称：{name} 年龄：{age} 性别：{sex}') ``` 调用的人很可能传错类型，传了一个 list 进去也不会报错，运行到一半才出问题。这时候，类型注解（type hint）就派上用场了。 我们先看最基本的写法： ```python def print_user_info(name: str, age: int, sex: str = '男') -> None: print(f'昵称：{name} 年龄：{age} 性别：{sex}') print_user_info('两点水', 18, '女') ``` 输出的结果： ``` 昵称：两点水 年龄：18 性别：女 ``` 参数后面的 `: str` 、`: int` ，以及箭头 `-> None` 都是类型注解。注意，Python 自己运行的时候 **不会** 强制检查这些注解——你硬传一个 list 也不会立刻报错。注解的真正用处，是给你和你的同事（还有 IDE、 mypy、 pyright 这些静态检查工具）看的，让代码更易读、更易维护。 那么遇到「这个参数可能是 None」的情况怎么办呢？ 在 Python 3.10 之前，要写 `Optional[str]` ： ```python from typing import Optional def find_user(name: str) -> Optional[str]: # 没找到就返回 None if name == '两点水': return '131456780002' return None print(find_user('两点水')) print(find_user('六点水')) ``` 输出的结果： ``` 131456780002 None ``` 这样写没毛病，但是要专门 `import` 一个东西，有点啰嗦。Python 3.10 之后，可以直接用 `|` 表示「或」（PEP 604）： ```python def find_user(name: str) -> str | None: if name == '两点水': return '131456780002' return None print(find_user('两点水')) print(find_user('六点水')) ``` 输出的结果： ``` 131456780002 None ``` 是不是干净多了？ `str | None` 直接读出来就是「字符串或者 None」，不再需要 `Optional` 这个名字。 那么 list、 dict 这种容器类型呢？ 在 Python 3.9 之前要从 `typing` 导入大写的 `List` 、 `Dict` ： ```python from typing import List, Dict def get_users() -> List[str]: return ['一点水', '两点水', '三点水'] def get_phones() -> Dict[str, str]: return {'两点水': '131456780002'} print(get_users()) print(get_phones()) ``` 而从 Python 3.9 开始（PEP 585），可以直接用内置的小写 `list` 、 `dict` 当类型注解： ```python def get_users() -> list[str]: return ['一点水', '两点水', '三点水'] def get_phones() -> dict[str, str]: return {'两点水': '131456780002'} print(get_users()) print(get_phones()) ``` 输出的结果都是： ``` ['一点水', '两点水', '三点水'] {'两点水': '131456780002'} ``` 这下连 `from typing import ...` 都省了，更简洁。 类型注解还可以用在「类」上面，比较常见的场景就是搭配 `dataclass` ： ```python from dataclasses import dataclass @dataclass class User: name: str age: int sex: str = '男' u = User('两点水', 18, '女') print(u) ``` 输出的结果： ``` User(name='两点水', age=18, sex='女') ``` `dataclass` 是个非常好用的东西，等到后面讲面向对象的时候，咱们再展开聊。 > Python 3.12+ ：`type` 关键字定义类型别名 最后再提一个 Python 3.12 的新东西（PEP 695）。如果你写了一个特别长的复合类型，每次都重复写不优雅，可以用 `type` 关键字给它起个别名： ```python type UserId = int | str type PhoneBook = dict[str, str] def find_phone(book: PhoneBook, name: str) -> str | None: return book.get(name) book: PhoneBook = {'两点水': '131456780002'} print(find_phone(book, '两点水')) ``` 输出的结果： ``` 131456780002 ``` 这里 `UserId` 和 `PhoneBook` 就是「类型别名」，跟变量赋值长得很像，但意思是「这是一个类型」。 类型注解的世界其实远不止这些，还有泛型、协议（Protocol）、 `TypeVar` 等等更高级的玩法，咱们这本书后面会专门拿出一章来讲，这里各位先掌握上面这几种最常用的就够日常写代码用了。