【Python】 深入理解 Python 的 repr 方法

为何每次早餐 仍然魂离魄散
原来 那朝分手都要啜泣中上班
明明能够过得这关 赢回旁人盛赞
原来 顽强自爱这样难
难得的激情总枉费
残忍的好人都美丽
别怕 你将无人会代替
                     🎵 陈慧娴《情意结》

在 Python 编程中，调试和打印对象信息时，常常需要使用一种方法来获取对象的“官方”字符串表示形式。repr 方法正是为此设计的，它提供了一种方式来生成对开发者友好的对象表示。本文将详细介绍 repr 方法的用法及其在实际编程中的应用。

什么是 repr？

repr 是 Python 的内置函数，返回一个对象的字符串表示，该表示旨在准确且清晰地描述对象，通常用于调试和开发。它的语法如下：

repr(object)

• object：任何 Python 对象。
  返回值是一个字符串，表示对象的官方字符串表示形式。

repr 方法的基本用法

我们通过一些简单的例子来展示 repr 的基本用法：

# 基本数据类型的 repr 表示
print(repr(123))  # 输出: '123'
print(repr(3.14))  # 输出: '3.14'
print(repr('Hello, world!'))  # 输出: "'Hello, world!'"
print(repr([1, 2, 3]))  # 输出: '[1, 2, 3]'

可以看到，repr 方法返回了这些对象的详细字符串表示，这些表示形式可以用于重新创建对象。

repr 和 str 的区别

repr 和 str 都是用于生成对象的字符串表示，但它们有不同的目的和用法：

• repr：返回对象的官方表示，通常可以用来重新创建对象，主要用于调试和开发。
• str：返回对象的非正式表示，适合人类阅读，主要用于展示给最终用户。
  下面的例子展示了两者的区别：

import datetime

# 创建一个 datetime 对象
now = datetime.datetime.now()

# 使用 repr 和 str
print(repr(now))  # 输出: 'datetime.datetime(2024, 7, 21, 10, 20, 0, 123456)'
print(str(now))  # 输出: '2024-07-21 10:20:00.123456'

在这个示例中，repr(now) 返回了一个详细的字符串，包含了创建 datetime 对象所需的所有信息，而 str(now) 返回了一个适合人类阅读的日期时间字符串。

自定义对象中的 repr

对于自定义对象，我们可以通过实现 repr 方法来自定义其 repr 表示。这对于调试复杂对象非常有用。以下是一个示例：

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

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

# 创建一个 Point 对象
p = Point(2, 3)

# 使用 repr
print(repr(p))  # 输出: 'Point(x=2, y=3)'

在这个示例中，我们定义了一个 Point 类，并实现了 repr 方法。这样，当调用 repr§ 时，会返回一个详细的字符串表示，描述 Point 对象的状态。

repr 在调试中的应用

repr 在调试和开发中非常有用，特别是在需要检查复杂对象时。例如，我们可以使用 repr 来打印日志，记录对象的状态：

import logging

class Rectangle:
    def __init__(self, width, height):
        self.width = width
        self.height = height

    def __repr__(self):
        return f"Rectangle(width={self.width}, height={self.height})"

# 设置日志配置
logging.basicConfig(level=logging.DEBUG)

# 创建一个 Rectangle 对象
rect = Rectangle(10, 20)

# 记录对象的状态
logging.debug(f"Created rectangle: {repr(rect)}")

在这个示例中，logging.debug 使用 repr 方法记录了 Rectangle 对象的详细状态，有助于在调试时了解对象的内部状态。

总结

repr 是 Python 中一个强大的内置函数，提供了对象的官方字符串表示，主要用于调试和开发。通过实现自定义对象的 repr 方法，可以控制对象的表示，方便调试和日志记录。