Python 中的 typing 模块常见用法

typing 模块是 Python 提供的一个标准库，重要用于为函数、变量和类定义类型提示（Type Hints），从而提高代码的可读性和类型安全性。虽然 Python 是动态类型语言，但通过 typing 模块，开发者可以明确指定变量和函数的参数、返回值的类型，资助 IDE 或静态代码分析工具提供更好的代码提示和错误查抄。虽然 Python 本身不会强制实行这些类型查抄，但借助 mypy 等工具，可以进行静态类型分析，资助发现潜伏问题。
源码位置：D:\Python310\Lib\typing.py

一.常见类型提示

1.List 和 Dict

用于表示列表和字典类型。
（1）List[type] 表示一个包含特定类型元素的列表。
（2）Dict[key_type, value_type] 表示键和值有特定类型的字典。
2.Tuple

表示一个包含特定类型的元组。Tuple[type1, type2] 表示一个包含两个特定类型的元组。
3.Optional

表示变量可以是某种类型，也可以是 None。Optional[type] 等价于 Union[type, None]，表示某个值可以是 type 或 None。
4.Union

表示一个变量可以是多个类型之一。Union[type1, type2, ...] 表示变量可以是 type1、type2 等中的任意一种。
5.Any

表示可以是任意类型。Any 用于声明一个变量可以是任意类型，不做类型查抄。
6.Callable

表示可调用的对象，如函数。Callable[[arg_type1, arg_type2], return_type] 用于表示一个函数，参数类型为 arg_type1、arg_type2，返回值类型为 return_type。
7.TypeVar

用于定义泛型。TypeVar 用于创建通用函数或类。
8.Literal

限定变量值为某些特定的值。
9.Set

表示一个包含特定类型元素的集合。比如 Set[str] 表示一个字符串集合。
10.FrozenSet

表示一个不可变的集合。比如 FrozenSet[int] 表示一个不可变的整数集合。
11.Generic

用于创建泛型类和泛型接口。比如 class MyList(Generic[T]) 表示一个泛型列表类，可以存储类型 T 的元素。
12.Type

表示一个类型对象。比如 Type[str] 表示 str 类型。


二.常见用法

1.List|Dict|Tuple示例

1. from typing import List, Dict, Tuple
3. # 一个返回包含字符串的列表的函数
4. def get_names() -> List[str]:
5.     return ["Alice", "Bob", "Charlie"]
7. # 一个带有字典类型提示的函数
8. def get_person_data() -> Dict[str, int]:
9.     return {"Alice": 30, "Bob": 25}
11. # 一个带有元组类型提示的函数
12. def get_coordinates() -> Tuple[int, int]:
13.     return (10, 20)

复制代码

• get_names()：返回一个 List[str]，即一个字符串列表。
  
• get_person_data()：返回一个 Dict[str, int]，表示字典的键是字符串，值是整数。
  
• get_coordinates()：返回一个 Tuple[int, int]，即一个包含两个整数的元组。
  

2.Optional 示例

1. from typing import Optional
3. def find_user(user_id: int) -> Optional[str]:
4.     if user_id == 1:
5.         return "Alice"
6.     return None

复制代码

find_user()：返回类型是 Optional[str]，表示可能返回字符串，或者返回 None。
3.Union 示例

1. from typing import Union
3. def process_input(data: Union[int, str]) -> str:
4.     if isinstance(data, int):
5.         return f"Received an integer: {data}"
6.     return f"Received a string: {data}"

复制代码

process_input()：参数类型是 Union[int, str]，表示该函数吸取整数或字符串两种类型。
4.Callable 示例

1. from typing import Callable
3. # 定义一个函数接收另一个函数作为参数
4. def execute_task(task: Callable[[int, int], int], a: int, b: int) -> int:
5.     return task(a, b)
7. # 示例调用
8. def add(x: int, y: int) -> int:
9.     return x + y
11. result = execute_task(add, 3, 4)  # 返回 7

复制代码

execute_task()：吸取一个可调用对象（函数），该对象吸取两个整数并返回一个整数。
5.TypeVar 泛型示例

1. from typing import TypeVar, List
3. T = TypeVar('T')
5. def get_first_element(lst: List[T]) -> T:
6.     return lst[0]
8. # 使用时可以是不同的类型
9. print(get_first_element([1, 2, 3]))      # 返回 1
10. print(get_first_element(['a', 'b', 'c']))  # 返回 'a'

复制代码

TypeVar：允许定义一个泛型函数 get_first_element，它可以适用于任何类型的列表。


三.高级用法

1.Literal 示例

1. from typing import Literal
3. def set_mode(mode: Literal['read', 'write']) -> None:
4.     if mode == 'read':
5.         print("Setting mode to read")
6.     elif mode == 'write':
7.         print("Setting mode to write")
9. set_mode('read')   # 合法
10. set_mode('write')  # 合法
11. set_mode('delete') # 非法，会被静态分析工具标记为错误

复制代码

Literal：限定传入的值必须是特定的字面值，在此例中只能是 'read' 或 'write'。
2.TypedDict示例

1. from typing import TypedDict
3. class User(TypedDict):
4.     name: str
5.     age: int
7. def get_user() -> User:
8.     return {"name": "Alice", "age": 30}

复制代码

TypedDict：用于定义字典的具体布局，使字典的键和值类型更加明确。
3.Protocol示例

用于定义接口协议，可以查抄对象是否实现了特定的方法和属性。

1. from typing import Protocol
3. class Drawable(Protocol):
4.     def draw(self) -> None:
5.         ...

复制代码

4.Final 示例

表示一个变量、方法或属性不能被重写或修改。

1. from typing import Final
3. MAX_SIZE: Final = 100

复制代码

5.ClassVar 示例

表示一个类变量，它不应被视为实例变量的一部门。

1. from typing import ClassVar
3. class MyClass:
4.     class_var: ClassVar[int] = 42

复制代码

6.NoReturn

表示函数不会返回任何值（通常用于函数抛出异常的情况）。

1. from typing import NoReturn
3. def terminate() -> NoReturn:
4.     raise SystemExit

复制代码

参考文献

[1] typing 对类型提示的支持：https://docs.python.org/zh-cn/3/library/typing.html
[2] https://github.com/python/mypy
[3] https://www.mypy-lang.org/


NLP工程化(星球号)

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。