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

如何通过Python的__getitem__方法让自定义类支持索引操作?

夏伟同学_3185

夏伟同学_3185

发布时间:2026-07-08 07:45:48

|

830人浏览过

|

来源于php中文网

原创

__getitem__ 方法使实例支持方括号取值,触发于索引、切片及 in 操作(未定义 __contains__ 时),参数 key 类型自定义,需主动抛出 IndexError 或 KeyError,切片传入 slice 对象,负索引需手动处理,典型实现需分支判断 int 和 slice 并返回同类型结果。

如何通过python的__getitem__方法让自定义类支持索引操作?

__getitem__ 方法的基本写法和触发条件

只要在类里定义了 __getitem__,实例就能用方括号取值,比如 obj[0] 或 obj['key']。它不依赖 __iter__ 或长度信息,Python 在遇到索引、切片、in 操作(当没定义 __contains__ 时)都会调用它。

注意:参数 key 是你写在方括号里的东西,类型完全由你决定——可以是 int、str、slice,甚至自定义对象。

  • 如果 key 类型非法或超出范围,应主动抛出 IndexError 或 KeyError,别让 Python 报 TypeError: 'xxx' object is not subscriptable
  • 切片传进来的是 slice 对象,不是元组,别用 key[0] 去拆
  • 支持负索引需自行处理,Python 不会自动转换

支持整数索引和切片的典型实现

多数容器类(如模拟 list)需要处理 int 和 slice 两种 key。关键在于识别 isinstance(key, slice),并返回同类型结果(切片返回新实例或子列表)。

class MyList:
    def __init__(self, data):
        self._data = list(data)
<pre class="brush:php;toolbar:false;">def __getitem__(self, key):
    if isinstance(key, int):
        # 处理负索引
        if key < 0:
            key += len(self._data)
        if not 0 <= key < len(self._data):
            raise IndexError("index out of range")
        return self._data[key]
    elif isinstance(key, slice):
        return MyList(self._data[key])  # 返回新实例,保持链式操作
    else:
        raise TypeError(f"invalid index type: {type(key).__name__}")

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

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • 返回 MyList 而非 list,才能继续用 [...][...]
  • 没做 step != 1 的特殊优化,但 self._data[key] 本身已支持
  • 没实现 __len__ 不影响索引,但 len(obj) 会失败

支持字符串键的字典式访问

想让类像 dict 一样用 obj['name'],__getitem__ 直接查内部字典或属性即可,但要注意错误类型:

  • 查不到该 key 应抛 KeyError,不是 IndexError
  • 若同时支持数字索引和字符串键,需在方法内分支判断 isinstance(key, (int, str)) 等
  • 避免把所有属性都暴露出去——显式维护一个 _mapping 字典比用 getattr(self, key) 更安全

示例片段:

def __getitem__(self, key):
    if isinstance(key, str):
        if key not in self._fields:
            raise KeyError(f"no field named '{key}'")
        return getattr(self, key)
    elif isinstance(key, int):
        return self._data[key]  # 同前
    else:
        raise TypeError(...)

容易被忽略的兼容性细节

很多初学者以为写了 __getitem__ 就万事大吉,实际几个隐性坑常导致行为异常:

  • for x in obj: 会先尝试 __iter__,失败才回退到 __getitem__(从 0 开始调用直到 IndexError),所以没有 __iter__ 时循环性能差且不支持 break 早停
  • obj[1:3] 若返回普通 list,后续就不能再索引(obj[1:3][0] 可以,但 obj[1:3].append(...) 会报错)
  • NumPy 或 pandas 的数组协议(__array__)可能绕过 __getitem__,调试时注意实际调用栈

真正要用好,得配合 __len__、__iter__、__contains__ 一起设计,单点补丁容易翻车。

热门AI工具

更多
Loomy
Loomy Hot

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

DeepSeek

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

蛙蛙写作

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

豆包大模型

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

WorkBuddy

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

相关专题

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

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

1831

2023.07.20

python能做什么
python能做什么

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

4964

2023.07.25

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

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

1789

2023.07.31

python教程
python教程

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

29737

2023.08.03

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

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

3547

2023.08.04

python eval
python eval

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

3567

2023.08.04

scratch和python区别
scratch和python区别

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

1223

2023.08.11

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

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

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

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

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