Python类如何支持长度查询_实现__len__魔术方法返回容器大小

风雪君_2951

风雪君_2951

2026-05-10

812人浏览

原创

当自定义类未实现__len__方法时,调用len()会抛出TypeError: object of type 'X' has no len();该方法必须存在、返回非负整数,且直接影响if obj:等布尔判断。

python类如何支持长度查询_实现__len__魔术方法返回容器大小

为什么 len() 调用报 TypeError: object of type 'X' has no len()

当你自定义一个类(比如 BookShelf 或 Stack),想直接用 len(my_obj) 获取其“大小”,Python 会尝试调用对象的 __len__ 方法。如果没实现,就抛这个错——不是你忘了写,而是 Python 根本找不到入口。

关键点:len() 不是靠属性或普通方法,它只认 __len__ 这个特定名字的魔术方法,且必须返回非负整数。

  • __len__ 必须返回 int,不能是 float、None 或负数,否则运行时报 TypeError: __len__() should return >= 0
  • 返回值会被 len() 直接使用,不做任何转换;哪怕你返回 5.0,也会立刻出错
  • 不建议在 __len__ 里做耗时操作(比如遍历磁盘文件统计行数),因为 len() 语义上应是 O(1) 的快速查询

__len__ 的典型实现方式和常见陷阱

多数容器类只需返回内部存储结构的长度,但要注意底层数据结构是否真实反映“逻辑长度”。

例如:

class Stack:
    def __init__(self):
        self._items = []
<pre class="brush:php;toolbar:false;">def push(self, item):
    self._items.append(item)

def pop(self):
    return self._items.pop()

def __len__(self):
    return len(self._items)  # ✅ 正确:委托给 list.__len__

Li Python Sec Check
Li Python Sec Check

Python 安全规范检查工具:基于 CloudBase 规范、腾讯安全指南,LLM 智能分析(默认禁用,优先本地执行)

下载
  • 别写 return self._items.__len__() —— 虽然可行,但绕过内置 len() 的优化,且可读性差
  • 如果类用字典模拟稀疏数组(如键为索引、值为元素),len(self._data) 返回的是“已存项数”,而非最大索引+1,这通常是合理行为
  • 若内部用固定数组 + 游标(如 self._array 和 self._size),务必返回 self._size,而不是 len(self._array),否则会暴露底层容量

和 __bool__ 的隐式联动关系

Python 在判断对象真假值(如 if obj:)时,若没定义 __bool__,会 fallback 到 len(obj) == 0。也就是说,只要实现了 __len__,你就自动获得了“空即 False”的默认布尔行为。

  • 这意味着:如果你的类逻辑上“非空”但 __len__ 返回 0(比如一个等待初始化的缓冲区),它会在 if 中被当作 False,可能引发意料外的分支跳转
  • 若需自定义真值逻辑(例如“只要配置加载完成就算 True,不管当前数据多少”),必须显式实现 __bool__,否则 __len__ 仍会被 fallback 使用
  • 没有 __len__ 却有 __bool__ 是完全合法的;但两者都缺,对象默认为 True

测试 __len__ 是否生效的最快验证法

别等集成到业务逻辑才发现没起作用,用三行交互式验证最可靠:

>>> s = Stack()
>>> len(s)
0
>>> s.push(1); s.push(2)
>>> len(s)
2
  • 确保测试覆盖边界:空实例、单元素、多元素,以及调用后状态变化是否影响长度(比如 pop() 后 len() 是否减 1)
  • 不要只测 print(len(s)),而要用 assert len(s) == N 写进单元测试,避免视觉误判
  • 如果类支持切片(__getitem__),注意 len() 返回值应与 len(list(obj)) 一致,否则用户用 for x in obj: 时迭代次数可能和预期不符

真正容易被忽略的是:很多开发者把 __len__ 当作“锦上添花”,直到某天调试 if my_container: 行为异常,才回头翻文档——其实它和 __iter__、__getitem__ 一样,是让类融入 Python 容器协议的关键一环,不是可选装饰。

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

相关专题

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

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

2023.07.20

1671

4

python能做什么
python能做什么

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

2023.07.25

4204

7

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

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

2023.07.31

1669

3

python教程
python教程

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

2023.08.03

24377

23

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

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

2023.08.04

2987

5

python eval
python eval

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

2023.08.04

3007

5

scratch和python区别
scratch和python区别

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

2023.08.11

1163

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2323

5

热门下载

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

精品课程

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