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}")

⚠️ 重要注意事项

DubbingX智声云配
DubbingX智声云配

多情绪免费克隆AI音频工具

下载
  • ❌ 不要尝试用 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免费学习笔记(深入)”;

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

734

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

631

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

752

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

617

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1258

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

577

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

705

2023.08.11

Python 深度学习框架与TensorFlow入门
Python 深度学习框架与TensorFlow入门

本专题深入讲解 Python 在深度学习与人工智能领域的应用,包括使用 TensorFlow 搭建神经网络模型、卷积神经网络(CNN)、循环神经网络(RNN)、数据预处理、模型优化与训练技巧。通过实战项目(如图像识别与文本生成),帮助学习者掌握 如何使用 TensorFlow 开发高效的深度学习模型,并将其应用于实际的 AI 问题中。

4

2026.01.07

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.8万人学习

SciPy 教程
SciPy 教程

共10课时 | 1万人学习

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

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