目录/第 37 章 · 魔术方法与对象协议
第 37 章 / 70 · 进阶 · 语法机制

魔术方法与对象协议

__str__ / __repr__ / __len__ / __getitem__ / __eq__ / __call__ / __iter__

先介绍1 个 demo6 个任务答案可展开

一、本章介绍

魔术方法(dunder methods)是 Python 的「对象协议」:只要实现特定双下划线方法,对象就能支持 len()、下标访问、比较、迭代、像函数一样调用等操作。

这一章把最常用的魔术方法一次讲全:显示类(__str__/__repr__)、容器类(__len__/__getitem__/__iter__)、比较类(__eq__)、可调用类(__call__)。学会后你就能写出「像内置类型一样自然」的自定义类。

本章要点

  • __str__ 面向用户、__repr__ 面向开发者
  • __len__ 让对象支持 len()
  • __getitem__ 支持下标与切片
  • __eq__ 自定义相等判断
  • __call__ 让实例可调用
  • __iter__ 让对象可迭代

二、先看 demo

下面这个例子把本章涉及的用法尽量全面地串了一遍,代码带逐行注释,可以直接复制到本地 .py 文件运行。

案例

先看一个完整例子

介绍 · 逐行注释
class Bag:
    def __init__(self, items):
        self.items = list(items)

    def __str__(self):          # print(obj) / str(obj)
        return f"Bag({len(self.items)} 件)"

    def __repr__(self):         # 控制台回显 / repr(obj)
        return f"Bag({self.items!r})"

    def __len__(self):          # len(obj)
        return len(self.items)

    def __getitem__(self, i):   # obj[i]
        return self.items[i]

    def __eq__(self, other):    # obj == other
        return isinstance(other, Bag) and self.items == other.items

    def __call__(self, x):      # obj(x)
        return x in self.items

    def __iter__(self):         # for x in obj
        return iter(self.items)

b = Bag([1,2,3])
print(str(b), repr(b))
print(len(b), b[0], b[1:])
print(b == Bag([1,2,3]))
print(b(2), b(9))
print([x*2 for x in b])
运行结果
Bag(3 件) Bag([1, 2, 3])
3 1 [2, 3]
True
True False
[2, 4, 6]

要点:__str__ 给 print 用,__repr__ 给调试用(最好能还原对象);实现 __len__/__getitem__/__iter__ 后,len()、下标、for 循环就都能用在你的类上。__call__ 让实例像函数一样调用。

三、6 个任务(自己先写,再看答案)

难度从入门到挑战逐步增加。每个任务的答案默认折叠,点开可看参考代码、运行结果;有第二种解法的也一并给出。代码都可以直接运行。

任务 1

__str__ 自定义显示

自己写 · 附答案入门 ★☆☆
解题提示:本题主要用到 __str__ 面向用户、__repr__ 面向开发者、__len__ 让对象支持 len()、__getitem__ 支持下标与切片。先对照要求自己写一遍,卡住了再展开答案。

定义 __str__,让 print(obj) 显示友好文字

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class P:
    def __str__(self): return "我是一个点"
print(P())
运行结果
我是一个点
任务 2

__repr__ 调试表示

自己写 · 附答案入门 ★☆☆
解题提示:本题主要用到 __str__ 面向用户、__repr__ 面向开发者、__len__ 让对象支持 len()、__getitem__ 支持下标与切片。先对照要求自己写一遍,卡住了再展开答案。

定义 __repr__,打印 repr(obj)

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class P:
    def __repr__(self): return "P(1,2)"
print(repr(P()))
运行结果
P(1,2)
任务 3

__len__ 支持 len

自己写 · 附答案进阶 ★★☆
解题提示:本题主要用到 __str__ 面向用户、__repr__ 面向开发者、__len__ 让对象支持 len()、__getitem__ 支持下标与切片。先对照要求自己写一遍,卡住了再展开答案。

实现 __len__,让 len(obj) 返回元素个数

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class L:
    def __len__(self): return 5
print(len(L()))
运行结果
5
任务 4

__getitem__ 下标

自己写 · 附答案进阶 ★★☆
解题提示:本题主要用到 __str__ 面向用户、__repr__ 面向开发者、__len__ 让对象支持 len()、__getitem__ 支持下标与切片。先对照要求自己写一遍,卡住了再展开答案。

实现 __getitem__,支持 obj[0] 与切片

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class L:
    def __getitem__(self, i): return [10,20,30][i]
a=L(); print(a[0], a[1:])
运行结果
10 [20, 30]
任务 5

__eq__ 相等判断

自己写 · 附答案挑战 ★★★
解题提示:本题主要用到 __str__ 面向用户、__repr__ 面向开发者、__len__ 让对象支持 len()、__getitem__ 支持下标与切片。先对照要求自己写一遍,卡住了再展开答案。

实现 __eq__,按属性值判断两个对象相等

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class P:
    def __init__(self,x): self.x=x
    def __eq__(self,o): return self.x==o.x
print(P(1)==P(1), P(1)==P(2))
运行结果
True False
任务 6

__call__ 可调用对象

自己写 · 附答案挑战 ★★★
解题提示:本题主要用到 __str__ 面向用户、__repr__ 面向开发者、__len__ 让对象支持 len()、__getitem__ 支持下标与切片。先对照要求自己写一遍,卡住了再展开答案。

实现 __call__,让实例像函数一样加 1 返回

我的代码草稿(可复制到本地 .py 文件运行)
参考答案(先自己写,再看)
参考答案一
class Add:
    def __call__(self, x): return x+1
f=Add(); print(f(5))
运行结果
6