如何在Python中重写__str__与__repr__便于线上排查

大伟吖_2493

大伟吖_2493

2026-10-26

854人浏览

原创

__str__面向用户,__repr__面向开发者和调试器;前者需返回str类型且避免敏感信息,后者应含类名、关键字段并用!r格式化,禁用耗时操作与未定义属性。

如何在python中重写__str__与__repr__便于线上排查

__str__ 和 __repr__ 的核心区别在哪

线上排查时,__str__ 是给用户看的,__repr__ 是给人(尤其是开发者)和调试器看的。别把 __repr__ 写成“美化版字符串”——它得能尽量还原对象,最好能直接 eval() 出原对象(虽不强求,但结构要清晰)。如果两个方法返回一样,等于放弃了一半调试信息。

线上日志里 print(obj) 没反应?检查 __str__ 返回值类型

__str__ 必须返回 str,返回 None、int 或抛异常都会让 print() 报 TypeError: __str__ returned non-string。线上服务一旦触发这个错误,可能静默吞掉整条日志或导致格式错乱。

  • 务必用 return str(...) 或格式化字符串,别漏 return
  • 避免在 __str__ 中访问可能为 None 的属性并直接调用 .name —— 加 getattr(obj, 'name', 'N/A') 或 hasattr() 防崩
  • 敏感字段(如 token、password)别进 __str__,但可在 __repr__ 里用 '***' 占位

__repr__ 怎么写才对调试友好

理想 __repr__ 应包含类名 + 关键可追溯字段 + 简洁结构。别堆全部属性,重点选能定位实例身份的字段(如 id、pk、url、state)。

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载

示例:

def __repr__(self):
    return f"<order id="{self.id}" status="{self.status}" created_at="{self.created_at!r}">"</order>
  • 用 !r 格式化字段值(比如 str 加引号、None 显示为 None),避免歧义
  • 字段顺序按重要性排:身份标识优先(id),状态次之(status),时间戳靠后
  • 避免在 __repr__ 中触发数据库查询或网络请求——线上调用频繁,容易拖慢日志输出甚至引发死锁

线上环境 __repr__ 被截断?注意日志框架的长度限制

很多日志系统(如 Loguru、structlog)默认截断长字符串,__repr__ 一写太全,关键字段反而被砍掉。不是代码错了,是日志没显示全。

  • 控制 __repr__ 长度:字段值用 textwrap.shorten(value, width=20) 或手动截取
  • 对长列表/字典,只展示长度和前几项:f"items[{len(self.items)}]={self.items[:3]}"
  • 本地调试可开全量,但上线前建议加个开关(如 os.getenv('DEBUG_REPR'))做分级输出

最常被忽略的是:__repr__ 里用了未定义的属性或引发 AttributeError,会导致整个对象在日志中显示为 <__main__.myclass object at></__main__.myclass>——看着像正常,实则关键信息全丢了。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1811

4

python能做什么
python能做什么

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

2023.07.25

4764

7

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

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

2023.07.31

1769

3

python教程
python教程

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

2023.08.03

28417

23

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

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

2023.08.04

3407

5

python eval
python eval

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

2023.08.04

3427

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2643

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习