Python 的 repr() 函数：对象的可打印表示

更多Python学习内容：ipengtao.com

在 Python 中，repr() 函数是用于获取对象的“官方”字符串表示形式的内置函数之一。这个函数返回一个对象的字符串表示形式，通常是可以用来重新创建该对象的表达式。本文将探讨 repr() 函数的工作原理、用法示例以及常见注意事项。

什么是 repr() 函数？

repr() 函数是 Python 中的一个内置函数，用于获取对象的“官方”字符串表示形式。

它的基本语法如下：

repr(object)

• object 是要获取字符串表示形式的对象。如果提供了 object 参数，则返回该对象的字符串表示形式；否则，返回一个包含类名的字符串。

repr() 函数的基本用法

1. 获取对象的字符串表示形式

num = 123
num_repr = repr(num)

print("Repr of number:", num_repr)

在这个示例中，使用 repr() 函数获取了数字 123 的字符串表示形式。

2. 获取对象类型的字符串表示形式

class MyClass:
    pass

obj = MyClass()
obj_repr = repr(obj)

print("Repr of object:", obj_repr)

在这个示例中，使用 repr() 函数获取了自定义类 MyClass 的字符串表示形式，该字符串表示形式包含类名。

3. 获取字符串的字符串表示形式

my_str = "hello"
str_repr = repr(my_str)

print("Repr of string:", str_repr)

在这个示例中，使用 repr() 函数获取了字符串 "hello" 的字符串表示形式。

repr() 函数的参数选项

repr() 函数还有一些参数选项，可以提供更多控制和定制的功能。

1. 自定义对象的字符串表示形式

可以在自定义类中定义 __repr__() 方法，以提供对象的自定义字符串表示形式。

class MyClass:
    def __repr__(self):
        return "Custom representation of MyClass"

obj = MyClass()
obj_repr = repr(obj)

print("Custom repr of object:", obj_repr)

在这个示例中，定义了 MyClass 类的 __repr__() 方法，以提供自定义的字符串表示形式。

2. 与 eval() 函数配合使用

repr() 函数返回的字符串通常可以作为参数传递给 eval() 函数，用于重新创建原始对象。

num = 123
num_repr = repr(num)

num_recreated = eval(num_repr)

print("Recreated number:", num_recreated)

在这个示例中，使用 repr() 函数获取了数字 123 的字符串表示形式，并通过 eval() 函数重新创建了原始对象。

repr() 函数的应用场景

repr() 函数在 Python 中有许多应用场景，以下是一些常见的应用情况，以及相应的示例代码：

1. 调试信息

在调试过程中，repr() 函数可以用于获取对象的详细信息，帮助开发者理解代码执行过程中的状态和变化。

my_dict = {'name': 'Alice', 'age': 30}
print("Debug info:", repr(my_dict))

2. 重新创建对象

repr() 函数返回的字符串通常包含了创建对象所需的信息，因此可以用于重新创建原始对象。

num = 123
num_repr = repr(num)

num_recreated = eval(num_repr)

print("Recreated number:", num_recreated)

3. 自定义对象的字符串表示形式

通过在自定义类中定义 __repr__() 方法，可以提供对象的自定义字符串表示形式，方便调试和理解。

class MyClass:
    def __repr__(self):
        return "Custom representation of MyClass"

obj = MyClass()
print("Custom repr of object:", repr(obj))

4. 与 eval() 函数配合使用

repr() 返回的字符串通常可以直接作为参数传递给 eval() 函数，用于重新创建对象。

data = [1, 2, 3, 4, 5]
data_repr = repr(data)

data_recreated = eval(data_repr)

print("Recreated data:", data_recreated)

5. 对象序列化

在序列化对象时，可以使用 repr() 函数获取对象的字符串表示形式，然后将其保存到文件或数据库中。

import pickle

data = {'name': 'Bob', 'age': 25}
data_repr = repr(data)

with open('data.txt', 'w') as f:
    f.write(data_repr)

# 从文件中读取字符串表示形式并重新创建对象
with open('data.txt', 'r') as f:
    data_recreated = eval(f.read())

print("Recreated data:", data_recreated)

6. 与 logging 模块配合使用

在日志记录过程中，repr() 函数可以用于获取对象的详细信息，并将其记录到日志文件中。

import logging

logging.basicConfig(filename='example.log', level=logging.DEBUG)

my_list = [1, 2, 3, 4, 5]
logging.debug("List info: %s", repr(my_list))

repr() 函数的注意事项

• 可读性：repr() 函数返回的字符串通常是给开发者看的，而不是最终用户，因此它可能包含更多的细节和结构化信息。

• 与 str() 的区别：repr() 函数返回的字符串通常用于调试和开发，而 str() 函数返回的字符串用于显示给最终用户。

• 自定义 __repr__() 方法：为自定义类定义 __repr__() 方法是一个好的实践，可以提供对象的自定义字符串表示形式。

总结

repr() 函数是 Python 中一个重要且常用的函数，用于获取对象的字符串表示形式。通过合理地使用 repr() 函数，可以提高代码的可读性、可维护性和调试效率。希望本文提供的示例能够帮助大家更好地理解和应用 repr() 函数，从而更好地进行 Python 编程。

如果你觉得文章还不错，请大家 点赞、分享、留言 ，因为这将是我持续输出更多优质文章的最强动力！

更多Python学习内容：ipengtao.com

↙点击下方“阅读原文”查看更多