0

0

Python 对象调试友好性的实现方式

冷漠man

冷漠man

发布时间:2026-02-16 14:26:02

|

285人浏览过

|

来源于php中文网

原创

__repr__ 更适合调试,因其目标是清晰标识对象身份与状态,如 ;而 __str__ 面向用户展示,对调试无用。

python 对象调试友好性的实现方式

为什么 __repr____str__ 更适合调试

调试时你真正需要的不是“好看”,而是“能一眼看出对象是谁、在哪、状态如何”。__repr__ 的设计目标就是这个——它默认返回带类型名和内存地址的字符串,比如 <user object at></user>;而 __str__ 是给用户看的,空实现或返回空字符串都合法,对 debug 几乎没用。

实操建议:

伴江行购物商城系统
伴江行购物商城系统

傻瓜式的程序安装和调试,用户无需考虑系统的安装维护,美观、友好的展示铺面,设计中应用了多种网络安全技术,顾客可以方便的查询并订购商品,用户可以方便的定义各种商品信息,系统选用强大的数据库保存各类信息,系统支持多种浏览器,功能模块清晰实用强大,系统有着良好的扩充性和升级性,强大的在线支付系统和订单系统登陆地址/admin/login.asp后台登陆账号:admin密码:admin

下载
  • 所有自定义类,只要可能被 print()logging.debug() 或 pdb 中直接查看,就该实现 __repr__
  • __repr__ 返回值最好满足“可被 eval() 还原”(非必须,但强烈推荐),例如 User(name='alice', age=30)User(alice, 30) 更安全
  • 避免在 __repr__ 中调用耗时操作(如数据库查询、文件读取)或引发副作用——它可能被日志框架、Jupyter 自动触发多次

dataclass 自动生成调试友好的 __repr__

手写 __repr__ 容易漏字段、拼错引号、忘记转义。Python 3.7+ 的 @dataclass 默认开启 repr=True,会自动拼出带字段名和值的字符串,且自动处理嵌套对象、None、字符串引号等细节。

常见错误现象:用了 @dataclass 却发现打印出来还是地址——大概率是忘了加 __slots__ = () 或用了 __init__ 覆盖了生成逻辑;或者字段值本身没有好 __repr__(比如自定义类没实现它)。

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

实操建议:

  • 优先用 @dataclass(repr=True)(默认就是),而不是手动写 __repr__
  • 敏感字段(如密码)用 field(repr=False) 排除,别靠删字段或改逻辑隐藏
  • 如果类继承自某个已有类,且父类没用 @dataclass,子类加 @dataclass 不会自动包含父类字段——得显式声明或用 fields 手动合并

IPython / Jupyter 中 _pprint 的实际效果差异

交互环境中,敲完一个对象回车,显示的是它的 __repr__;但用 pprint.pprint(obj) 或 IPython 的 %pprint 魔法命令,会做缩进、换行、截断长列表——这对嵌套 dict/list 很友好,但对单个简单对象反而多此一举,甚至掩盖关键信息(比如 __repr__ 里特意写的 ID 字段被折行藏掉了)。

性能影响:大对象用 pprint 可能明显卡顿,因为要递归遍历;而 __repr__ 是即时计算的,可控性强。

实操建议:

  • 日常调试优先依赖 __repr__ 输出,而不是养成每行都敲 pprint() 的习惯
  • 真遇到嵌套太深看不清,先试 print(repr(obj)) 看原始 repr 是否已含足够信息;再考虑 pprint(obj, width=60, depth=3) 控制深度和宽度
  • IPython 中 _(上一个表达式结果)的 __repr__ 会被自动调用,但如果你重载了 __getattr__ 或用了 __getattribute__,可能意外干扰 _ 的行为

调试时 vars()dir()inspect.getmembers() 怎么选

vars(obj) 只返回 obj.__dict__,快、干净,但不包含 property、描述符、继承来的属性;dir(obj) 返回所有可访问名(含方法、特殊方法、继承链上的),但混杂噪音;inspect.getmembers(obj) 最灵活,能按条件过滤(比如只取数据属性),但默认会触发 property 的 getter,有副作用风险。

容易踩的坑:在调试中直接用 dir(obj) 查字段,结果看到一堆 __weakref___private,误以为是业务字段;或者用 inspect.getmembers(obj, lambda x: not callable(x)) 想过滤方法,却把 lazy property 给算进去了。

实操建议:

  • 查实例字段优先用 vars(obj),确认对象有 __dict__(即没用 __slots__
  • 查类接口或方法列表用 dir(obj),但记得配合 help(obj.method) 看文档,别只看名字
  • 需要精确控制时,用 inspect.getmembers(obj, lambda v: not callable(v) and not isinstance(v, (property, functools.cached_property))),避开 descriptor 副作用
调试友好性不是加一堆日志,而是让每个对象自己说清楚“我是谁、我有啥”。最常被忽略的一点:很多人实现了 __repr__,却忘了检查它是否在子类继承后依然正确——尤其是用了 super().__repr__() 拼接时,父类 repr 格式一变,整个输出就乱了。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

192

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

12

2026.02.03

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

552

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

216

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1552

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

925

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

876

2024.04.29

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

145

2026.02.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号