如何在Python中利用__contains__实现类的in成员判断

陌雪酱_7335

陌雪酱_7335

2026-11-16

757人浏览

原创

__contains__ 不生效的主因是未正确定义或实现错误:必须接收一个参数、返回明确布尔值,且不可抛异常;若同时存在 __iter__,需确保语义一致,否则 in 可能绕过 __contains__ 走迭代路径。

如何在python中利用__contains__实现类的in成员判断

为什么直接用 __contains__ 有时不生效

Python 的 in 操作符默认会先尝试调用对象的 __contains__ 方法;但如果类没定义它,解释器会退而求其次,尝试用 __iter__ 迭代后逐个比较,甚至 fallback 到 __getitem__。这意味着:即使你写了 __contains__,如果同时实现了 __iter__ 但逻辑有误,或者忘了 return 布尔值,in 可能走错路径或抛异常。

常见错误现象:TypeError: 'X' object is not iterable(误删了 __iter__ 却依赖它)、AttributeError: '__contains__'(拼错函数名,比如写成 __contain__)、返回非布尔值导致判断失真。

  • __contains__ 必须接收一个参数(要查找的元素),且必须明确 return True 或 return False
  • 不要在 __contains__ 里抛 KeyError 或 ValueError —— 它不是 dict.__getitem__
  • 如果类同时支持 __iter__ 和 __contains__,确保两者语义一致,否则 in 行为可能和直觉不符

如何正确实现 __contains__ 并避免性能陷阱

典型场景是封装一个自定义容器(如基于 list 或 set 的包装类)。关键不是“能不能写”,而是“怎么写才既正确又高效”。比如对内部是 list 的类,若直接用 item in self._data,每次都是 O(n);而如果底层实际是 set 或可哈希结构,就该利用其 O(1) 查找。

示例:一个去重的标签集合类

class TagSet:
    def __init__(self):
        self._tags = set()
<pre class="brush:php;toolbar:false;">def add(self, tag):
    self._tags.add(tag)

def __contains__(self, tag):
    return tag in self._tags  # 直接委托给 set.__contains__,O(1)

  • 避免在 __contains__ 中做耗时操作(如网络请求、文件读取)——in 语义上应是轻量判断
  • 如果内部存储是 list 且数据量小(item in self._items 可接受;否则考虑升级底层结构或加缓存
  • 注意类型安全:比如 __contains__ 接收 None 或不可哈希对象时,要提前判断是否支持(如 if not isinstance(tag, Hashable): return False)

__contains__ 和 __iter__ 冲突时谁优先?

in 操作符严格遵循协议:只要类定义了有效的 __contains__,就一定调用它,__iter__ 完全不会被触发。你可以用 dis.dis('x in obj') 验证字节码里调的是 CONTAINS_OP 而非 GET_ITER + 循环。

Python 环境工具专业版
Python 环境工具专业版

Python 环境工具专业版功能概述Python 环境工具专业版是一项面向实际任务的技能。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。核心要点使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。执行完成后建议检查结果是否符合预期,并保留必要记录。使用与执行同时注意输入完整性、执行条件和输出可用性。从功能定位来看,该技能

下载

但容易被忽略的一点是:如果 __contains__ 抛出 NotImplementedError 或其他未捕获异常,Python 不会自动 fallback 到 __iter__,而是直接把异常抛给用户。它只在“找不到该方法”时降级,而不是“方法执行失败”时降级。

  • 测试方法是否存在:用 hasattr(obj, '__contains__'),而非靠异常判断
  • 若想保留 fallback 行为(比如兼容老版本接口),需手动在 __contains__ 里捕获异常并退回到遍历逻辑
  • 第三方库(如某些 ORM 模型)可能重载 __contains__ 做懒加载,这时要注意副作用 —— 一次 in 可能触发一次数据库查询

继承内置容器时要不要重写 __contains__?

大多数情况下不用。比如子类化 list 或 dict,它们已自带高效的 __contains__。但如果你覆盖了底层存储逻辑(例如用 __slots__ + 自定义字段代替 self._data),就必须提供自己的 __contains__,否则会继承父类的实现,查的就不是你的数据了。

反模式示例:

class BadList(list):
    def __init__(self, items):
        self._items = list(items)  # 没调 super().__init__,也没改 list.__contains__
<pre class="brush:php;toolbar:false;"># ❌ 这里没重写 __contains__,in 仍查空的父类 list 实例

  • 继承 collections.abc.Container 可以强制实现 __contains__(通过 __subclasshook__ 检查),适合构建抽象基类
  • 用 typing.Protocol 做静态检查时,__contains__ 是可选协议方法,但运行时仍以实际定义为准
  • 最稳妥的做法:无论是否继承,只要数据存在独立存储中,就显式实现 __contains__ 并指向真实数据源

真正难的不是写出 contains,而是想清楚“这个 in 判断到底应该代表什么语义”,以及“当别人用 in 时,他预期的性能和副作用是什么”。很多 bug 来自假设别人会调你的方法,结果对方用了 getattr(obj, 'contains', None) 手动判断并绕开了它。

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

相关专题

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

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

2023.07.20

1931

4

python能做什么
python能做什么

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

2023.07.25

5464

7

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

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

2023.07.31

1889

3

python教程
python教程

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

2023.08.03

33297

23

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

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

2023.08.04

3907

5

python eval
python eval

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

2023.08.04

3927

5

scratch和python区别
scratch和python区别

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

2023.08.11

1283

5

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

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

2023.08.10

616

4

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

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

2023.08.11

3043

5

热门下载

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

精品课程

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