Python中的__repr__

Python 中的 __repr__ 方法旨在提供尽可能明确的对象的字符串表示形式。__repr__ 的目标是返回一个字符串，该字符串允许某人使用 Python 的 eval（） 函数重新创建对象。

__repr__ 的主要特点：

• 以开发人员为中心：__repr__ 的输出面向开发人员，应包含有关对象的详细信息。
• 不含糊：__repr__ 返回的字符串应该是明确的，并且理想情况下是可执行的。
• 默认行为：如果没有在类中显式定义 __repr__，Python 将提供一个默认实现，该实现以 <ClassName object at memory_address> .

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return f"Point({self.x}, {self.y})"

point = Point(2, 3)
print(repr(point))  # Output: Point(2, 3)

在此示例中，__repr__ 方法定义为返回一个字符串，该字符串类似于为创建对象而编写的代码，使开发人员更容易理解对象的结构和值。

Python 中的__str__

Python 中的 __str__ 方法旨在提供对象的“漂亮”或用户友好的字符串表示形式。与面向开发人员的 __repr__ 不同，__str__ 方法适用于最终用户。__str__ 的输出通常比 __repr__ 更具可读性且细节更少，侧重于向用户呈现有意义的内容。

__str__ 的主要特点：

• 以用户为中心：__str__ 的输出旨在让用户易于理解，通常会省略对于理解对象状态不必要的技术细节。
• 读：__str__ 返回的字符串应干净、简洁且易于阅读。
• 默认行为：如果 __str__ 未在类中定义，Python 将回退到 __repr__ 方法。如果未定义 __repr__，则将使用 Python 的默认实现。

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return f"Point({self.x}, {self.y})"

    def __str__(self):
        return f"Point at coordinates ({self.x}, {self.y})"

point = Point(2, 3)
print(str(point))  # Output: Point at coordinates (2, 3)

在此示例中，定义了 __str__ 方法以返回 Point 对象的更易读性描述，适合向最终用户显示。。

__repr__和__str__之间的主要区别

尽管 __repr__ 和 __str__ 可能看起来很相似，但它们具有不同的用途和行为。以下是主要区别：

目的

• __repr__：主要目的是提供对象的详细、明确的字符串表示形式，这对于调试和开发非常有用。
• __str__：主要目的是提供对象的可读、用户友好的字符串表示形式，以便向最终用户显示。

输出表示

• __repr__：理想情况下，输出应为可用于重新创建对象的有效 Python 表达式。它侧重于提供足够的细节，以便对开发人员有用。
• __str__：输出旨在更易读，并且可能会省略技术细节。它专注于为用户提供清晰简洁的描述。

何时使用每个

• __repr__：当您需要精确和详细的对象表示时，特别是在日志记录、调试或与其他开发人员合作时使用。
• __str__：当您需要对对象进行更具可读性和用户友好的描述时使用，尤其是在向最终用户显示信息时。

__repr__和__str__的实际示例

为了更好地理解 __repr__ 和 __str__ 在实践中的使用方式，让我们看几个示例，这些示例演示了它们的不同用途和输出。

示例 1：自定义对象表示

考虑一个表示简单 2D 点的类。我们将定义 __repr__ 和 __str__ 方法，以查看它们在打印对象时有何不同。

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

    def __repr__(self):
        return f"Point({self.x}, {self.y})"

    def __str__(self):
        return f"Point located at ({self.x}, {self.y})"

point = Point(5, 7)

# Using repr()
print(repr(point))  # Output: Point(5, 7)

# Using str()
print(str(point))  # Output: Point located at (5, 7)

在此示例中，repr（point） 返回一个字符串，该字符串以可用于重新创建对象的方式表示对象。另一方面，str（point） 返回更具描述性和用户友好的消息。

示例 2：日志记录和调试

调试时，通常需要有关程序中对象的详细信息。这就是 __repr__ 的闪光点。

class Transaction:
    def __init__(self, amount, currency):
        self.amount = amount
        self.currency = currency

    def __repr__(self):
        return f"Transaction(amount={self.amount}, currency='{self.currency}')"

    def __str__(self):
        return f"{self.amount} {self.currency}"

transaction = Transaction(100, 'USD')

# Using repr() for logging
print(f"DEBUG: {repr(transaction)}")  # Output: DEBUG: Transaction(amount=100, currency='USD')

# Using str() for displaying to the user
print(transaction)  # Output: 100 USD

在这里，__repr__ 用于记录 Transaction 对象的详细表示，这有助于调试。但是，__str__ 提供了一种简洁易读的格式，供用户使用。

使用__repr__和__str__的最佳实践

要充分利用 Python 类中的 __repr__ 和 __str__，请考虑以下最佳实践：

1. 始终实施__repr__

• 即使您不打算使用 __str__，也最好为每个类实施 __repr__。一个实现良好的 __repr__ 对于调试和日志记录来说可能非常有价值。

2. 明确__repr__

• 确保 __repr__ 返回的字符串明确。如果可能，它应该返回一个字符串，该字符串可以传递给 eval（） 以重新创建对象。

3. 使__str__可读

• __str__ 返回的字符串应该易于阅读和理解。注重清晰度和简洁性，因为这是用户通常会看到的字符串。

4. 使用 F 字符串提高可读性

• 在实现这些方法时，请考虑使用 Python 的 f 字符串以提高清晰度和可读性，尤其是在将变量插入字符串时。

5. 考虑你的听众

• 请记住，__repr__ 是为开发人员服务的，__str__ 是为用户服务的。根据目标受众定制这些方法的内容。

通过遵循这些最佳实践，您可以确保在所有上下文中都清晰、适当地表示您的对象。

结论

了解 Python 中 __repr__ 和 __str__ 之间的差异对于创建定义明确且用户友好的类至关重要。虽然这两种方法都用于提供对象的字符串表示形式，但它们的用途不同：__repr__ 是为开发人员设计的，应该提供明确而详细的表示形式，而 __str__ 是为最终用户设计的，应该是可读和简洁的。