0

0

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

聖光之護

聖光之護

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

|

343人浏览过

|

来源于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')

⚠️ 注意事项:

FILM
FILM

利用两张现有的图像,创建一个动画。

下载
  • __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免费学习笔记(深入)”;

相关专题

更多
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号