讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在 Python 中提取 Annotated 类型提示中的元数据信息

云辰小哥_6069

云辰小哥_6069

发布时间:2026-01-05 21:25:00

|

403人浏览过

|

来源于php中文网

原创

如何在 Python 中提取 Annotated 类型提示中的元数据信息

本文介绍如何通过 `__metadata__` 属性安全、准确地访问 `typing.annotated` 类型注解中嵌入的自定义对象(如文档类、验证器或配置实例),避免字符串化陷阱,实现运行时元数据读取与使用。

在 Python 3.9+ 中,typing.Annotated 提供了一种为类型添加任意元数据的标准化方式。它不仅支持类型检查器识别基础类型(第一个参数),还将后续所有参数统一存储在 __metadata__ 元组中——这正是提取自定义对象(如文档类、校验规则或配置实例)的关键入口。

以下是一个完整示例,展示如何从 Annotated 注解中获取并使用元数据:

from typing import Annotated, get_args
import inspect
from dataclasses import dataclass

@dataclass
class Doc:
    description: str
    required: bool = True

@dataclass
class A:
    name: Annotated[str, Doc("用户姓名", required=True)]
    age: Annotated[int, Doc("用户年龄", required=False), "unit: years"]

# 获取运行时注解(自动求值字符串化注解)
annotations = inspect.get_annotations(A, eval_str=True)

# 提取 'name' 字段的 Annotated 类型
annotated_type = annotations["name"]

# ✅ 正确方式:访问 __metadata__ 属性(返回 tuple)
metadata = annotated_type.__metadata__
print(metadata)  # (Doc(description='用户姓名', required=True),)

# 获取第一个元数据对象(通常为文档类)
doc_obj = metadata[0]
print(doc_obj.description)  # 输出:用户姓名

# 同样适用于多参数场景(如 age 字段)
age_annotated = annotations["age"]
print(age_annotated.__metadata__)  # (Doc(description='用户年龄', required=False), 'unit: years')

⚠️ 注意事项:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • __metadata__ 是 Annotated 的只读公有属性,由标准库保证存在,无需导入额外模块;
  • inspect.get_annotations(..., eval_str=True) 是关键:若注解以字符串形式存在(如 Annotated["str", ...]),必须启用 eval_str=True 才能获得真实类型对象,否则 __metadata__ 不可用;
  • 不要尝试用 getattr(annotated_type, '__args__', []) 或 get_args() 替代 __metadata__——get_args(Annotated[T, x, y]) 返回 (T, x, y),会混入基础类型,而 __metadata__ 精确排除第一个参数,语义更清晰、更安全;
  • 元数据对象本身需支持序列化/持久化(如 dataclass 或 NamedTuple),若含不可序列化状态(如 lambda、文件句柄),将影响调试与文档生成。

总结:Annotated[T, meta1, meta2].__metadata__ 是官方推荐、稳定可靠的元数据访问机制,适用于构建类型驱动的文档生成器、参数校验框架或 API 描述工具。掌握它,即可将类型注解真正转化为可执行的程序逻辑与用户友好的上下文信息。

立即学习“Python免费学习笔记(深入)”;

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

1818

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2864

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

6184

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

5989

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

7594

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

11354

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

5839

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

6427

2025.08.07

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn