讲师中心 微信公众号
AI工具推荐 视频效率加速

为 NumPy 数组子类正确标注 __getitem__ 方法的类型提示

胖宇小哥_5120

胖宇小哥_5120

发布时间:2026-05-28 19:45:02

|

737人浏览过

|

来源于php中文网

原创

为 NumPy 数组子类正确标注 __getitem__ 方法的类型提示

NumPy 的 ndarray 子类在运行时能保持类型(如切片返回原 subclass 实例),但静态类型检查器(如 Pyright)因缺乏泛型返回类型推导而报错;需手动重写 __getitem__ 并使用 Self 或协变泛型确保类型安全。

numpy 的 `ndarray` 子类在运行时能保持类型(如切片返回原 subclass 实例),但静态类型检查器(如 pyright)因缺乏泛型返回类型推导而报错;需手动重写 `__getitem__` 并使用 `self` 或协变泛型确保类型安全。

在 NumPy 中,通过 view() 机制实现的子类(如 ArraySubClass)天然支持“切片保留子类类型”的行为——这是由 ndarray.__getitem__ 在底层调用 __array_finalize__ 保证的。然而,类型检查器无法执行运行时逻辑,它仅依赖 .pyi 文件中定义的类型签名。当前 NumPy 官方类型存根(如 numpy/__init__.pyi)将 ndarray.__getitem__ 声明为:

def __getitem__(self, key: Union[
    NDArray[integer[Any]],
    NDArray[bool_],
    Tuple[Union[NDArray[integer[Any]], NDArray[bool_]], ...]
]) -> ndarray[Any, _DType_co]: ...

该签名明确返回 ndarray(基类),而非调用者实际类型(如 ArraySubClass)。因此,即使 x[:, 0] 运行时是 ArraySubClass 实例,Pyright 仍将其推断为 ndarray[Any, Any],导致形参类型不匹配错误。

✅ 正确解法:显式重写 __getitem__ 并标注 -> Self

自 Python 3.11 起,typing.Self 是解决此类“方法返回自身类型”问题的标准方案;对于更早版本,可使用 TypeVar 绑定到类本身。以下是推荐实现(兼容 Python ≥3.11):

import numpy as np
from typing import Self, Union, Tuple, Any

class ArraySubClass(np.ndarray):
    def __new__(cls, input_array: np.ndarray) -> Self:
        obj = np.asarray(input_array).view(cls)
        return obj

    def __getitem__(self, key: Union[
        np.ndarray,
        np.bool_,
        Tuple[Union[np.ndarray, np.bool_], ...]
    ]) -> Self:
        # 调用父类实现,保证行为一致
        result = super().__getitem__(key)
        # 强制视图转换为当前子类(运行时安全,且对类型检查器明确)
        if not isinstance(result, ArraySubClass):
            result = result.view(ArraySubClass)
        return result

? 关键点说明:

  • -> Self 明确告诉类型检查器:无论 key 是什么,只要输入是 ArraySubClass,输出必然是 ArraySubClass;
  • result.view(ArraySubClass) 在运行时确保类型一致性(尽管通常 __getitem__ 已返回子类,此步作为防御性保障);
  • 签名中 np.ndarray 和 np.bool_ 等类型应根据实际需求细化(例如用 np.ndarray[np.dtype[np.int64]]),此处为简洁示例。

⚠️ 注意事项与最佳实践

  • 不要盲目覆盖所有魔术方法:仅当类型检查器报错且影响开发体验时才重写 __getitem__;过度标注可能增加维护成本。

  • 避免 # type: ignore 滥用:临时压制错误会掩盖真实类型问题,应优先修复类型声明。

  • 验证类型检查效果:在重写后,Pyright 应不再报错:

    def f(x: ArraySubClass) -> None:
        print(x.shape)
    
    arr = ArraySubClass(np.zeros((3, 3)))
    f(arr[:, 0])  # ✅ 通过类型检查
  • 兼容旧 Python 版本:若需支持 Python <3.11,可用 from typing import TypeVar; Self = TypeVar('Self', bound='ArraySubClass') 替代,并在方法返回注解中使用 -> Self。

总之,这不是 Pyright 的 bug,而是 NumPy 类型存根设计上的历史局限。通过主动提供精准的 Self 返回类型,开发者可在不牺牲运行时行为的前提下,获得完整的静态类型安全保障。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

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

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

1571

2023.07.20

python能做什么
python能做什么

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

3764

2023.07.25

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

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

1589

2023.07.31

python教程
python教程

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

21677

2023.08.03

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

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

2667

2023.08.04

python eval
python eval

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

2727

2023.08.04

scratch和python区别
scratch和python区别

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

1103

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

60

2026.09.23

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn