如何通过Python中的__getitem__让自定义对象支持索引访问?

云丽同学_6203

云丽同学_6203

2026-07-16

943人浏览

原创

__getitem__必须显式返回可索引对象,否则隐式返回none导致typeerror;需处理int和slice两种key类型,切片应返回同类型新实例;越界必须抛indexerror。

如何通过python中的__getitem__让自定义对象支持索引访问?

能,但必须返回具体值,不能只写逻辑不返回;否则调用 obj[0] 会报 TypeError: 'NoneType' object is not subscriptable。

__getitem__ 必须有 return,且返回值要能被索引操作消费

很多人写完 __getitem__ 只打印日志或做校验,忘了 return。Python 解释器在执行 obj[i] 时,会强制要求该方法返回一个对象——哪怕返回 None,只要没 return,实际就是隐式返回 None,而 None 不支持后续索引(比如 obj[0][1]),就会立刻崩。

  • 正确写法:必须显式 return 一个支持索引的对象(如 list、str、另一个自定义容器等)或标量(如 int、str)
  • 错误典型:def __getitem__(self, key): print(f"get {key}") # 缺少 return → 隐式 return None
  • 调试技巧:在方法末尾加一句 assert result is not None, "missing return",尤其在封装底层数据结构时

支持切片的关键是识别 slice 对象并返回新实例

当用户写 obj[1:4],传给 __getitem__ 的 key 是一个 slice 实例,不是整数。如果只处理 int 类型的 key,遇到切片就会抛 TypeError 或逻辑错乱。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载
  • 判断方式:isinstance(key, slice)
  • 返回什么:通常应返回同类型的新实例(如 MyList(self._data[key])),而不是原地修改或返回 list——否则丢失自定义行为
  • 注意边界:slice.indices(len(self)) 可帮你把负索引、None 起止值转成明确的 (start, stop, step),避免手动算错

下标越界时抛 IndexError,别用 KeyError 或其他异常

Python 官方约定:容器类对无效索引应抛 IndexError,这是 for 循环、enumerate 等内置机制依赖的信号。抛 KeyError 或静默忽略,会导致迭代中断或行为不一致。

  • 常见陷阱:用字典模拟列表时,直接 return self._dict[key],但字典缺 key 抛 KeyError,不符合序列协议
  • 正确做法:if not (0
  • 切片越界不用主动检查:list 对切片越界是宽容的([10:100] 返回空列表),你的实现也应保持一致

最常被忽略的是:__getitem__ 不负责实现长度检查——len() 调用的是 __len__,而 for 循环先查 len 再逐个索引。如果你没实现 __len__,但又希望支持 for x in obj:,Python 会退回到用 __getitem__ 从 0 开始试,直到抛 IndexError 才停——这很慢,且无法预知循环次数。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

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

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

2023.07.20

1651

4

python能做什么
python能做什么

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

2023.07.25

4124

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

23857

23

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

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

2023.08.04

2927

5

python eval
python eval

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

2023.08.04

2947

5

scratch和python区别
scratch和python区别

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

2023.08.11

1143

5

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

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

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2283

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程