异常教程

Python repr() 函数（一文讲透）

更新时间:

💡一则或许对你有用的小广告

欢迎加入小哈的星球 ，你将获得：专属的项目实战 / 1v1 提问 / Java 学习路线 / 学习打卡 / 每月赠书 / 社群讨论

  • 新项目:《从零手撸：仿小红书（微服务架构）》 正在持续爆肝中，基于 Spring Cloud Alibaba + Spring Boot 3.x + JDK 17...，点击查看项目介绍 ;
  • 《从零手撸：前后端分离博客项目（全栈开发）》 2 期已完结，演示链接： http://116.62.199.48/ ;

截止目前， 星球 内专栏累计输出 82w+ 字，讲解图 3441+ 张，还在持续爆肝中.. 后续还会上新更多项目，目标是将 Java 领域典型的项目都整一波，如秒杀系统, 在线商城, IM 即时通讯，权限管理，Spring Cloud Alibaba 微服务等等，已有 2900+ 小伙伴加入学习 ，欢迎点击围观

前言

在 Python 编程中，字符串处理和对象表示是开发者经常需要面对的基础操作。repr() 函数作为 Python 内置函数之一，虽然看似简单，却在代码调试、对象序列化和数据展示等场景中扮演着重要角色。对于编程初学者来说，理解 repr() 的核心功能和使用场景，能够显著提升代码的健壮性和可维护性。而中级开发者则可以通过掌握 repr() 的进阶用法，进一步优化代码逻辑。本文将从基础概念、对比分析、实战案例等多个维度，系统性地讲解 repr() 函数的原理与应用。

一、基础概念：什么是 repr() 函数？

repr() 是 Python 内置的一个函数，全称是 representation（表示）。它的核心作用是 生成对象的“官方字符串表示”，即返回一个能够被 Python 解释器重新解析为该对象的字符串。简单来说，repr() 的目标是让字符串尽可能精确地还原对象的原始状态。

形象比喻：程序员的“身份证”

如果将 Python 对象比作一个人，那么 repr() 返回的字符串就像这个人的身份证号码——它包含了唯一且精确的标识信息，即使不直观，但能确保无歧义地还原对象。例如，一个日期对象的 repr() 可能是 "datetime.datetime(2023, 9, 20, 12, 30)"，而 str() 则可能更友好地显示为 "2023-09-20 12:30:00"。

基本语法

repr(object)

此函数接受任意对象作为参数，返回一个字符串。

二、与 str() 函数的区别：如何选择？

repr() 和 str() 是 Python 中两个用于生成对象字符串表示的核心函数，但它们的设计目标不同，需根据场景选择使用。

对比表格：关键差异

特性repr() 函数str() 函数
目标生成“可执行”的字符串（可还原对象）生成用户友好的展示字符串
输出格式尽可能精确，包含技术细节通常简洁，适合人类阅读
默认行为调用对象的 __repr__() 方法调用对象的 __str__() 方法
适用场景调试、日志记录、数据序列化用户界面显示、文件输出等

示例对比：以列表和自定义对象为例

示例 1：内置类型（如列表）

my_list = [1, 2, 3]  
print(repr(my_list))   # 输出：'[1, 2, 3]'  
print(str(my_list))    # 输出：'[1, 2, 3]'

此时两者输出相同，因为列表的 __repr__() 和 __str__() 默认一致。

示例 2：自定义对象

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

    def __repr__(self):  
        return f"Person({self.name!r}, {self.age!r})"  # 使用!r强制调用repr()  

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

p = Person("Alice", 30)  
print(repr(p))  # 输出：Person('Alice', 30)  
print(str(p))   # 输出：Alice, 30 years old

通过对比可见：

  • repr() 的输出包含单引号和参数名，符合“可解析”目标；
  • str() 的输出更简洁，适合直接展示给用户。

三、深入原理：对象的 __repr__() 方法

