Python的类型注解：Type Hints

Python的类型注解：Type Hints

Python 的类型注解（Type Hints）是指在 Python 代码中为变量、函数参数、返回值等添加类型信息的一种语法特性。它是在 Python 3.5 中引入的（通过 PEP 484），目的是提高代码的可读性、可维护性，并方便静态类型检查工具（如 mypy）分析代码的正确性。

类型注解并不会影响 Python 的运行时行为，因为 Python 是一门动态类型语言，类型注解只是“提示”性质的元数据，解释器在运行时会忽略它们。开发者可以用它们来表达代码的意图，或者通过工具在开发阶段捕获潜在的类型错误。

基本用法

类型注解通常用冒号 : 表示变量或参数的类型，用 -> 表示函数返回值的类型。例如：

# 变量注解
x: int = 10
name: str = "Alice"

# 函数参数和返回值注解
def add(a: int, b: int) -> int:
    return a + b

在这个例子中：

• a: int 表示参数 a 预期是整数。
• b: int 表示参数 b 预期是整数。
• -> int 表示函数返回值的类型是整数。

常见类型

Python 的类型注解支持内置类型（如 int、str、float、bool、list 等），也可以使用 typing 模块来表示更复杂的类型，例如：

List、Dict、Tuple、Set：表示容器类型。
Optional：表示可能为 None 的类型。
Union：表示多种可能的类型。
Any：表示任意类型。
示例：

from typing import List, Dict, Optional, Union

# 列表类型
def process_items(items: List[int]) -> None:
    for item in items:
        print(item)

# 可选类型（可能为 None）
def get_name(id: int) -> Optional[str]:
    return "Alice" if id > 0 else None

# 联合类型（可以是多种类型之一）
def print_value(value: Union[int, str]) -> None:
    print(value)

• 优点
  • 提高可读性：通过类型注解，开发者可以快速理解变量或函数的预期用途。
  • 工具支持：静态类型检查工具（如 mypy、PyCharm 的类型检查）可以发现类型不匹配的问题。
  • 团队协作：在大型项目中，类型注解能减少误解和错误。
• 注意事项
  • 类型注解是可选的，不写也不会影响代码运行。
  • 运行时可以通过 .__annotations__ 属性查看注解，但不会强制执行类型检查。
  • 如果需要动态特性，仍然可以无视注解，因为 Python 不会在运行时强制类型约束。
    例如：

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

print(add("1", "2"))  # 输出 "12"，尽管注解要求 int，但运行时不会报错

Python 的类型注解是一种“自文档化”工具，主要服务于开发者，而不是强制类型系统。

PS:annotations

.__annotations__ 是一个特殊的属性，用于存储函数或类的类型注解。它以字典的形式返回，键是参数名或返回值（用 ‘return’ 表示），值是对应的类型注解。。这个属性在运行时可以访问，但不会影响程序的执行。

# 定义一个带有类型注解的函数
def greet(name: str, age: int) -> str:
    return f"Hello, {name}! You are {age} years old."

# 查看函数的类型注解
print(greet.__annotations__)

# 调用函数（注解不会影响运行时行为）
print(greet("Alice", 25))
print(greet(123, "30"))  # 类型不匹配，但依然可以运行

输出结果

{'name': <class 'str'>, 'age': <class 'int'>, 'return': <class 'str'>}
Hello, Alice! You are 25 years old.
Hello, 123! You are 30 years old.

greet.__annotations__返回一个字典，其中：

• ‘name’: <class ‘str’> 表示参数 name 的注解是 str。
• ‘age’: <class ‘int’> 表示参数 age 的注解是 int。
• ‘return’: <class ‘str’> 表示返回值的注解是 str。
  这个字典是由 Python 在函数定义时自动生成的。运行时行为:即使我们传递了不符合注解的参数（比如 123 给 name，“30” 给 age），代码依然能运行，因为类型注解只是提示，不强制执行。