0

0

如何为带尺寸注解的数组类型创建别名

花韻仙語

花韻仙語

发布时间:2025-12-29 19:42:45

|

297人浏览过

|

来源于php中文网

原创

如何为带尺寸注解的数组类型创建别名

本文介绍一种通过自定义 `__class_getitem__` 实现类型别名 `array[t, n]` 的技巧,使其在类型提示中等价于 `annotated[t, n]`,适用于文档化和静态类型检查场景,但需注意其运行时行为限制。

在 Python 类型系统中,直接使用 type Array = Annotated[tuple[T, ...], int] 会报错,因为 Annotated 不支持在类型别名中以泛型方式参数化(TypeError: Only generic type aliases are subscriptable)。根本原因在于:类型别名(type 语句)仅支持泛型类型构造器(如 list[T]、dict[K, V]),而 Annotated 本身不是泛型类型,其参数必须在运行时静态确定,无法延迟绑定类型变量 T 和整数字面量 N

不过,若目标仅为提升代码可读性与类型提示的表达力(例如标注“长度为 4 的浮点数数组”),可借助类的 __class_getitem__ 魔术方法实现轻量级伪泛型别名:

from typing import Annotated, TypeVar, Tuple

T = TypeVar("T")

class Array:
    def __class_getitem__(cls, params):
        if not isinstance(params, tuple) or len(params) != 2:
            raise TypeError("Array requires exactly two arguments: Array[dtype, size]")
        dtype, size = params
        # 返回 Annotated[dtype, size],供类型检查器识别
        return Annotated[dtype, size]

# 使用示例
class MyIp:
    ip: Array[float, 4]  # 等价于 Annotated[float, 4]
    ports: Array[int, 2]  # 等价于 Annotated[int, 2]

优势

Figma
Figma

Figma 是一款基于云端的 UI 设计工具,可以在线进行产品原型、设计、评审、交付等工作。

下载
  • 语法简洁直观,Array[float, 4] 比 Annotated[float, 4] 更具语义;
  • 兼容主流类型检查器(如 mypy、pyright),能正确解析并校验类型注解;
  • 无需引入第三方库,纯标准库方案。

⚠️ 关键限制(务必注意)

  • Array[float, 4] 在类定义时立即求值,MyIp.__annotations__['ip'] 实际存储的是 Annotated[float, 4],而非 Array[float, 4];
  • typing.get_type_hints(MyIp) 默认会剥离 Annotated 元数据,返回 {'ip': float} —— 若需保留尺寸信息,须显式传入 include_extras=True:
    from typing import get_type_hints
    hints = get_type_hints(MyIp, include_extras=True)
    # → {'ip': typing.Annotated[float, 4]}
  • 此方案不提供运行时数组长度验证(如 len(ip) == 4),纯属类型层面约定,实际数据仍需手动校验。

? 进阶建议
若需更强的运行时保障,可结合 typing_extensions.TypedDict(固定键名)、numpy.typing.NDArray(数值计算场景)或 Pydantic v2 的 Annotated + Field(..., min_length=4) 实现结构化约束。但对于轻量级类型文档需求,Array 类方案已足够清晰、低侵入且符合 PEP 563/593 规范。

总之,这是一种务实的“类型即文档”实践——用最小代价换取最大可读性,但须始终清醒区分:类型提示 ≠ 运行时契约

相关专题

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

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

711

2023.06.15

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

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

625

2023.07.20

python能做什么
python能做什么

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

737

2023.07.25

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

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

617

2023.07.31

python教程
python教程

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

1235

2023.08.03

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

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

547

2023.08.04

python eval
python eval

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

573

2023.08.04

scratch和python区别
scratch和python区别

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

696

2023.08.11

俄罗斯搜索引擎Yandex最新官方入口网址
俄罗斯搜索引擎Yandex最新官方入口网址

Yandex官方入口网址是https://yandex.com;用户可通过网页端直连或移动端浏览器直接访问,无需登录即可使用搜索、图片、新闻、地图等全部基础功能,并支持多语种检索与静态资源精准筛选。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1

2025.12.29

热门下载

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

精品课程

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

共4课时 | 0.6万人学习

Django 教程
Django 教程

共28课时 | 2.5万人学习

SciPy 教程
SciPy 教程

共10课时 | 0.9万人学习

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

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