如何实现Python类的字符串友好显示_区别使用__str__与__repr__魔术方法

雨雪酱_2709

雨雪酱_2709

2026-05-10

217人浏览

原创

__str__面向用户,控制print()和str()输出;__repr__面向开发者,控制repr()、交互式回显和调试日志输出;二者语义不同,必须分别实现且返回str类型。

如何实现python类的字符串友好显示_区别使用__str__与__repr__魔术方法

直接说结论:用 __str__ 控制 print() 和 str() 的输出,面向用户;用 __repr__ 控制 repr()、交互式环境回显、日志调试输出,面向开发者——两者语义不同,不能只写一个凑合。

什么时候该实现 __str__

当你希望对象在被 print() 或转成字符串时,显示简洁、可读、带业务含义的内容。比如用户看到的订单摘要、日期格式化结果、配置项简要描述。

常见错误现象:print(user) 输出 <__main__.user object at></__main__.user>,说明没定义 __str__,或返回了 None(必须 return 字符串)。

实操建议:

  • __str__ 返回值必须是 str 类型,不能是 int 或 None
  • 避免包含内存地址、类型名等技术细节
  • 可复用 __repr__ 的逻辑,但要做简化,比如去掉引号、省略长字段
def __str__(self):
    return f"订单#{self.order_id}({self.status},¥{self.total:.2f})"

为什么 __repr__ 更重要,且必须能“被 eval”

在调试、日志、IPython/Jupyter 中,对象默认调用的是 __repr__。它应该做到:明确标识对象身份(类名 + 关键属性)、尽可能可重建(即 eval(repr(obj)) == obj 成立),至少是无歧义的。

容易踩的坑:

  • 只写了 __str__,没写 __repr__ → 日志里全是 <xxx object at ...></xxx>,查问题效率极低
  • __repr__ 返回了中文或空格开头的字符串 → 导致 eval() 失败,虽不强制要求可 eval,但这是行业共识
  • 漏掉关键字段(如 ID、状态),导致多个实例在日志中无法区分
def __repr__(self):
    return f"Order(order_id={self.order_id!r}, status={self.status!r}, total={self.total!r})"

注意 !r 是格式化语法,等价于 repr(),自动加引号、转义,比手动拼接更安全。

python-pro
python-pro

高级 Python 特性、异步编程、性能调优、静态类型、内存管理、Python 内部机制及生态库方面的专家。

下载

__str__ 和 __repr__ 在容器里的行为差异

列表、字典等容器调用 __str__ 时,内部元素用的是 __str__;但调用 __repr__ 时(比如你在终端敲 orders 回车),所有元素都走 __repr__。

这意味着:如果你只实现了 __str__,那么 print([obj]) 看起来正常,但 [obj] 在交互式环境里仍显示为 [<...>]</...>。

性能与兼容性提示:

  • __repr__ 不应太慢或触发副作用(比如查数据库),它可能被日志框架高频调用
  • 若对象不可重建(如含文件句柄、网络连接),__repr__ 应明确标注,例如 FileReader(path='xxx', closed=False)
  • 第三方库(如 dataclasses)默认只生成 __repr__,不会自动生成 __str__

别依赖继承链自动 fallback

Python 不会在找不到 __str__ 时自动用 __repr__ 替代(虽然某些文档这么说,但实际行为是 fallback 到父类的 __str__,而 object.__str__ 就是那个难看的 <...></...>)。同样,__repr__ 缺失也不会用 __str__ 补。

所以最稳妥的做法是:两个都显式定义,哪怕 __str__ 只是包装一层 __repr__ 的简化版。

真正容易被忽略的点:很多人在写单元测试时用 assert str(obj) == "...",却忘了检查 repr(obj) 是否也符合预期——尤其当对象用于断言失败消息或 pytest 的异常快照时,__repr__ 才是真正露脸的那个。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1671

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4184

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

24257

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2967

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2987

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1163

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2323

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程