如何让一个类支持 in 操作符(contains)但不实现 iter

__con

tains__ 不需要 __iter__,因为 in 操作符优先调用 __contains__;仅当其未定义时才回退到迭代。

为什么 __contains__ 不需要 __iter__

Python 的 in 操作符优先调用对象的 __contains__ 方法;只有当该方法未定义时,才退而求其次尝试迭代(即调用 __iter__,再逐个比对)。所以只要明确定义了 __contains__,就完全不必实现 __iter__ —— 这不是权宜之计,而是语言设计的正统路径。

如何正确实现 __contains__ 避免常见错误

最常踩的坑是把 __contains__ 写成线性扫描却没考虑性能或语义边界。它应该快速返回 TrueFalse,且行为需与“成员资格”的直觉一致:

  • 不要在 __contains__ 里抛出 KeyErrorValueError —— 它只应返回布尔值,异常会中断 in 判断并报错
  • 如果底层用字典或集合存储,直接委托查询:return item in self._data
  • 如果逻辑复杂(如范围判断),避免副作用:不要在 __contains__ 里修改状态、触发 IO 或缓存重建
  • 注意类型一致性:比如类表示一个整数区间 RangeSet(1, 10)5 in r 应为 True,但 "5" in r 应为 False(不隐式转换)

__contains____iter__ 同时存在时的行为

两者可以共存,但 in 仍只走 __contains__。这种组合常见于既支持高效成员检查、又支持遍历的容器类:

  • __contains__ 可基于哈希表 / 索引 / 数学公式实现 O(1) 或 O(log n) 判断
  • __iter__ 则按需生成元素,可能较慢或有副作用(如读文件、查数据库)
  • 若只实现 __iter__ 而不实现 __contains__in 会强制完整迭代——哪怕找到第一个匹配项也会继续跑完,浪费资源

一个轻量但完整的示例

假设你有一个不可变的整数集合包装器,底层用 frozenset,但不想暴露迭代能力:

class IntSet:
    def __init__(self, items):
        self._data = frozenset(int(x) for x in items)

    def __contains__(self, item):
        return isinstance(item, int) and item in self._data

这时 5 in IntSet([1, 2, 5]) 返回 True,而 list(IntSet([1,2])) 会报 TypeError: 'IntSet' object is not iterable —— 正是你想要的分离控制。

真正容易被忽略的是:一旦自定义了 __contains__,就要确保它覆盖所有合理输入类型,并拒绝模糊比较(比如不自动把 float(5.0) 当作 int(5)),否则 in 的行为会变得难以预测。