0

0

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

霞舞

霞舞

发布时间:2025-12-29 20:36:28

|

444人浏览过

|

来源于php中文网

原创

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

本文介绍在 python 中通过自定义 `__class_getitem__` 实现类似 `array[t, n]` 的类型别名,使其在类型注解中语法简洁、语义清晰,同时兼容 `annotated` 的元数据能力。

在 Python 类型系统中,直接使用 type Array = Annotated[tuple[T, ...], int] 会报错,因为 Annotated 不支持泛型参数化(即不能作为可下标类型别名),且 type 语句仅支持泛型类型别名(如 type ListOfInt = list[int]),不支持含字面量参数(如 4)或运行时值的动态构造。

一种实用且符合 PEP 563 和类型检查器(如 mypy、pyright)约定的解决方案是:定义一个轻量级类,并重写其 __class_getitem__ 方法,使其在类型注解中被调用时返回所需的 Annotated 类型。

以下是完整实现:

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 expects exactly two arguments: Array[dtype, size]")
        dtype, size = params
        # 可选:校验 size 是否为正整数(仅用于文档/开发提示,不影响运行时)
        if not isinstance(size, int) or size <= 0:
            raise ValueError("Array size must be a positive integer")
        return Annotated[Tuple[dtype, ...], size]

# 使用示例
class MyIp:
    ip: Array[float, 4]  # ✅ 合法注解
    ports: Array[int, 2]  # ✅

⚠️ 重要注意事项:

  • 此方案纯属类型注解层面的“语法糖”,Array[float, 4] 在运行时立即求值为 Annotated[Tuple[float, ...], 4],因此 MyIp.__annotations__['ip'] 将是 Annotated[...],而非 Array[...];

    法语写作助手
    法语写作助手

    法语助手旗下的AI智能写作平台,支持语法、拼写自动纠错,一键改写、润色你的法语作文。

    下载
  • typing.get_type_hints(MyIp) 默认忽略 Annotated 的元数据,只返回 float(或 Tuple[float, ...],取决于 Python 版本和 include_extras=False/True 设置),因此不可用于运行时反射解析尺寸信息

  • 若需在运行时读取尺寸(如序列化/验证),应结合 __metadata__ 属性手动提取:

    from typing import get_args, get_origin
    
    def get_array_size(tp):
        if get_origin(tp) is Annotated:
            args = get_args(tp)
            if len(args) >= 2:
                return args[1]  # 元数据中的 size
        return None
    
    print(get_array_size(MyIp.__annotations__['ip']))  # 输出: 4

✅ 总结:该模式适合强调类型意图与文档表达力的场景(如 API Schema 注释、IDE 提示),但不替代运行时约束;如需强校验,建议配合 Pydantic v2 的 Annotated + Field(..., min_items=4, max_items=4) 或自定义 @dataclass_transform 工具链。

相关专题

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