Python Academy · 课时

魔术方法：str 与 repr

Q: 「魔术方法：__str__ 与 __repr__」这节课中我会学到什么？

实现双下划线方法，让对象表示更易读。 你通过在浏览器中直接运行的动手代码来练习 Python Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

实现双下划线方法，让对象表示更易读。

魔术方法：__str__ 与 __repr__ 是 CoddyKit 上的免费 Python Academy 课时。这是第 4 节课，共 4 节。你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。这是 Python Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Python Academy 课程共包含 4 节课。

什么是魔术方法？

魔术方法（双下划线方法）是带有双下划线的特殊方法，Python 会在打印或比较等特定场景中调用它们。

class Foo:
    def __str__(self):
        return "I am Foo"

f = Foo()
print(f)        # I am Foo
print(str(f))   # I am Foo

repr：开发者表示形式

__repr__ 应返回一个明确无歧义的字符串，理想情况下还应能够据此重新创建对象。它会显示在 REPL 中，并由 repr() 使用。

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return f"Point({self.x}, {self.y})"

p = Point(3, 4)
print(repr(p))  # Point(3, 4)

str：用户表示形式

__str__ 提供适合人类阅读的字符串。print() 和 str() 会调用它。如果未定义，Python 会回退到 __repr__。

class Temperature:
    def __init__(self, celsius):
        self.celsius = celsius

    def __str__(self):
        return f"{self.celsius}°C"

    def __repr__(self):
        return f"Temperature({self.celsius})"

t = Temperature(100)
print(t)        # 100°C
print(repr(t))  # Temperature(100)

两者分别在何时调用

__str__：print()、str() 和 f 字符串。__repr__：REPL、repr()，以及显示其元素的容器。

class Item:
    def __str__(self): return "str"
    def __repr__(self): return "repr"

x = Item()
print(x)         # str
print([x])       # [repr]  ← list uses repr for elements

使用 format 自定义格式

定义 __format__，可以控制带有格式说明符的 f 字符串如何显示您的对象。

class Money:
    def __init__(self, amount):
        self.amount = amount

    def __format__(self, spec):
        if spec == "usd":
            return f"${self.amount:.2f}"
        return str(self.amount)

m = Money(9.5)
print(f"{m:usd}")  # $9.50

使用 bool 表示真假

__bool__ 让对象可以在布尔上下文中进行求值。请返回 True 或 False。

class Bag:
    def __init__(self, items):
        self.items = items

    def __bool__(self):
        return len(self.items) > 0

b = Bag([])
if not b:
    print("Bag is empty")  # Bag is empty

使用 len 支持 len()

__len__ 让 len(obj) 生效。如果未定义 __bool__，它还会为 __bool__ 提供结果。

class Stack:
    def __init__(self):
        self.data = []

    def push(self, v): self.data.append(v)

    def __len__(self):
        return len(self.data)

s = Stack()
s.push(1)
print(len(s))  # 1

使用 eq 判断相等

定义 __eq__，可以指定两个实例使用 == 比较时何时相等。

class Vector:
    def __init__(self, x, y):
        self.x, self.y = x, y

    def __eq__(self, other):
        return self.x == other.x and self.y == other.y

print(Vector(1,2) == Vector(1,2))  # True

hash 与 eq 的配合

定义 __eq__ 后，Python 会将 __hash__ 设置为 None，使对象不可哈希。如果需要将对象放入集合或字典，也请定义 __hash__。

class Point:
    def __init__(self, x, y): self.x, self.y = x, y
    def __eq__(self, o): return (self.x, self.y) == (o.x, o.y)
    def __hash__(self): return hash((self.x, self.y))

pts = {Point(1,2), Point(1,2)}
print(len(pts))  # 1

add 与算术运算

算术运算符会映射到双下划线方法：__add__ 对应 +，__sub__ 对应 -，依此类推。

class Vector:
    def __init__(self, x, y): self.x, self.y = x, y
    def __add__(self, o): return Vector(self.x+o.x, self.y+o.y)
    def __repr__(self): return f"Vector({self.x},{self.y})"

print(Vector(1,2) + Vector(3,4))  # Vector(4,6)

使用 getitem 进行索引

__getitem__ 让您的类支持方括号索引，例如 obj[key]。

class Matrix:
    def __init__(self, data):
        self.data = data

    def __getitem__(self, idx):
        return self.data[idx]

m = Matrix([[1,2],[3,4]])
print(m[0])     # [1, 2]
print(m[1][0])  # 3

快速检查

使用 print(obj) 时会调用哪个双下划线方法？

回顾

魔术方法让您的类具备符合 Python 风格的行为。__repr__ 面向开发者，__str__ 面向用户。定义 __eq__、__hash__ 和算术双下划线方法，可以让对象具备完整的功能。

常见问题解答