0

0

如何在 Python 中访问 Annotated 类型提示的元数据属性

霞舞

霞舞

发布时间:2026-01-05 21:17:03

|

387人浏览过

|

来源于php中文网

原创

如何在 Python 中访问 Annotated 类型提示的元数据属性

本文介绍如何通过 __metadata__ 属性安全、标准地提取 typing.annotated 类型注解中携带的自定义元数据(如文档对象、校验规则或配置实例),避免字符串化陷阱,实现运行时类型增强功能。

在 Python 3.9+ 中,typing.Annotated 提供了一种标准化方式,为类型添加任意元数据(metadata),而这些元数据在运行时并非被丢弃或转为字符串,而是以元组形式完整保留在类型对象的 __metadata__ 属性中。这使得你可以在反射(reflection)场景下(如自动生成 API 文档、参数校验、序列化配置等)可靠地访问它们。

以下是一个完整示例,展示如何从 Annotated[str, B(x="foo")] 中提取并使用 B 实例:

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

@dataclass
class B:
    x: str

@dataclass
class A:
    y: Annotated[str, B(x="foo"), "This is a user-facing description"]

# 获取运行时解析后的注解字典(推荐:使用 get_type_hints 或 inspect.get_annotations)
annotations = inspect.get_annotations(A, eval_str=True)
annotated_type = annotations["y"]

# ✅ 正确方式:访问 __metadata__ 属性(标准、稳定、无需解析字符串)
if hasattr(annotated_type, "__metadata__"):
    metadata = annotated_type.__metadata__  # 类型:tuple
    print("Metadata tuple:", metadata)           # 输出: (B(x='foo'), 'This is a user-facing description')

    # 提取第一个元数据项(即 B 实例)
    if metadata and isinstance(metadata[0], B):
        b_instance = metadata[0]
        print("B.x =", b_instance.x)              # 输出: B.x = foo

    # 可遍历所有元数据(支持多个标签)
    for i, item in enumerate(metadata):
        print(f"Metadata[{i}]: {type(item).__name__} = {item}")

⚠️ 重要注意事项

MakeSong
MakeSong

AI音乐生成,生成高质量音乐,仅需30秒的时间

下载
  • ❌ 不要尝试用 str()、正则或 eval() 解析 repr(annotated_type) —— 这是脆弱且不安全的;
  • ✅ __metadata__ 是官方定义的公有协议属性(见 Python 官方文档),保证在所有兼容实现中可用;
  • ? 若需获取原始 Annotated 的所有参数(包括基础类型),可使用 get_args(annotated_type),它返回 (str, B(x="foo"), "description");但 __metadata__ 更语义明确,专用于元数据;
  • ? inspect.get_annotations(..., eval_str=True) 是推荐方式,确保字符串化注解(如 "str")被正确求值,避免 ForwardRef 问题。

总结来说,Annotated[T, meta1, meta2] 的设计初衷就是支持运行时元编程——__metadata__ 就是你通往类型“附加信息”的标准接口。善用它,即可构建类型驱动的文档生成器、验证框架或配置绑定系统,真正实现「类型即配置」。

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

718

2023.08.03

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

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

219

2023.09.04

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

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

1561

2023.10.24

字符串介绍
字符串介绍

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

647

2023.11.24

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

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

1148

2024.03.22

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

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

1122

2024.04.29

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

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

188

2025.07.29

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

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

111

2025.08.07

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

4

2026.03.05

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.5万人学习

Django 教程
Django 教程

共28课时 | 4.8万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号