0

0

Python类型注解:运行时高效剥离Annotated获取纯净裸类型

DDD

DDD

发布时间:2025-11-05 11:43:00

|

622人浏览过

|

来源于php中文网

原创

Python类型注解:运行时高效剥离Annotated获取纯净裸类型

当在python中使用`typing.annotated`时,复杂的类型提示可能会因元数据而变得冗长。本教程旨在解决如何从深度嵌套的`annotated`结构中提取底层“裸”类型,而不改变原始定义。我们将介绍一个强大的递归函数,它能在运行时遍历类型提示树,有效剥离`annotated`包装器,从而得到一个干净、无注解的类型表示,这对于需要纯粹类型内省的场景至关重要。

理解typing.Annotated及其挑战

typing.Annotated是Python 3.9引入的一个强大工具,它允许开发者在类型提示中添加上下文特定的元数据,而不会影响类型检查器对基础类型的处理。例如,我们可以定义一个带有描述的3D点类型:

from typing import Annotated, tuple, list

Point3D = Annotated[tuple[float, float, float], "A 3D Point"]
Points = Annotated[list[Point3D], "A collection of points"]

然而,当我们需要获取这些类型的“纯净”表示时,Annotated及其元数据可能会带来困扰。直接打印Points会显示所有嵌套的注解:

typing.Annotated[list[typing.Annotated[tuple[float, float, float], 'A 3D Point']], 'A collection of points']

在某些场景下,例如生成API文档、进行运行时类型检查或序列化时,我们可能只需要list[tuple[float, float, float]]这样的裸类型,而不需要任何注解信息。

为什么简单的get_args不足以解决问题

typing模块提供了get_args函数,用于获取泛型类型的参数。尝试使用get_args(Points)[0]可以移除最外层的Annotated,但它无法深入处理嵌套的Annotated:

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

# 假设 Points = Annotated[list[Annotated[tuple[float, float, float], 'A 3D Point']], 'A collection of points']
# get_args(Points)[0] 结果会是:
# list[typing.Annotated[tuple[float, float, float], 'A 3D Point']]

正如所见,内部的'A 3D Point'注解依然存在,这表明我们需要一种更全面的方法来递归地剥离所有注解。

Bardeen AI
Bardeen AI

使用AI自动执行人工任务

下载

递归剥离Annotated的解决方案

解决此问题的关键在于递归地遍历类型提示的结构(可以将其视为一个类型树),并在遇到Annotated节点时,将其替换为其基础类型(即Annotated的第一个参数)。typing模块中的get_origin和get_args函数是实现这一遍历的基石。

  • get_origin(type_object): 返回泛型类型(如list[int])的原始类型(如list)。对于非泛型类型,返回None。
  • get_args(type_object): 返回泛型类型的所有类型参数(如list[int]的int)。

下面是实现这一功能的递归函数:

from typing import Annotated, get_args, get_origin, Any

def convert_annotated_to_bare_types(type_object: Any) -> Any:
  """
  递归地将类型提示中的所有 typing.Annotated 包装器替换为其基础类型。

  参数:
    type_object: 待处理的类型对象。

  返回:
    移除了所有 Annotated 包装器的纯净类型对象。
  """
  # 获取类型对象的原始类型(如 list[int] 的 list)和参数(如 int)
  origin, args = get_origin(type_object), get_args(type_object)

  # 情况1: 如果没有原始类型,说明这不是一个泛型类型(如 int, str, float)
  # 或者是一个普通的非泛型类。直接返回它本身。
  if origin is None:
    return type_object

  # 情况2: 如果原始类型是 Annotated,说明我们遇到了一个注解类型。
  # Annotated 的第一个参数是其基础类型,我们递归处理这个基础类型。
  if origin is Annotated:
    bare_type = get_args(type_object)[0] # 获取 Annotated 的第一个参数(即裸类型)
    return convert_annotated_to_bare_types(bare_type)

  # 情况3: 如果是其他泛型类型(如 list, dict, Union, Optional 等)
  # 我们需要递归处理它的所有类型参数。
  converted_args = [
    convert_annotated_to_bare_types(arg) for arg in args
  ]

  # 使用原始类型和处理后的参数重新构造泛型类型。
  # 例如,list[*converted_args] 会重构为 list[处理后的参数]
  return origin[*converted_args]

示例与应用

让我们使用之前定义的Points类型来测试这个函数:

# 重新定义示例类型
Point3D = Annotated[tuple[float, float, float], "A 3D Point"]
Points = Annotated[list[Point3D], "A collection of points"]

# 使用函数转换
bare_points_type = convert_annotated_to_bare_types(Points)

print(f"原始类型: {Points}")
print(f"转换后的裸类型: {bare_points_type}")

输出结果将是:

原始类型: typing.Annotated[list[typing.Annotated[tuple[float, float, float], 'A 3D Point']], 'A collection of points']
转换后的裸类型: list[tuple[float, float, float]]

这正是我们期望的结果,所有嵌套的Annotated及其元数据都被成功移除了。

注意事项与总结

  1. 运行时操作: convert_annotated_to_bare_types是一个运行时函数,它在程序执行时检查并转换类型对象。它不会修改源代码或类型检查器的行为。
  2. 不改变原始定义: 此函数是纯粹的,它返回一个新的类型对象,而不会改变传入的原始Annotated类型定义。这意味着你仍然可以在需要元数据的地方使用原始的Annotated类型。
  3. 适用场景:
    • API文档生成: 当你希望在文档中显示简洁的类型签名,而不包含内部注解元数据时。
    • 数据验证/序列化: 在需要根据纯粹的类型结构进行数据验证或序列化(如Pydantic模型)时,可以先剥离注解。
    • 自定义类型检查: 当构建自己的运行时类型检查工具,且需要忽略Annotated元数据时。
  4. Any类型处理: 对于Any类型,get_origin返回None,get_args返回(),函数会直接返回Any,行为符合预期。

通过这种递归遍历和替换的方法,我们可以有效地管理和利用typing.Annotated的强大功能,同时又能根据需要获取纯净的类型表示,极大地增强了Python类型提示的灵活性和实用性。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
css中float用法
css中float用法

css中float属性允许元素脱离文档流并沿其父元素边缘排列,用于创建并排列、对齐文本图像、浮动菜单边栏和重叠元素。想了解更多float的相关内容,可以阅读本专题下面的文章。

594

2024.04.28

C++中int、float和double的区别
C++中int、float和double的区别

本专题整合了c++中int和double的区别,阅读专题下面的文章了解更多详细内容。

105

2025.10.23

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

930

2023.08.02

int占多少字节
int占多少字节

int占4个字节,意味着一个int变量可以存储范围在-2,147,483,648到2,147,483,647之间的整数值,在某些情况下也可能是2个字节或8个字节,int是一种常用的数据类型,用于表示整数,需要根据具体情况选择合适的数据类型,以确保程序的正确性和性能。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

603

2024.08.29

c++怎么把double转成int
c++怎么把double转成int

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

294

2025.08.29

C++中int的含义
C++中int的含义

本专题整合了C++中int相关内容,阅读专题下面的文章了解更多详细内容。

212

2025.08.29

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

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

2

2026.03.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

58

2026.03.04

AI安装教程大全
AI安装教程大全

2026最全AI工具安装教程专题:包含各版本AI绘图、AI视频、智能办公软件的本地化部署手册。全篇零基础友好,附带最新模型下载地址、一键安装脚本及常见报错修复方案。每日更新,收藏这一篇就够了,让AI安装不再报错!

31

2026.03.04

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新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号