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

如何在Python中利用__str__与__repr__提升调试效率

风磊同学_5983

风磊同学_5983

发布时间:2026-10-21 06:55:38

|

772人浏览过

|

来源于php中文网

原创

__repr__用于调试,应返回可重建对象的ASCII表达式;__str__用于展示,可读性强。未实现__repr__时调试信息无用,错误实现会导致print和repr行为混乱。

如何在python中利用__str__与__repr__提升调试效率

直接说结论:用 __str__ 给人看,用 __repr__ 给开发者/调试器看;不实现或写错其中一个,print() 和 repr() 行为会混乱,日志和交互式调试时反而更难定位问题。

什么时候该重写 __repr__?

当你在 REPL、logging.debug()、pprint 或异常 traceback 中看到类似 <MyClass object at 0x7f8a1c2b3e50> 这种信息时,说明 __repr__ 没提供有效线索。

  • 理想状态:返回能「重建对象」的字符串(如 Point(x=1, y=2)),至少包含类名和关键属性
  • 不要返回空字符串、纯类型名或含内存地址的默认值
  • 避免调用耗时操作(如数据库查询、文件读取)——__repr__ 可能在任意时刻被触发,包括断点暂停时
  • 如果对象不可重建(比如含闭包或临时句柄),优先保证「可读 + 唯一性」,例如 Connection(state='closed', id=42)

__str__ 和 __repr__ 的行为差异在哪?

它们触发场景不同,不是“一个简版一个详版”那么简单:

  • print(obj)、str(obj)、f"{obj}" 调用 __str__;没定义时自动回退到 __repr__
  • repr(obj)、交互式环境直接输入变量名、logging.info(repr(obj)) 强制走 __repr__;它从不回退
  • __str__ 可以返回中文、换行、emoji 等易读内容;__repr__ 应只含 ASCII 字符,且尽量是合法 Python 表达式
  • 列表、字典等容器调用 __repr__ 显示元素,但内部每个元素都用自己的 __repr__ —— 所以子对象也得写好,否则嵌套打印全是地址

常见错误写法与修复示例

以下代码看似合理,实则埋雷:

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

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

下载

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

class User:
    def __init__(self, name, email):
        self.name = name
        self.email = email
<pre class='brush:python;toolbar:false;'>def __repr__(self):
    return f"User({self.name}, {self.email})"  # ❌ 缺少引号,eval 会报错

def __str__(self):
    return self.name  # ✅ 简洁,但可能丢失上下文</pre>

修正后:

class User:
    def __init__(self, name, email):
        self.name = name
        self.email = email
<pre class='brush:python;toolbar:false;'>def __repr__(self):
    return f"User(name={self.name!r}, email={self.email!r})"  # ✅ !r 自动加引号

def __str__(self):
    return f"{self.name} <{self.email}>"  # ✅ 更实用的显示格式</pre>
  • !r 是关键:它调用 repr() 对字段做转义,避免 name="O'Connor" 导致语法错误
  • 别在 __repr__ 里用 json.dumps() 或 pprint.pformat() —— 它们本身依赖 __repr__,可能引发递归
  • 如果类有大量属性,用 vars(self) 动态生成 __repr__ 是可行的,但要过滤掉私有属性和方法:{k: v for k, v in vars(self).items() if not k.startswith('_')}

最常被忽略的一点:第三方库(如 dataclasses、pydantic)默认生成的 __repr__ 很友好,但一旦你手动写了 __str__ 却漏了 __repr__,调试时就只剩地址了——因为 __str__ 不会影响 repr() 的行为。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

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

Atoms
Atoms Hot

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

DeepSeek

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

WorkBuddy

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

相关专题

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

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

1771

2023.07.20

python能做什么
python能做什么

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

4604

2023.07.25

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

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

1729

2023.07.31

python教程
python教程

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

27237

2023.08.03

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

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

3287

2023.08.04

python eval
python eval

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

3307

2023.08.04

scratch和python区别
scratch和python区别

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

1203

2023.08.11

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

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

596

2023.08.10

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

100

2026.10.16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

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