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

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

雨雪酱_2709

雨雪酱_2709

发布时间:2026-05-10 12:12:36

|

217人浏览过

|

来源于php中文网

原创

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

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

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

什么时候该实现 __str__

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

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

实操建议:

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

  • __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 成立),至少是无歧义的。

容易踩的坑:

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载
  • 只写了 __str__,没写 __repr__ → 日志里全是 <xxx object at ...>,查问题效率极低
  • __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(),自动加引号、转义,比手动拼接更安全。

__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__ 才是真正露脸的那个。

热门AI工具

更多
LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

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

DeepSeek

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

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

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

UpDream
UpDream Hot

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

相关专题

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

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

1671

2023.07.20

python能做什么
python能做什么

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

4204

2023.07.25

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

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

1669

2023.07.31

python教程
python教程

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

24397

2023.08.03

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

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

2987

2023.08.04

python eval
python eval

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

3007

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

热门下载

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

精品课程

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

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