Python __str__ vs __repr__：掌握对象的字符串表示方法
你有没有想过如何让你的自定义 Python 对象更具可读性和易于理解？好吧，这就是 Python __str__ 和 __repr__ 方法出现的地方。这就像一种神奇的方法，它使我们能够决定将对象转换为字符串时应该如何显示。在这篇博客中，我们将深入探讨 __str__ 和 __repr__ 方法的迷人世界，并探索它们如何提升您的编程技能
什么是 Python __str__ 函数？
Python 中的 __str__ 方法是一个特殊的函数，它允许我们定义对象应该如何表示为字符串。它为对象提供了一种以人类可读的格式介绍自己的方法。当我们打印一个对象或使用 __str（）__ 函数时，Python 会查找 __str__ 方法并调用它来获取字符串表示。
如果未为类显式定义 __str__ 方法，则将使用解释器提供的默认实现。此默认实现返回一个字符串，其中包含对象的类名及其内存地址。
Python 中 __str__ 的语法
在理解 Python 中 __str__ 该方法的语法时，我们将它分解为简单的步骤。通过执行这些步骤，您将能够毫不费力地在类中实现该方法 __str__ 。
- 类定义：首先，我们需要定义我们的类。我们使用
class关键字，后跟类的名称。在类中，我们定义了__str__方法，该方法将确定如何将我们的对象表示为字符串。 - 方法定义：在类中，我们开始定义
__str__方法。请务必注意，方法名称以两个下划线开头和结尾（下划线就像名称的小拥抱者）。 - 返回字符串表示形式：在方法内部，我们需要指定
__str__方法应返回的内容。此返回值将是对象的字符串表示形式。您可以在此字符串表示形式中包含所需的任何信息，例如属性值或自定义消息。 - 完成语法：最后，我们需要确保正确关闭方法定义和类定义。这是通过添加适当的缩进并确保所有内容正确排列来完成的。
下面是一个示例来说明 __str__ 的语法：
class Dog:
def __init__(self, name, breed):
self.name = name
self.breed = breed
def __str__(self):
return f"Meet {self.name}, the adorable {self.breed}."
my_dog = Dog("Max", "Labrador Retriever")
print(my_dog) # Meet Max, the adorable Labrador Retriever.
在此示例中，我们定义了一个使用 Dog 属性 name 和 breed .实现 __str__ 方法以提供 Dog 对象的字符串表示形式。当我们打印 my_dog 时，会自动调用str方法，并返回一个包含狗名称和品种的字符串。
如果类中未定义 __str__ 方法，并且我们尝试打印对象，则输出将显示类的内存位置。
<__main__.Dog object at 0x7f5887f2d210>
Python 中的 __repr__ 函数是什么？
在 Python 中，除了众所周知的 __str__ 方法外，我们还有另一个称为 __repr__ 的特殊函数。虽然侧重于提供对象的人类可读字符串表示形式，但 __str__ __repr__ 采用的方法略有不同。它旨在提供明确的、面向开发人员的对象表示形式。
通过在 Python 类中实现 __repr__ 方法，我们可以定义在调用 repr() 函数或打印对象本身时应如何表示对象。这使我们能够对输出进行细粒度的控制，并使其他开发人员能够更有效地理解对象的结构和属性。
Python 中 __repr__ 的语法
实现 __repr__ 的语法与 非常 __str__ 相似。让我们看一下基本语法：
class MyClass:
def __repr__(self):
# Return the string representation of the object
在方法中 __repr__ ，我们定义逻辑以生成对象的字符串表示形式。它可以包括属性值、计算结果或有助于准确重新创建对象的任何其他信息。
为了说明这一点，让我们考虑一个例子。假设我们有一个调用的类，其属性 Book 为 title 、 author 和 year 。我们可以在此类中实现 __repr__ 以提供有意义的字符串表示：
class Book:
def __init__(self, title, author, year):
self.title = title
self.author = author
self.year = year
def __repr__(self):
return f"Book(title='{self.title}', author='{self.author}', year={self.year})"
book = Book("Python Crash Course", "Eric Matthes", 2015)
print(book) # Book(title='Python Crash Course', author='Eric Matthes', year=2015)
在上面的示例中，该方法 __repr__ 返回一个表示 Book 对象的字符串。该字符串包括 title 、 author 和 year 属性的值，允许我们使用相同的值重新创建对象。
如果 __repr__ 方法未在类中实现，则当我们打印对象时，默认输出将是对象的内存位置。
<__main__.Book object at 0x7fe877f59450>
使用 __repr__ 不是强制性的，但最佳做法是提供有意义且明确的对象表示形式。这可以极大地帮助调试和理解开发过程中对象的状态。
您想了解如何自动创建 __init__ 和 __repr__ 方法吗？了解 Python Dataclass ，这是一项强大的功能，可让您使用预定义的方法（包括 __init__ 和 __repr__ ）创建类。
如何调用 Python __str__ 和 __repr__ 方法？
在 Python 中，有多种方法可以调用对象的 __str__ and __repr__ 方法。这些方法在提供对象的字符串表示形式方面起着至关重要的作用，使它们更具可读性和信息性。让我们探讨调用这些方法的三种常见方法。
使用 print（） 函数
调用 __str__ 或 __repr__ 方法的一种简单方法是使用该 print() 函数。将对象传递给 print() 时，它会自动调用对象的 __str__ 方法，并在控制台上显示字符串表示形式。
# Calling __str__ using print()
obj = MyClass()
print(obj) # Output: the string representation of obj
利用 str（） 或 repr（） 函数
Python 中的 and 函数允许我们分别显式调用 str() __str__ and __repr__ repr() 方法。通过将对象传递给这些函数，我们可以检索对象的字符串表示形式。
# Calling __str__ using str()
obj = MyClass()
str_representation = str(obj) # Output: the string representation of obj
# Calling __repr__ using repr()
obj = MyClass()
repr_representation = repr(obj) # Output: the string representation of obj
直接调用 Python __str__（） 或 __repr__（） 方法
调用 __str__ or __repr__ 方法的最直接方法是在对象上显式调用它们。通过直接访问这些方法，我们可以在不依赖其他函数或 print 语句的情况下获得字符串表示。
# Calling __str__ directly
obj = MyClass()
str_representation = obj.__str__() # Output: the string representation of obj
# Calling __repr__ directly
obj = MyClass()
repr_representation = obj.__repr__() # Output: the string representation of obj
📝 注意：直接调用
__repr__或__str__方法谨慎进行。通常建议使用str()repr()函数或print()函数，因为它们在代码中提供了更高的可读性和一致性。
Python 中__str__方法和__repr__方法的区别
使用 Python 时，您可能会遇到两种外观相似的方法：__str__ 和 __repr__。虽然这些方法有一些相似之处，但它们用于不同的目的并具有不同的用例。
让我们探讨一下 Python 中__str__方法和__repr__方法之间的差异：
| 特征 | __str__ | __repr__ |
|---|---|---|
| 目的 | 为最终用户提供可读的字符串表示形式。 | 为开发人员生成明确的表示形式。 |
| 用法 | 旨在为一般用户和显示创建输出。 | 用于调试、日志记录和对象重新创建。 |
| 返回类型 | 字符串 | 字符串 |
| 推荐内容 | 对象的简洁和用户友好的表示。 | 用于对象再创建的详细和精确表示。 |
| 函数重载 | 替代 str() 和 print() 函数。 | 覆盖 repr() ，可用于 eval() 娱乐。 |
| 日志记录的重要性 | 不太重要，主要用于最终用户显示。 | 更重要的是，有助于详细的对象表示。 |
Python __str__ vs __repr__
如您所见，这两种方法具有不同的用途，并且用于不同的方案。
__str__ 函数侧重于提供对象的人类可读字符串表示形式。它对一般用户很有用，旨在增强对象输出的可读性。
另一方面，__repr__ 函数旨在生成主要由开发人员使用的明确表示形式。它提供了更详细和精确的表示形式，使调试和重新创建对象变得更加容易。
为了更好地理解差异，让我们考虑一个例子：
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})"
def __repr__(self):
return f"Person(name='{self.name}', age={self.age})"
person = Person("Alice", 25)
print(str(person)) # Output: Person(name=Alice, age=25)
print(repr(person)) # Output: Person(name='Alice', age=25)
在此示例中，__str__ 方法提供了 person 对象的简洁表示形式，适合最终用户。另一方面，__repr__ 方法提供了更详细的表示形式，包括 name 属性周围的引号，这对于对象重新创建和调试非常有用。
Python __str__ 和 __repr__ 方法最佳实践
为了充分利用 Python str 和 repr 方法，遵循一些最佳实践非常重要。这些准则有助于提高代码的可读性和可用性。让我们探讨一下这些最佳实践：
- 保持简单和信息丰富：在字符串表示的简单性和信息性之间取得平衡。包括基本信息，而不会用过多的细节压倒读者。
- 使用清晰简洁的消息：制作直接而有意义的消息，传达对象的目的和状态。避免使用可能使读者感到困惑的技术术语。
- 考虑可读性：使用换行符和缩进等格式设置技术以视觉上吸引人的方式呈现信息。使读者一目了然地理解表示。
- 包括相关详细信息：重点关注有助于了解对象用途和功能的关键属性和状态变量。避免不必要的信息。
- 处理特殊字符：正确转义特殊字符以保持表示的完整性，尤其是在处理用户输入或包含特殊字符的数据时。
- 保持一致性：确保字符串表示形式与代码库的整体样式和约定一致。一致性提高了代码的可读性和可预测性。
- 测试和验证：彻底测试
__str__和__repr__方法，以验证表示形式是否准确反映了对象的状态和行为。使用各种场景和边缘情况进行测试。
总结
总之，掌握 Python str 和 repr 方法对于创建自定义对象的清晰且可读的字符串表示至关重要。通过实现__str__，可以增强代码可读性、简化调试并自定义输出以满足特定需求。
在本博客中，我们介绍了__str__和__repr__的基础知识、其实现、格式设置选项和最佳实践。我们还探索了真实世界的示例，并强调了它们在 Python 开发中的重要性。将__str__和__repr__作为有效传达代码和提高编程技能的强大工具。
祝您编码愉快！
常见问题 （FAQ）
Python 中的 __str__ 和__repr__方法有什么区别？
Python __str__ 方法用于提供对象的人类可读字符串表示，而__repr__旨在生成可用于重新创建对象的明确表示。
何时应使用 Python __str__ 和 __repr__ 方法？
当您需要主要用于显示和可读性的字符串表示形式时，请使用 __str__。当您需要用于调试、日志记录或对象重新创建的明确表示形式时，请使用 __repr__。
Python __str__和__repr__方法是否由子类继承？
是的，如果子类没有定义自己的__str__和__repr__方法，它将从其父类继承它们。但是，可以在子类中重写这些方法以提供特定的表示形式。
Python __str__ 和 __repr__ 方法是否会引发异常或产生副作用？
虽然通常不鼓励在__str__和__repr__方法中提出例外或产生重大副作用，但在某些情况下可能需要这样做。但是，请注意这些方法的预期用途，并将它们集中在对象表示上。