在Python中怎样使用__repr__与__str__分别控制对象的展示格式?

夏杰同学_8528

夏杰同学_8528

2026-09-12

621人浏览

原创

__str__面向用户,应返回易读简洁的字符串;__repr__面向开发者,需可复现、含类型信息、适合调试,优先实现且避免重操作。

在python中怎样使用__repr__与__str__分别控制对象的展示格式?

__str__ 是给用户看的,__repr__ 是给开发者看的

直接说结论:__str__ 应该返回一个**易读、简洁、面向终端用户**的字符串,比如 "User(name='Alice', age=30)";而 __repr__ 必须尽可能返回一个**可复现、带类型信息、适合调试**的字符串,理想情况下能直接用 eval() 重建对象(虽不强制,但这是设计意图)。如果只实现一个,优先写 __repr__ —— 因为 print() 和日志里没定义 __str__ 时会自动 fallback 到 __repr__,但反过来不行。

常见错误:把 __repr__ 写成缩略版 __str__

很多人误以为 __repr__ 就是“更短的字符串”,于是写成 return f"User({self.name})"。这会导致两个问题:

  • 丢失关键字段(比如 age、id),调试时看不出对象真实状态
  • 没标注类名,日志里一堆 "Alice" 根本分不清是 User 还是 Profile
  • 字段值含空格或引号时,不加引号或转义会破坏可读性甚至语法合法性

正确做法是显式包含类名和所有关键属性,并对字符串字段加引号:return f"User(name={self.name!r}, age={self.age})"。注意 !r 会自动调用 repr(),处理好引号和转义。

交互式环境里 print() 和直接敲变量名的区别

在 IPython 或 Python REPL 中:

提示词大师-python版
提示词大师-python版

图片提示词生成器?不止如此。 马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。 用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。 用得越多,它越快:缓存机制让后续对话越来越省。 RAG进化:成功案例持续入库,越跑越聪明。 输入「新手指南」查看完整功能介绍

下载
  • 输入 user = User("Bob", 25) 后直接敲 user → 触发 __repr__
  • 输入 print(user) 或 logging.info(user) → 触发 __str__(如果定义了);否则 fallback 到 __repr__
  • str(user) 调 __str__,repr(user) 强制调 __repr__

这意味着你在写 CLI 工具时,__str__ 控制 print() 输出;但在写库时,别依赖用户一定看到 __str__ —— 很多人调试只敲变量名,所以 __repr__ 的质量直接影响第一印象。

性能与兼容性提醒:避免在 __repr__ 中做重操作

__repr__ 可能在日志、异常 traceback、pdb 调试中被频繁调用,甚至在对象还没完全初始化好时就被触发(比如 __init__ 抛异常前)。所以:

  • 不要在 __repr__ 里访问数据库、读文件、调远程 API
  • 避免调用可能抛异常的属性(如未初始化的 self._cache),可用 getattr(self, '_cache', 'N/A') 防御
  • 如果对象字段很多,考虑只展示关键字段,或加长度限制(如 self.description[:50] + '...')
  • 在 __str__ 里可以更自由地格式化,但也要避免隐式 IO —— 毕竟 print() 可能出现在热路径上

最常被忽略的一点:当子类继承父类且只重写 __str__ 时,__repr__ 仍沿用父类的——这容易导致父类 __repr__ 打印出子类对象却显示父类名,造成混淆。务必检查继承链上的 __repr__ 是否准确反映当前类。

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

相关专题

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

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

2023.07.20

1631

4

python能做什么
python能做什么

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

2023.07.25

3964

7

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

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

2023.07.31

1629

3

python教程
python教程

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

2023.08.03

22777

23

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

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

2023.08.04

2787

5

python eval
python eval

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

2023.08.04

2847

5

scratch和python区别
scratch和python区别

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

2023.08.11

1123

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2203

5

热门下载

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

精品课程

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