如何在Python中正确重写__str__和__repr__方法?

夏静大大_9183

夏静大大_9183

2026-06-13

645人浏览

原创

__str__面向用户,应简洁可读、体现业务语义;__repr__面向开发者,需无歧义、尽可能可复现,用于调试、日志和测试。

如何在python中正确重写__str__和__repr__方法?

重写 __str__ 和 __repr__ 不是为了“看起来更漂亮”,而是为了让对象在不同上下文中被正确、无歧义地呈现——__str__ 面向人,__repr__ 面向开发者和调试器。

什么时候该用 __str__?

当对象被 print()、str() 或字符串格式化(如 f"{obj}")调用时,Python 会找 __str__。它的输出应该简洁、可读、带语义,不暴露内部实现细节。

  • 避免返回空字符串或纯类型名(如 "<myclass object at>"</myclass>),那是 __repr__ 的默认行为,不是 __str__ 的职责
  • 不要包含内存地址、哈希值等调试信息
  • 如果类表示一个业务实体(比如 User),优先返回有意义的业务字段:f"User(name='{self.name}', email='{self.email}')" 是 __repr__ 风格;而 __str__ 可以是 f"{self.name} "
  • 注意编码安全:如果字段可能为 None 或含特殊字符,做基础处理,比如 str(self.name or 'N/A')

为什么 __repr__ 必须尽可能“可复现”?

Python 的交互式解释器、logging、pprint、异常 traceback 都默认调用 __repr__。它本质是“开发者的接口”——理想情况下,返回的字符串应能直接粘贴进 Python 解释器并重建该对象(至少语义上接近)。

  • 必须返回字符串(不能是 None 或其他类型),否则会触发 TypeError: __repr__ returned non-string (type NoneType)
  • 字段顺序建议与 __init__ 参数一致,方便一眼对应:def __init__(self, name, age): ... → __repr__ 返回 f"Person(name={self.name!r}, age={self.age})"
  • 用 !r 格式化字符串内嵌字段,确保引号、转义符等被正确包裹(self.name 是 "O'Reilly",{self.name!r} 就是 "'O\'Reilly'")
  • 复杂对象(如含列表、嵌套对象)不必强求 100% 可 eval,但至少保证关键字段完整、无歧义、不截断

__repr__ 没写好会导致哪些实际问题?

最常见的是日志混乱、调试困难、测试断言失败——尤其在使用 assert obj1 == obj2 但没定义 __eq__ 时,报错信息里全是 <__main__.myclass object at></__main__.myclass>,根本看不出两个对象差在哪。

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
  • 单元测试中,assertEqual(obj, expected_obj) 失败时,diff 显示的是 __repr__ 结果;如果它只返回 "MyClass()",你无法判断是哪个字段不匹配
  • 在 Jupyter 中,变量最后一行自动显示 __repr__;如果返回过长或含控制字符,会破坏 notebook 渲染
  • 用 dataclass 时,默认生成的 __repr__ 很规范,但若手动重写却漏掉某个字段,就可能掩盖数据不一致问题
  • 某些 ORM(如 SQLAlchemy)依赖 __repr__ 做调试输出,字段缺失会导致误判对象状态

一个安全、可维护的模板写法

别硬背规则,用这个结构起步:

def __repr__(self):
    attrs = ", ".join(f"{k}={v!r}" for k, v in self.__dict__.items())
    return f"{self.__class__.__name__}({attrs})"
<p>def <strong>str</strong>(self):</p><h1>选 1–2 个最能代表业务身份的字段</h1><pre class="brush:python;toolbar:false;">return f"{self.name} (ID: {self.id})" if hasattr(self, 'name') else super().__str__()

注意:self.__dict__.items() 不包含属性(property)、描述符或动态计算字段,所以生产环境建议显式列出关键字段,而不是盲目遍历 __dict__。真正容易被忽略的是:当父类已有 __repr__ 且子类只是加了几个字段时,很多人直接覆盖却不调用 super().__repr__(),结果丢失父类状态——这种继承场景下,要么显式拼接,要么重构为组合模式。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4604

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

27257

23

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

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

2023.08.04

3287

5

python eval
python eval

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

2023.08.04

3307

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2563

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习