Python自定义容器需实现容器协议的魔术方法:__len__返回非负整数,__contains__支持in操作;__getitem__支撑索引、切片与迭代;可选__setitem__和__delitem__实现可变操作;__iter__提供更清晰可控的迭代支持。

Python 中实现自定义容器,核心在于遵循「容器协议」——即实现特定的魔术方法(dunder methods),让类支持常见的容器操作,如 len()、in、索引访问 []、切片、迭代等。这不是语法强制,而是 Python 解释器通过约定俗成的方法名来调用对应行为。
支持长度和成员检测:__len__ 与 __contains__
要让实例能被 len(obj) 调用,必须实现 __len__(self),返回一个非负整数。注意:不能返回浮点数或负数,否则会触发 TypeError。
支持 item in obj 语法,优先调用 __contains__(self, item)。若未实现,Python 会退而使用迭代(__iter__)逐个比较;但显式实现更高效,尤其对底层是哈希结构(如字典或集合)的容器。
示例:
立即学习“Python免费学习笔记(深入)”;
class SimpleBag:
def __init__(self, items=None):
self._items = list(items or [])
<pre class="brush:php;toolbar:false;">def __len__(self):
return len(self._items)
def __contains__(self, item):
return item in self._items # 利用列表的 in 实现支持索引与切片:__getitem__ 是关键
__getitem__(self, key) 是最核心的容器方法之一。它不仅支撑 obj[i],还自动启用切片 obj[start:stop:step]、迭代(当 key 是 int 且从 0 开始递增时)、以及 for x in obj(只要没定义 __iter__,解释器就用 __getitem__ 模拟迭代)。
处理切片时,key 是 slice 对象,需手动解析 .start、.stop、.step 并返回新容器(通常应返回同类实例,保持接口一致)。
建议:遇到非法索引(如越界整数或不支持的 key 类型)应抛出 IndexError 或 KeyError,而非静默失败。
- 整数索引 → 返回单个元素
- 切片对象 → 返回同类型新实例(如
MyList切片后仍为MyList) - 其他类型(如字符串)→ 可按需支持键访问(类似 dict),但需文档说明
支持可变操作:__setitem__ 和 __delitem__
若希望容器可修改(如 obj[i] = value 或 del obj[i]),还需实现:
-
__setitem__(self, key, value):赋值逻辑,例如检查索引范围、类型约束 -
__delitem__(self, key):删除逻辑,如从内部列表弹出指定位置元素
这两个方法不是必须的——只读容器(如命名元组的模拟)可不实现,此时尝试赋值或删除会触发 TypeError。
注意:__setitem__ 和 __delitem__ 不影响 len() 或 __contains__ 的行为,需确保内部状态同步更新(例如删除后 __len__ 返回值要变)。
支持迭代与解包:__iter__ 更清晰可控
虽然 __getitem__ 能“兼职”迭代,但显式实现 __iter__(self) 更推荐:它明确表达“这是一个可迭代对象”,且可返回任意迭代器(生成器函数、自定义迭代器类、或内置容器的 iter())。
例如:
def __iter__(self):
return iter(self._items) # 直接代理
# 或
def __iter__(self):
for item in self._items:
yield item.upper() # 加工后迭代
有了 __iter__,对象就能用于 for 循环、解包(*obj)、list(obj) 等所有迭代上下文,且不再依赖 __getitem__ 的整数索引模拟。










