`__str__` 是 Python 中的一个魔法方法（也称为魔术方法），用于定义对象的字符串表示形式。该方法的主要功能是为类的实例提供一个易于理解的、面向用户的字符串描述，通常在使用 `print()` 函数或 `str()` 内置函数时被调用。 当一个对象被转换为字符串时（例如通过 `print(obj)` 或 `str(obj)`），Python 会尝试调用该对象所属类中定义的 `__str__` 方法。如果未定义 `__str__`，则会退回到使用默认的对象表示方式，通常是类似 `<__main__.ClassName object at memory_address>` 的格式。 ### 使用示例 #### 示例1：基本使用 ```python class Point: def __init__(self, x, y): self.x = x self.y = y def __str__(self): return f"Point({self.x}, {self.y})" p = Point(3, 4) print(p) # 输出: Point(3, 4) ``` 在此示例中，`Point` 类定义了 `__str__` 方法，以返回点坐标的字符串表示形式。调用 `print(p)` 时，将输出 `Point(3, 4)`，而不是默认的对象内存地址 [^1]。 #### 示例2：不正确使用 `print` 而非 `return` ```python class Cat: def __init__(self, name, age): self.name = name self.age = age def __str__(self): print(f"{self.name}, {self.age}") # 错误：没有 return 语句 tom = Cat("Tom", 18) print(tom) # 输出: Tom, 18 后跟 None ``` 在这个例子中，`__str__` 方法使用了 `print` 来输出字符串，但没有使用 `return` 返回任何值。这会导致 `print(tom)` 在调用 `__str__` 时得到 `None`，并最终打印出额外的 `None` [^2]。正确的做法应是使用 `return` 返回字符串： ```python def __str__(self): return f"{self.name}, {self.age}" ``` #### 示例3：结合复杂数据结构 ```python class Rectangle: def __init__(self, width, height): self.width = width self.height = height def area(self): return self.width * self.height def __str__(self): return f"Rectangle(width={self.width}, height={self.height}, area={self.area()})" rect = Rectangle(5, 10) print(rect) # 输出: Rectangle(width=5, height=10, area=50) ``` 此示例展示了如何在 `__str__` 方法中整合对象的多个属性和方法，提供更丰富的信息输出 [^1]。 ### 注意事项 - `__str__` 必须返回一个字符串类型的结果。 - 如果希望获得更详细的调试信息，可以同时实现 `__repr__` 方法，它通常用于开发者调试目的。 - `__str__` 更适合用户阅读，而 `__repr__` 应尽可能提供明确且准确的信息以便重建对象。