如何在Python中正确使用__repr__和__str__方法

轻芳姑娘_8301

轻芳姑娘_8301

2026-11-01

523人浏览

原创

__str__面向用户,返回易读字符串(如"User: alice (id=42)");__repr__面向开发者,要求精确无歧义、 ideally 可 eval 重建(如User("alice", id=42)),容器打印时默认调用__repr__。

如何在python中正确使用__repr__和__str__方法

__str__ 是给用户看的,__repr__ 是给开发者看的

两者都返回字符串,但定位完全不同:__str__ 应该返回易读、友好的描述(比如 "User: alice (id=42)"),用于 print() 或 str();而 __repr__ 必须尽可能精确、无歧义,理想情况下能直接复制粘贴进 Python 解释器重建对象(比如 User("alice", id=42))。如果只实现一个,优先写 __repr__ —— 它是调试时默认 fallback,__str__ 缺失时会自动调用它。

__repr__ 必须保证可被 eval() 重建(理想情况)

这不是强制要求,但强烈建议。尤其在数据类、模型类或配置对象中,清晰的 __repr__ 能极大提升 debug 效率。常见错误是拼接字符串时漏掉引号、没转义、或用了不可序列化的值(如函数、文件句柄)。

  • 正确:return f"Point(x={self.x!r}, y={self.y!r})"(!r 自动加引号并转义)
  • 错误:return f"Point({self.x}, {self.y})"(若 self.x 是字符串 "hello",输出变成 Point(hello),无法 eval)
  • 避免在 __repr__ 中访问数据库、网络或耗时属性 —— 它可能被日志、IDE 变量面板频繁调用

__str__ 可以省略,但别让它和 __repr__ 一模一样

很多初学者图省事,让 __str__ 直接 return self.__repr__()。这会让终端输出充满括号和引号,对终端用户不友好。真正需要的是语义化表达:

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

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

下载
  • 日期对象: __str__ 返回 "2024-06-15",__repr__ 返回 datetime.date(2024, 6, 15)
  • 异常对象:__str__ 是错误消息("division by zero"),__repr__ 包含类型和完整参数(ZeroDivisionError('division by zero'))
  • 如果对象没有自然的“用户视角”描述(比如底层工具类),可以不实现 __str__,让 Python 自动 fallback 到 __repr__

在容器里打印时,Python 默认调用 __repr__

这是最容易忽略的一点:当你把对象放进 list、dict 或 set 后打印,比如 print([obj1, obj2]),Python 对每个元素调用的是 __repr__,不是 __str__。所以即使你精心写了友好的 __str__,在列表里依然看到的是调试风格的输出。如果你希望容器显示也“好看”,只能手动处理(例如用列表推导式套 str()),或者接受这个事实 —— 容器的默认行为就是面向开发者的。

复杂点在于:某些框架(如 Pandas、Django ORM)会重载容器的显示逻辑,绕过原生规则。但纯 Python 的 list、dict、set 始终遵守这条规则。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1851

4

python能做什么
python能做什么

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

2023.07.25

4964

7

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

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

2023.07.31

1789

3

python教程
python教程

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

2023.08.03

29797

23

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

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

2023.08.04

3547

5

python eval
python eval

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

2023.08.04

3567

5

scratch和python区别
scratch和python区别

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

2023.08.11

1223

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2763

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习