如何在Python中重写__str__和__repr__以优化日志输出

胖敏酱_1795

胖敏酱_1795

2026-09-14

986人浏览

原创

日志中__str__和__repr__输出异常,根本原因是用途错配:__str__应提供无引号、易读的简洁描述(如user(alice, 30)),专用于日志;__repr__须精确可复现(如user(name='alice', age=30)),仅用于调试。日志应统一用%s触发__str__,禁用f-string拼接,避免提前执行或引号污染。

如何在python中重写__str__和__repr__以优化日志输出

为什么 __str____repr__ 日志里总输出得不对

日志里打印对象时只看到 <__main__.user object at></__main__.user>,不是因为没写这两个方法,而是写了但没区分用途:把 __str__ 当成调试用、把 __repr__ 塞进日志格式化字符串里,结果要么信息太少,要么带引号和转义符干扰日志可读性。

关键判断:日志输出应优先依赖 __str__(面向用户/运维的简洁描述),而 __repr__ 必须能“被 eval 还原”或至少明确标识类型+关键字段——否则在 pdb 或日志上下文里查问题会多绕三步。

__str__ 怎么写才适合日志场景

它应该返回无格式、无引号、易扫读的纯文本,不暴露内部实现细节,也不包含换行或控制字符。日志系统(如 logging.info("user: %s", user))默认调用的就是这个。

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载
  • str() 而非 repr() 包裹字段值,避免多余引号:f"User({self.name}, {self.age})"User(Alice, 30);若写成 f"User({repr(self.name)}, {self.age})" 会变成 User('Alice', 30)
  • 敏感字段(如密码哈希)必须脱敏,哪怕 __repr__ 里保留完整值
  • 避免耗时操作:不要在 __str__ 里查数据库、调 API 或格式化大列表
  • 如果对象状态可能为 None 或未初始化,先做空值处理,否则日志里抛 AttributeError

__repr__ 的正确姿势是能“一眼定位问题”

它不是给日志用的,是给开发者看的——所以要精确、可复制、带类型提示。Python 内置容器(listdict)的 __repr__ 就是范本:字段名 + 值 + 类型边界清晰。

  • 格式建议统一为 f"{self.__class__.__name__}({arg1!r}, {arg2!r}, ...)",其中 !r 确保字段本身也走 repr,比如字符串带引号、None 显示为 None
  • 只暴露诊断必需字段:ID、状态码、关键标识符,别塞整个嵌套字典
  • 如果对象有动态计算属性(如 is_valid),__repr__ 里不要调用它——可能触发副作用或异常
  • 注意循环引用:若对象含 self-reference(如树节点的 parent),__repr__ 必须加保护逻辑,否则 logging.debug(obj) 直接栈溢出

日志配置里怎么避免踩坑

很多团队直接在 logging 格式里写 %(message)s,却忘了 logger 传参时是否已触发 __str__。最常错的是用 logging.debug("user=%s", user)(正确) vs logging.debug(f"user={user}")(危险)。

  • 用百分号格式化或 logging.debug("user=%s", user):安全,延迟调用 __str__
  • 避免 f-string 拼接对象:f"user={user}" 会在日志级别被过滤时仍执行 __str__,浪费性能且可能抛异常
  • 如果必须在格式串里用 __repr__(比如排查时想看原始结构),显式调用:logging.debug("raw: %r", user),而非依赖默认行为
  • 自定义 logging.Handler 中若重写了 format(),检查是否误用了 str(record.msg) 而非 record.getMessage() —— 后者才保证参数化格式化逻辑生效

真正容易被忽略的是:当对象嵌套层级深(比如 User 里有 ProfileProfile 里有 Address),每个类都得独立实现合理的 __str____repr__,缺一层就可能让整条日志变成一串内存地址。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1571

4

python能做什么
python能做什么

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

2023.07.25

3704

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

21237

23

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

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

2023.08.04

2627

5

python eval
python eval

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

2023.08.04

2687

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2063

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程