Python typing.Annotated 的元数据怎么在运行时读取
来源:17golang原创
时间:2026-09-10 03:27:42 347浏览 收藏
如果你在运行时读取 Python 的类型注解,直接调用 get_type_hints() 往往只能看到 int、str 这样的基础类型。原因不是 Annotated 丢了,而是这个函数默认会移除额外元数据。把调用改成 get_type_hints(target, include_extras=True),再从返回的 Annotated 对象读取 __metadata__,即可拿到原始标记。
官方文档:https://docs.python.org/3/library/typing.html
include_extras=True是保留Annotated元数据的关键开关。get_origin()识别外层构造,get_args()拆出参数,__origin__和__metadata__分别读取被包裹类型与元数据。- 元数据只是给工具消费的附加信息,Python 不会自动按它做运行时校验。
先复现:默认读取为什么只剩基础类型
先定义一个带业务标记的函数。这里的字符串和字典只是示例元数据,真正的解释规则仍由你的框架或工具决定。
from typing import Annotated, get_type_hints
def create_user(user_id: Annotated[int, "主键", {"positive": True}],
email: Annotated[str, "邮箱格式"]) -> None:
# 函数体不负责校验;本例只观察注解在运行时的形态。
pass
plain = get_type_hints(create_user)
full = get_type_hints(create_user, include_extras=True)
print(plain["user_id"]) #
print(full["user_id"]) # typing.Annotated[int, '主键', {'positive': True}]
print(full["user_id"].__metadata__) # ('主键', {'positive': True})
plain 适合只关心类型检查的场景;反射式参数校验、接口文档或依赖注入工具则必须使用 full。注意,Annotated 里的元数据不会自动触发校验,工具需要自己约定如何解释它。
用 include_extras 让元数据留在运行时
get_type_hints() 会返回一个以参数名为键的字典。对函数、方法或类读取时,先开启 include_extras=True,再判断某个值的外层是否为 Annotated。

from typing import Annotated, get_args, get_origin, get_type_hints
def read_annotated(target: object) -> list[dict[str, object]]:
# 返回每个 Annotated 参数的基础类型和元数据,便于后续工具消费。
hints = get_type_hints(target, include_extras=True)
found = []
for name, annotation in hints.items():
if get_origin(annotation) is not Annotated:
continue
base, *metadata = get_args(annotation)
found.append({
"name": name,
"base": base,
"metadata": tuple(metadata),
})
return found
for item in read_annotated(create_user):
# 业务层可以按元数据类型分派,而不是依赖字符串格式猜测。
print(item["name"], item["base"], item["metadata"])
这里用 get_args() 拆分更适合通用代码:第一个参数是被注解的类型,后面的参数按原顺序组成元数据。若只需要快速读取,也可以直接访问 annotation.__metadata__。
区分原始类型、容器和嵌套元数据
最容易混淆的是 get_origin() 和 __origin__:对 Annotated[int, ...] 来说,前者返回 Annotated,后者返回 int。不要用 get_origin(annotation) is int 判断基础类型。
| 检查方式 | 得到的内容 | 适合场景 |
|---|---|---|
get_origin(a) | 外层构造,例如 Annotated 或 list | 判断需要怎样拆包 |
get_args(a) | 类型参数和元数据参数 | 写可复用的解析器 |
a.__origin__ | Annotated 包裹的原始类型 | 快速读取基础类型 |
a.__metadata__ | 元数据元组,顺序保留 | 读取约束、描述或标记 |

当注解是 list[Annotated[int, "编号"]] 时,最外层是 list,不能在第一层直接取 __metadata__。应先用 get_args() 取得列表元素,再递归检查元素注解:
from typing import Any, Annotated, get_args, get_origin
def collect_metadata(annotation: Any) -> list[tuple[Any, tuple[Any, ...]]]:
# 递归穿过 list、dict 等容器,只收集实际出现的 Annotated 层。
if get_origin(annotation) is Annotated:
args = get_args(annotation)
return [(args[0], tuple(args[1:]))]
result = []
for child in get_args(annotation):
result.extend(collect_metadata(child))
return result
嵌套的 Annotated 会被 Python 展平,元数据顺序从内层开始;重复的元数据不会自动去重。业务代码不要假设元数据一定是字符串,也不要擅自改变其顺序。
把读取逻辑封装起来,再处理真实项目边界
项目里建议把反射集中在一个小函数中:统一开启 include_extras,统一返回结构,并对前向引用解析失败保留清晰异常。get_type_hints() 可能执行注解中的表达式,因此不要对不可信对象随意反射。
from typing import Annotated, get_origin, get_type_hints
def describe_target(target: object) -> list[dict[str, object]]:
# 集中处理反射,调用方只消费稳定的数据结构。
hints = get_type_hints(target, include_extras=True)
result = []
for name, annotation in hints.items():
if get_origin(annotation) is Annotated:
result.append({
"name": name,
"annotation": annotation,
"base_type": annotation.__origin__,
"metadata": annotation.__metadata__,
})
return result
如果代码使用 from __future__ import annotations 或字符串形式的前向引用,确保相关名称在可解析的全局或局部命名空间中。读取类时还要记住,get_type_hints() 会合并继承链上的类注解;如果只想看当前类的原始字典,应另行读取 __annotations__,但那样不会替你解析前向引用。
相关问题
Annotated 会自动检查值是否符合元数据吗?
不会。它只把额外信息附着到类型上,校验规则需要由你或使用它的库实现。
为什么 get_origin(Annotated[int, "id"]) 不是 int?
因为 get_origin() 返回的是最外层构造 Annotated;要取被包裹的 int,使用 __origin__ 或 get_args() 的第一个元素。
元数据只有一个字符串吗?
不是。Annotated 支持多个元数据项,__metadata__ 返回按声明顺序排列的元组,工具应自行决定哪些项有意义。
实际排查时可以记成一句话:先用 include_extras=True 保留信息,再用 get_origin() 判断包装层,最后用 get_args() 或属性读取基础类型与元数据。这样既不会把注解当成运行时校验器,也能给反射工具留下稳定入口。
-
346 收藏
-
235 收藏
-
387 收藏
-
447 收藏
-
360 收藏
-
496 收藏
-
文章 · python教程 | 13小时前 | 命令行工具 · 子命令 · Python教程 · argparse · Python argparse 子命令 argparse subparsers 公共参数427 收藏
-
163 收藏
-
469 收藏
-
386 收藏
-
文章 · python教程 | 20小时前 | Windows · 跨平台 · Python教程 · 文件系统 · Python Python 3.15 os.path.isreserved Windows 保留路径 ntpath343 收藏
-
文章 · python教程 | 21小时前 | Python教程 · pathlib · 文件系统 · 版本兼容 · Python 目录权限 Python 3.15 pathlib.Path.mkdir parent_mode243 收藏
-
260 收藏
-
217 收藏
-
文章 · python教程 | 1天前 | python · risc-v · Python 3.15 · riscv64 · 原生扩展 · Python打包 · RISC-V wheel Python 3.15 riscv64 Python扩展493 收藏
-
388 收藏
-
236 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习