0

0

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

花韻仙語

花韻仙語

发布时间:2026-01-05 22:51:02

|

835人浏览过

|

来源于php中文网

原创

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

本文介绍如何通过 `annotated.__metadata__` 属性安全、标准地提取类型注解中携带的自定义元数据(如文档对象、验证规则等),避免字符串化陷阱,适用于生成 api 文档、运行时校验等场景。

在 Python 3.9+ 中,typing.Annotated 提供了一种标准化方式,为类型添加任意元数据(metadata),而这些元数据并非类型本身的一部分,而是作为额外信息附着在类型上。关键在于:Annotated 类型对象暴露了 __metadata__ 属性,它是一个只读元组,包含除基础类型外的所有后续参数——这正是访问你传入的 B(x="foo") 实例的正确入口。

以下是一个完整、可运行的示例:

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

@dataclass
class B:
    x: str

@dataclass
class A:
    y: Annotated[str, B(x="foo"), "A descriptive tag"]

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

# 提取 Annotated 类型
annotated_type = annotations["y"]

# ✅ 正确方式:访问 __metadata__ 属性
if hasattr(annotated_type, '__metadata__'):
    metadata = annotated_type.__metadata__
    print("Metadata tuple:", metadata)  # 输出: (B(x='foo'), 'A descriptive tag')

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

⚠️ 注意事项:

京点点
京点点

京东AIGC内容生成平台

下载
  • __metadata__ 是 Annotated 类型对象的实例属性,仅当类型确实是 Annotated[...] 时才存在;务必先用 hasattr(..., '__metadata__') 或 isinstance(..., types.GenericAlias) + 检查 __origin__ is Annotated 做安全判断;
  • inspect.get_annotations(..., eval_str=True) 是获取已求值注解的推荐方式(尤其含字符串前向引用时),但需确保模块上下文可用;
  • 不要尝试通过 str() 或 repr() 解析注解字符串——这不可靠且易受格式变更影响;
  • 若需批量处理(如框架级文档生成),建议封装工具函数:
def get_annotated_metadata(tp):
    """安全提取 Annotated 元数据,返回 None 若非 Annotated 类型"""
    if hasattr(tp, '__metadata__') and hasattr(tp, '__origin__') and tp.__origin__ is Annotated:
        return tp.__metadata__
    return None

# 使用示例
meta = get_annotated_metadata(annotations["y"])
if meta:
    for item in meta:
        print("Metadata item:", item)

总结:Annotated.__metadata__ 是官方支持、稳定可靠的元数据访问机制,是构建类型驱动文档、校验、序列化等高级功能的基础。始终优先使用该属性而非字符串操作或 AST 解析,以保证代码健壮性与可维护性。

立即学习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号