嘉兴市城市建设门户网站陕西省住建厅网站官网

在Python中，__str__() 是一个特殊的方法（也称为魔术方法或魔法方法），用于定义对象的字符串表示形式。当使用内置函数 str() 或者通过 print() 打印对象时，Python会调用对象的 __str__() 方法来获取其字符串表示。

作用

__str__() 方法的主要目的是为对象提供一个易于阅读的字符串表示，通常用于调试和日志记录。它返回字符串的应该是对用户友好的，便于理解对象的内容。

示例

以下是一个简单的类，展示了如何定义和使用 __str__() 方法：

Python复制

class Person:def __init__(self, name, age):self.name = nameself.age = agedef __str__(self):return f"Person(name={self.name}, age={self.age})"# 创建对象
person = Person("Alice", 30)# 使用 str() 或 print() 调用 __str__()
print(person)  # 输出: Person(name=Alice, age=30)
print(str(person))  # 输出: Person(name=Alice, age=30)

__str__() 与 __repr__()

__str__() 和 __repr__() 都用于定义对象的字符串表示，但它们的用途和行为有所不同：

1. __str__()：

   • 用于生成对象的非正式字符串表示，通常更易于阅读，适合用户输出。

   • 如果没有定义 __str__()，Python会默认调用 __repr__()。

2. __repr__()：

   • 用于生成对象的正式字符串表示，通常更详细，适合调试和开发。

   • 目标是返回一个可以用来重新创建对象的字符串（例如，通过 eval()）。

   • 如果没有定义 __repr__()，Python会返回一个默认的字符串表示，通常是 <__main__.ClassName object at 0x...>。

示例：__str__() 和 __repr__()

Python复制

class Person:def __init__(self, name, age):self.name = nameself.age = agedef __str__(self):return f"Person(name={self.name}, age={self.age})"def __repr__(self):return f"Person(name='{self.name}', age={self.age})"# 创建对象
person = Person("Alice", 30)# 使用 str() 和 repr()
print(person)  # 调用 __str__()，输出: Person(name=Alice, age=30)
print(repr(person))  # 调用 __repr__()，输出: Person(name='Alice', age=30)

注意事项

1. 返回值类型：__str__() 必须返回一个字符串类型，否则会抛出 TypeError。

2. 默认行为：如果没有定义 __str__()，Python会调用 __repr__()。

3. 调试友好性：__repr__() 更适合调试，因为它通常更详细；而 __str__() 更适合用户输出。

总结

__str__() 是一个非常有用的特殊方法，用于定义对象的字符串表示。它可以让对象在打印或转换为字符串时更加友好和易于理解。合理定义 __str__() 和 __repr__() 可以显著提升代码的可读性和可维护性。