在 Python 中,str 和 repr 是两个用于定义对象字符串表示的特殊方法(魔术方法)。它们的主要区别在于用途和调用场景:
- str
用途:str 用于为对象提供一个“用户友好”的字符串表示,通常用于打印或显示给用户。
调用场景:
当使用 print(obj) 时,Python 会调用 obj.str()。
当使用 str(obj) 时,Python 也会调用 obj.str()。
特点:
返回值应该是可读性强的字符串,适合普通用户阅读。
如果未定义 str,Python 会默认调用 repr 作为备选。
示例:
python
复制
class Person:
def __init__(self, name, age):
self.name = name
self.age = age
def __str__(self):
return f"Person(name={self.name}, age={self.age})"
p = Person("Alice", 30)
print(p) # 输出: Person(name=Alice, age=30)
print(str(p)) # 输出: Person(name=Alice, age=30)
- repr
用途:repr 用于为对象提供一个“开发者友好”的字符串表示,通常用于调试和日志记录。
调用场景:
当使用 repr(obj) 时,Python 会调用 obj.repr()。
当在交互式环境中直接输入对象时(如 Python REPL),也会调用 repr。
如果未定义 str,print(obj) 和 str(obj) 也会调用 repr。
特点:
返回值应该是明确的、无歧义的字符串,通常包含对象的类型和关键信息。
理想情况下,eval(repr(obj)) 应该能够重建对象(虽然不是强制要求)。
示例:
python
复制
class Person:
def __init__(self, name, age):
self.name = name
self.age = age
def __repr__(self):
return f"Person(name='{self.name}', age={self.age})"
p = Person("Alice", 30)
print(repr(p)) # 输出: Person(name='Alice', age=30)
- str 和 repr 的区别总结
特性 str repr
用途 用户友好的字符串表示 开发者友好的字符串表示
调用场景 print(obj) 或 str(obj) repr(obj) 或交互式环境直接输入
返回值要求 可读性强,适合普通用户 明确、无歧义,适合调试和开发
默认行为 如果未定义,调用 repr 如果未定义,返回默认的对象表示
理想目标 无 eval(repr(obj)) 应能重建对象 - 实际应用建议
定义 repr:建议始终为类定义 repr,因为它不仅用于调试,还作为 str 的备选。
定义 str:如果希望对象在打印时有更友好的显示,可以额外定义 str。
示例:同时定义 __str__ 和 __repr__
python
复制
class Person:
def __init__(self, name, age):
self.name = name
self.age = age
def __str__(self):
return f"{self.name} is {self.age} years old."
def __repr__(self):
return f"Person(name='{self.name}', age={self.age})"
p = Person("Alice", 30)
print(p) # 输出: Alice is 30 years old.
print(repr(p)) # 输出: Person(name='Alice', age=30)
- 总结
str 用于用户友好的输出。
repr 用于开发者友好的输出,通常包含更多细节。
在实际开发中,建议至少定义 repr,以便在调试时能够清晰地了解对象的状态。