讲师中心 微信公众号
AI工具推荐 视频效率加速

如何通过Python中的__str__和__repr__定制对象的输出格式?

冬萱大大_8689

冬萱大大_8689

发布时间:2026-08-14 11:39:22

|

607人浏览过

|

来源于php中文网

原创

__str__是面向用户的简洁可读表示,__repr__是面向开发者的无歧义可复现表示;二者必须返回str,__repr__应尽量满足eval(repr(obj))语义等价,且缺失__str__时会自动回退到__repr__。

如何通过python中的__str__和__repr__定制对象的输出格式?

直接说结论: __str__ 是给人看的字符串表示,__repr__ 是给开发者/调试器看的“可复现”表示;二者都该返回 str,且 __repr__ 应尽量满足 eval(repr(obj)) == obj(至少语义上成立)。

什么时候该重写 __str__?

当你希望 print(obj) 或 str(obj) 输出易读、带业务含义的文本时。比如日志里打印订单对象,你不想看到 <Order object at 0x...>,而想要 "Order #12345, status: paid"。

  • 只影响 print()、str()、f-string 中的 {obj} 等“用户友好”场景
  • 不必严格可执行,允许省略细节(如不显示内部 ID 或时间戳)
  • 避免换行、控制字符;保持单行、UTF-8 可读
  • 如果没定义 __str__,Python 会 fallback 到 __repr__

为什么 __repr__ 更关键?

它被 repr()、交互式解释器回显、logging 默认格式、pytest 断言失败输出等大量底层机制调用。写得不好,调试时就只能靠 obj.__dict__ 硬翻。

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
  • 目标是“无歧义 + 尽量可重建”,例如 Point(x=1.0, y=2.0) 比 "(1.0, 2.0)" 更好
  • 参数名要显式写出,避免位置歧义:datetime(2023, 10, 5) 比 "2023-10-05" 更明确
  • 若对象不可重建(如含文件句柄、网络连接),至少保留类型+关键状态:"<connection state="OPEN" timeout="30s">"</connection>
  • 别返回空字符串或 None —— 这会导致 TypeError: __repr__ returned non-string

__str__ 和 __repr__ 写反了会怎样?

常见错误是把 __repr__ 当成美化输出来写,结果在 logging.debug("obj=%r", obj) 里打出一堆带颜色 ANSI 码,或者在 pytest 报错中看到冗长 HTML 片段 —— 这些本该由 __str__ 负责,但 __repr__ 被污染后就全乱了。

立即学习“Python免费学习笔记(深入)”;

  • __repr__ 返回非字符串(如 return f"[{self.name}]" 但忘了加 str() 包裹)→ 直接抛 TypeError
  • __str__ 返回 None → 打印出 "None",而不是预期内容
  • 两个方法都未实现 → 统一 fallback 到默认的 <ClassName object at 0x...>
  • 用 f"{obj!r}" 强制触发 __repr__ 时,若它太重(比如触发数据库查询),会导致性能意外下降

真正难的不是语法,而是判断哪些字段该进 __repr__(比如缓存字段、临时状态通常不该出现),以及如何平衡可读性与可重建性。很多团队最后发现:写个专用的 to_dict() 或 debug_info() 方法,比硬塞进 __repr__ 更可控。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

1651

2023.07.20

python能做什么
python能做什么

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

4124

2023.07.25

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

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

1649

2023.07.31

python教程
python教程

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

23817

2023.08.03

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

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

2907

2023.08.04

python eval
python eval

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

2947

2023.08.04

scratch和python区别
scratch和python区别

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

1143

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn