目录/第 43 章 · 类型注解与 typing
第 43 章 / 70 · 进阶 · 语法机制

类型注解与 typing

函数签名 / list[str] / Optional / Union / Callable / TypeVar / get_type_hints

先介绍1 个 demo6 个任务答案可展开

一、本章介绍

类型注解不强制检查,但能让编辑器提示更准、团队阅读更清楚,也是 FastAPI 等框架自动生成文档的基础。Python 3.9+ 推荐用内置泛型 list[str]、dict[str, int],不再需要从 typing 导入 List/Dict。

这一章从变量注解、函数签名讲起,再到 Optional/Union、Callable、类型别名和 get_type_hints 读取注解。所有例子都能直接运行。

本章要点

  • 变量与函数注解
  • list[str] / dict[str,int] 内置泛型
  • Optional 表示可为 None
  • Union 多类型
  • Callable 可调用对象
  • typing.get_type_hints 读取注解

二、先看 demo

下面这个例子把本章涉及的用法尽量全面地串了一遍,代码带逐行注释,可以直接复制到本地 .py 文件运行。

案例

先看一个完整例子

介绍 · 逐行注释
from typing import Optional, Union, Callable, TypeAlias, get_type_hints

# 1) 变量与函数注解(只是提示,不强制)
name: str = "小明"
nums: list[int] = [1, 2, 3]
scores: dict[str, int] = {"语文": 90}

def add(a: int, b: int) -> int:
    return a + b

print(add(1, 2), name, nums, scores)

# 2) Optional:可以是 T 或 None
def find(key: str) -> Optional[int]:
    return {"a": 1}.get(key)
print(find("a"), find("z"))

# 3) Union:多种类型之一
def show(x: Union[int, str]) -> str:
    return str(x)
print(show(3), show("hi"))

# 4) Callable:可调用对象
def apply(f: Callable[[int], int], x: int) -> int:
    return f(x)
print(apply(lambda n: n * 2, 5))

# 5) 类型别名 + TypeVar
Pair: TypeAlias = tuple[int, int]
def swap(p: Pair) -> Pair:
    return p[1], p[0]
print(swap((1, 2)))

# 6) 读取注解
print(get_type_hints(add))
运行结果
3 小明 [1, 2, 3] {'语文': 90}
1 None
3 hi
10
(2, 1)
{'a': <class 'int'>, 'b': <class 'int'>, 'return': <class 'int'>}

要点:注解不会在运行时检查类型,写错也不会报错——它主要服务编辑器和静态检查工具(mypy/pyright)。现代写法优先用 list[str] 而不是 List[str];Optional[int] 等价于 int | None。

三、6 个任务(自己先写,再看答案)

难度从入门到挑战逐步增加。每个任务的答案默认折叠,点开可看参考代码、运行结果;有第二种解法的也一并给出。代码都可以直接运行。

任务 1

函数注解

自己写 · 附答案入门 ★☆☆
解题提示:本题主要用到 变量与函数注解、list[str] / dict[str,int] 内置泛型、Optional 表示可为 None。先对照要求自己写一遍,卡住了再展开答案。

给函数加注解:接收 int 返回 str

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
def f(x: int) -> str:
    return str(x)
print(f(3))
运行结果
3
任务 2

list 泛型注解

自己写 · 附答案入门 ★☆☆
解题提示:本题主要用到 变量与函数注解、list[str] / dict[str,int] 内置泛型、Optional 表示可为 None。先对照要求自己写一遍,卡住了再展开答案。

声明 list[int] 变量并打印

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
nums: list[int] = [1,2,3]
print(nums)
运行结果
[1, 2, 3]
任务 3

Optional 注解

自己写 · 附答案进阶 ★★☆
解题提示:本题主要用到 变量与函数注解、list[str] / dict[str,int] 内置泛型、Optional 表示可为 None。先对照要求自己写一遍,卡住了再展开答案。

用 Optional[int] 标注可能返回 None 的函数

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from typing import Optional
def f(x: int) -> Optional[int]:
    return x if x>0 else None
print(f(1), f(-1))
运行结果
1 None
任务 4

Union 注解

自己写 · 附答案进阶 ★★☆
解题提示:本题主要用到 变量与函数注解、list[str] / dict[str,int] 内置泛型、Optional 表示可为 None。先对照要求自己写一遍,卡住了再展开答案。

用 Union[int,str] 标注参数

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from typing import Union
def f(x: Union[int,str]): return str(x)
print(f(1), f("a"))
运行结果
1 a
任务 5

Callable 注解

自己写 · 附答案挑战 ★★★
解题提示:本题主要用到 变量与函数注解、list[str] / dict[str,int] 内置泛型、Optional 表示可为 None。先对照要求自己写一遍,卡住了再展开答案。

用 Callable 标注函数参数并调用

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from typing import Callable
def apply(f: Callable[[int],int], x:int): return f(x)
print(apply(lambda a:a+1, 4))
运行结果
5
任务 6

读取注解

自己写 · 附答案挑战 ★★★
解题提示:本题主要用到 变量与函数注解、list[str] / dict[str,int] 内置泛型、Optional 表示可为 None。先对照要求自己写一遍,卡住了再展开答案。

用 get_type_hints 读取函数注解

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
from typing import get_type_hints
def f(a:int, b:str)->bool: return True
print(get_type_hints(f))
运行结果
{'a': <class 'int'>, 'b': <class 'str'>, 'return': <class 'bool'>}