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

Python魔法方法有哪些___str__与__repr__字符串表现形式

小磊君_1472

小磊君_1472

发布时间:2026-04-02 12:59:19

|

356人浏览过

|

来源于php中文网

原创

__repr__ 必须始终实现,用于调试、日志和交互式环境,应返回含类名和关键字段的可辨识字符串;__str__ 可选,仅用于面向用户的友好显示,缺失时自动回退到 __repr__。

python魔法方法有哪些___str__与__repr__字符串表现形式

什么时候该用 __str__,什么时候必须写 __repr__

用户看到对象打印出来是 <__main__.Point object at 0x7f8a1c2b3d90>,第一反应往往是“加个 __str__ 就行了”——但这是错的起点。__repr__ 才是 Python 对象的“身份证”,__str__ 只是给终端用户看的“友好昵称”。

调试时你用 print(obj) 或直接敲变量名回车,背后调用的是不同方法:print() 走 __str__(如果存在),而交互式环境里直接输入变量名、logging.debug()、repr() 函数都强制走 __repr__。

  • __repr__ 应该返回「可复现」或「有辨识度」的字符串,理想情况下能用 eval(repr(obj)) 重建对象(不强求,但至少含类名+关键字段,比如 Point(x=1, y=2))
  • __str__ 可以更宽松:带单位、换行、中文描述都行,比如 "坐标点 (1, 2)",但它一旦缺失,Python 会自动 fallback 到 __repr__ 的结果
  • 如果你只写 __str__ 不写 __repr__,日志里全是地址,pdb 里看不出状态,单元测试失败时断言报错也难读

__repr__ 返回空字符串或 None 会怎样

这会导致 repr(obj) 报 TypeError: __repr__ returned non-string (type NoneType),连 print(repr(obj)) 都崩。Python 明确要求 __repr__ 必须返回 str,且不能是空串(空串合法,但毫无意义)。

  • 常见错误:写了 print(...) 却忘了 return,结果隐式返回 None
  • 另一个坑:在 __repr__ 里调用了可能抛异常的属性(比如未初始化的 self._data),导致 repr() 调用直接中断,连对象都 print 不出来
  • 安全写法:用 getattr(self, 'x', '?') 替代直接访问,或用 try/except 包裹关键字段读取

自定义类中 __str__ 和 __repr__ 的典型写法差异

差异不在语法,而在信息密度和用途。拿一个简单二维点类举例:

Galileo python sdk
Galileo python sdk

Galileo AI 平台 Python SDK 完整参考,用于评估、监控和保护 GenAI 应用,适用于构建 Python 应用。

下载

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

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
<pre class='brush:python;toolbar:false;'>def __repr__(self):
    return f"Point(x={self.x!r}, y={self.y!r})"  # !r 确保字符串带引号,数字不变形

def __str__(self):
    return f"({self.x}, {self.y})"</pre>

注意三点:

  • __repr__ 用 !r 格式化,让 "hello" 变成 'hello',避免歧义;__str__ 直接用 {self.x} 更干净
  • __repr__ 包含类名,__str__ 不需要——用户已经知道这是个点
  • 如果字段可能为 None 或复杂对象(如嵌套 dict),__repr__ 里建议用 repr(field) 而非 str(field),保持层级一致性

第三方库和内置类型怎么处理这两个方法

像 datetime、pathlib.Path 这类标准库类型,__repr__ 和 __str__ 差异明显:datetime(2023, 1, 1) vs "2023-01-01";而 numpy.ndarray 的 __str__ 会省略长数组中间部分,__repr__ 则带 dtype 和 shape 信息。

  • 第三方库(如 pydantic、dataclasses)通常默认只实现 __repr__,靠生成逻辑保证可读性;__str__ 得你自己补
  • 继承内置类型(如 list 子类)时,如果不重写 __repr__,会沿用父类行为(比如显示所有元素),可能泄露敏感数据或拖慢调试
  • 用 dataclass 时加 repr=True(默认)只控制 __repr__,__str__ 依然不存在——别以为加了 @dataclass 就万事大吉

最常被忽略的一点:当对象嵌套很深(比如 A 里有 B,B 里有 C),只要其中任意一层没写 __repr__,整条链路的调试输出就退化成内存地址。这不是性能问题,是信息黑洞。

热门AI工具

更多
豆包大模型

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

WorkBuddy

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

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Seko
Seko Hot

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

相关专题

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

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

1711

2023.07.20

python能做什么
python能做什么

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

4304

2023.07.25

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

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

1689

2023.07.31

python教程
python教程

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

25097

2023.08.03

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

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

3067

2023.08.04

python eval
python eval

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

3087

2023.08.04

scratch和python区别
scratch和python区别

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

1163

2023.08.11

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

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

596

2023.08.10

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

20

2026.10.10

热门下载

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

精品课程

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

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