repr() 函数的实现依赖于对象的 __repr__() 方法。如果对象未定义该方法，Python 会提供一个默认的字符串（通常包含对象类型和内存地址）。

如何定义 __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})"  

p = Point(1, 2)  
print(repr(p))  # 输出：Point(x=1, y=2)

此方法需返回一个字符串，且建议包含足够的信息以重建对象。

默认 __repr__() 的示例

class DefaultRepr:  
    pass  

obj = DefaultRepr()  
print(repr(obj))  # 输出：<__main__.DefaultRepr object at 0x7f8b3c2a1d90>

默认输出仅包含对象类型和内存地址，无法直接解析为对象。

四、应用场景与实战案例

场景 1：调试与日志记录

在调试代码时，repr() 能提供更精确的信息。例如：

def log_error(obj):  
    print(f"Error occurred with object: {repr(obj)}")  

log_error(Point(3, 4))  # 输出：Error occurred with object: Point(x=3, y=4)

相比 str()，此输出能直接反映对象的参数值，便于快速定位问题。

场景 2：数据序列化与反序列化

当需要将对象保存为字符串后重新加载时，repr() 可确保数据无损。例如：

import ast  

p = Point(5, 6)  
serialized = repr(p)          # 输出："Point(x=5, y=6)"  
deserialized = eval(serialized)  # 需确保安全性，避免直接eval未知输入

注意：eval() 的使用需谨慎，仅适用于可信数据。

场景 3：交互式解释器中的自动输出

在 Python 的交互式环境中，输入对象名时会自动调用 __repr__()。例如：

>>> p = Point(7, 8)  
>>> p  
Point(x=7, y=8)

若未定义 __repr__(), 输出会退化为默认的内存地址格式。

五、常见问题与进阶技巧

问题 1：__repr__() 和 __str__() 是否必须同时定义？

答案：不需要。如果仅需一种字符串表示，可以选择性实现其中一个方法。例如，对于用户展示为主的对象，可只定义 __str__()。

问题 2：如何避免 repr() 的递归陷阱？

当对象包含自身引用时（如树结构节点），直接调用 repr() 可能引发无限递归。此时需在 __repr__() 中限制显示层级，例如：

class Node:  
    def __init__(self, value, parent=None):  
        self.value = value  
        self.parent = parent  

    def __repr__(self):  
        return f"Node(value={self.value}, parent={self.parent!r if self.parent else None})"

通过 !r 转换标志，递归调用 repr()，但需确保终止条件。

技巧：使用 !r 格式化标志

在 f-string 中，可通过 !r 强制调用对象的 __repr__() 方法：

name = "Bob"  
print(f"{name}")    # 输出：Bob  
print(f"{name!r}")  # 输出：'Bob'

此技巧在需要精确输出时非常有用。

六、最佳实践总结

  1. 始终为自定义类定义 __repr__()：即使 __str__() 已存在，__repr__() 对调试至关重要。
  2. 确保 __repr__() 的可读性与可解析性：输出应包含足够的参数信息，以便通过 eval() 重建对象。
  3. 谨慎使用 eval(repr(obj))：仅在信任数据源时执行，避免安全风险。
  4. 结合 __str__() 实现差异化输出：例如，__str__() 可返回更简洁的格式，而 __repr__() 保留技术细节。

结论

Python repr() 函数 是 Python 开发者工具箱中的核心工具之一，尤其在对象表示、调试和数据处理场景中不可或缺。通过理解其与 str() 的区别、掌握 __repr__() 方法的定义技巧，并结合实际案例实践，开发者能够编写出更健壮、可维护的代码。无论是初学者夯实基础，还是中级开发者优化复杂系统，深入掌握 repr() 函数都将带来显著的技术收益。

本文通过对比分析、代码示例和场景化讲解，系统性地解析了 Python repr() 函数 的原理与应用，希望读者能从中获得启发，并在实际项目中灵活运用这一工具。

最新发布

查看更多文章