Python如何实现对象的容器行为_实现__contains__支持in操作符

陌宇吖_9486

陌宇吖_9486

2026-04-21

795人浏览

原创

实现了 __contains__ 仍报 TypeError 是因方法名拼错、缺少 self 参数、返回非布尔值或未处理所有分支;Python 的 in 操作符优先调用 __contains__,仅当未实现时才退化为迭代。

python如何实现对象的容器行为_实现__contains__支持in操作符

为什么实现了 __contains__ 还是报 TypeError: argument of type 'X' is not iterable

这个错误说明 Python 没有调用你的 __contains__,而是试图先对对象做迭代(比如调用 __iter__),再逐个比对。Python 的 in 操作符有明确的优先级:它**只在对象没实现 __contains__ 时,才退化为遍历 + 比较**;但如果你的类同时没实现 __iter__,又没正确返回布尔值,或返回了非布尔类型,就可能触发这个错误。常见原因包括:

  • __contains__ 方法名拼错(比如写成 __contain__ 或 __contains)
  • 方法存在但没加 self 参数,导致被当成静态方法调用失败
  • 返回值不是 True/False,比如返回整数 1 或字符串 "yes",某些旧版本 Python 会拒绝
  • 类继承自某个内置容器(如 list)但没显式覆盖 __contains__,实际走的是父类逻辑,而你误以为自己控制了行为

__contains__ 的参数和返回值必须严格匹配

该方法接收两个参数:self 和 item,必须返回一个布尔值(bool 类型)。不要试图返回 None、数字或自定义真值对象——Python 不会帮你转换。例如:

class Bag:
    def __init__(self, items):
        self._items = list(items)
<pre class="brush:php;toolbar:false;">def __contains__(self, item):
    # ✅ 正确:显式返回 bool
    return item in self._items

b = Bag([1, 2, 3]) print(2 in b) # True print("x" in b) # False

如果把最后一行改成 return self._items.count(item) > 0,虽然结果一样,但可读性差;更危险的是写成 return item in self._items or None,这会让返回值变成 None,导致后续逻辑出错。

当底层数据结构不支持直接查找时,别硬套 __contains__

比如你封装了一个链表类,内部只有头指针和 next 链接,没有缓存索引或哈希表。这时 __contains__ 必须遍历,时间复杂度是 O(n)。这不是 bug,是设计使然。但要注意:

Python Testing
Python Testing

Python 测试速查:运行 pytest、使用 mock/patch、参数化、fixtures、异步、覆盖率测试。

下载
  • 不要在 __contains__ 里做副作用操作(比如自动添加缺失项、打印日志),因为用户写 x in obj 时默认这是个纯查询
  • 如果查找很慢,且调用频繁,考虑是否该暴露一个 has_item() 方法并加文档说明性能特征,而不是只依赖 in
  • 避免在 __contains__ 中递归调用自身,容易栈溢出;也不要意外触发其他魔术方法(比如访问属性时触发了 __getattr__,又间接调用了 in)

测试 __contains__ 是否生效的最简方式

别依赖 IDE 提示或文档注释,直接用交互式环境验证:

>>> class Demo: 
...     def __contains__(self, x): return x == 42
... 
>>> d = Demo()
>>> 42 in d
True
>>> 99 in d
False
>>> "hello" in d  # 传任意类型都应安全处理
False

重点测三类输入:存在的值、不存在的值、非预期类型(如 None、嵌套对象)。如果其中任一情况抛异常(比如 AttributeError),说明你的 __contains__ 没做防御性检查。另外,注意 in 对自定义类永远不触发 __eq__ —— 它只看你 __contains__ 返回什么,这点和 list.index() 或 dict.get() 的行为完全不同。

真正容易被忽略的是:Python 在调用 <strong>contains</strong> 前,不会检查你有没有实现 <strong>iter</strong>;但如果类同时定义了两者,in 一定优先用 <strong>contains</strong>。所以问题往往不出在“该不该实现”,而出在“有没有拼对、有没有返回布尔、有没有在所有分支都返回”。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1631

4

python能做什么
python能做什么

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

2023.07.25

3984

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

22937

23

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

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

2023.08.04

2807

5

python eval
python eval

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

2023.08.04

2847

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2223

5

热门下载

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

精品课程

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