Python中__str__和__repr__有什么异同点

在Python中，__str__和__repr__是两个特殊方法，用于定义对象的字符串表示形式。它们经常被用于调试、日志记录和代码可读性的改进。虽然它们的目标相似，但在某些方面存在一些重要的异同点。本文将深入探讨__str__和__repr__的异同，以及何时应该使用它们。

__str__ 方法

__str__方法用于返回对象的"非正式"或"友好"字符串表示形式，通常用于将对象的信息呈现给终端用户或日志记录。

以下是一个示例：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __str__(self):
        return f"{self.name}, {self.age} 岁"

person = Person("Alice", 30)
print(person)  # 输出：Alice, 30 岁

__str__ 方法的目标是提供一种易读的字符串表示形式，以便用户可以理解对象的含义。

__repr__ 方法

__repr__方法用于返回对象的"正式"或"规范"字符串表示形式，通常用于开发和调试过程中，也可以被开发人员用来重建对象。

以下是一个示例：

class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

    def __repr__(self):
        return f"Person('{self.name}', {self.age})"

person = Person("Alice", 30)
print(repr(person))  # 输出：Person('Alice', 30)

__repr__ 方法的目标是提供一种可用于重建对象的字符串表示形式，它应该是明确和无歧义的。

异同点

相同点

1. 都是特殊方法：__str__和__repr__都是Python中的特殊方法，它们具有特殊的命名约定，分别用于返回对象的字符串表示形式。

2. 可自定义：开发人员可以根据需要自定义__str__和__repr__方法，以满足特定的应用需求。

3. 都可以被调用：str(obj)和repr(obj)函数分别用于获取对象的__str__和__repr__表示形式。

不同点

1. 目标不同：__str__的目标是提供友好的、易读的字符串表示形式，而__repr__的目标是提供规范的、可用于重建对象的字符串表示形式。

2. 优先级不同：如果两者都定义了，str(obj)通常会优先使用__str__，只有在__str__未定义时才会回退到使用__repr__。而repr(obj)总是使用__repr__。

何时使用它们

• 使用__str__当您希望提供对象的友好、易读的表示形式，用于最终用户或日志记录。
• 使用__repr__当您希望提供对象的规范、可重建的表示形式，用于开发和调试。

通常情况下，建议至少实现__repr__方法，以便在调试和开发过程中有更多的信息可用。如果需要更友好的表示形式供用户查看，可以额外实现__str__方法。

总之，__str__和__repr__是Python中用于定义对象字符串表示形式的重要方法，它们在目标和优先级上有所不同，开发人员可以根据具体需求选择使用它们。通过合理使用这两个方法，可以提高代码的可读性和可维护性。