如何通过Python的__format__自定义对象在格式化字符串中的表现?

P粉602998670

P粉602998670

2026-08-02

923人浏览

原创

__format__ 仅在显式格式化(如 f-string、str.format() 或 format() 函数)时触发,不用于 str(obj) 或 print(obj);其 format_spec 参数为冒号后字符串,需手动解析并处理空格、大小写及非法码,且应明确职责——补充而非替代 __str__ 和 __repr__。

如何通过python的__format__自定义对象在格式化字符串中的表现?

为什么 __format__ 没生效?先检查是否用了 f-string 或 str.format()

直接调用 str(obj)print(obj) 不会触发 __format__,它只在显式格式化时才被调用。常见误判是以为打印对象就走这个方法。

  • f-string 中写 f"{obj:s}"f"{obj:.2f}" 会调用 __format__(self, format_spec)
  • "{}".format(obj) 同样触发,但 "{}".format(obj) 等价于 __format__(obj, "")
  • format(obj, "x") 是最干净的测试方式,绕过字符串解析逻辑

__format__format_spec 参数到底怎么用?

这个字符串就是你写在冒号后面的那部分,比如 f"{obj:08x}" 中的 "08x"。Python 不做预解析,全由你决定怎么解释它——可以支持自定义语法,也可以只兼容内置类型的部分规则。

Python 3.14.2
Python 3.14.2

Python 3.14.2是Python编程语言在2025年12月5日发布的稳定版本,属于3.14系列的第二个维护更新。该版本包含了18项修复,重点解决了多进程、数据类及正则表达式等模块的回归问题,并修复了CVE-2025-12084等安全漏洞。此版本标志着自由线程模式(移除GIL)正式获得官方支持,是Python发展的重要里程碑。

下载
  • 空字符串 "" 表示默认格式,常对应 str(self) 或可读表示
  • 若想兼容数字类型行为(如 "f"".2e"),需手动解析 format_spec,推荐用 string.Formatter().parse() 或正则提取宽度/精度/对齐
  • 不识别的格式码建议抛 ValueError,而不是静默忽略,否则调试时难定位问题
  • 示例:如果对象有 value 属性,__format__(self, spec) = f"{self.value:{spec}}" 可透传给内置格式化(仅限数值)

__str____repr__ 的分工容易混淆

__format__ 不是 __str__ 的替代品,而是补充。三者职责不同:__str__ 是给人看的简明字符串,__repr__ 是给开发者看的无歧义表示,__format__ 是“按需定制显示样式”的入口。

  • 不要在 __format__ 里返回 repr(self),除非明确需要调试格式(如 f"{obj:!r}" 这种场景极少)
  • 如果对象本质是数值(如带单位的温度类),__format__ 应优先支持数字格式码;如果是结构体(如 Point(x=1, y=2)),更适合支持 "xy""json" 这类自定义码
  • 避免在 __format__ 中做昂贵计算(如序列化整个嵌套结构),格式化应尽量轻量

真实项目中踩过的坑:格式码大小写、空格、缩进处理

用户输入的 format_spec 可能带空格或大小写混用(如 " 04X "),Python 标准库对数字格式码宽松,但自定义逻辑必须自己清理。

  • format_spec.strip() 是底线操作,否则 " f""f" 被视为不同码
  • 大小写敏感性要明确:比如 "hex""HEX" 是否等价,取决于你的设计,但文档里得写清楚
  • 不要假设 format_spec 一定是字母+符号组合,用户可能传入 "[compact]"'{"indent":2}' 这类结构化字符串
  • 测试时务必覆盖边界情况:f"{obj:}"(空)、f"{obj: }"(纯空格)、f"{obj:!@#}"(非法码)
实际写的时候,最麻烦的不是实现逻辑,而是决定哪些格式码对外暴露、哪些内部保留,以及错误提示够不够具体——用户看到 ValueError: unknown format code 'z' for object of type 'Money'unsupported format string passed to Money.__format__ 容易 debug 多了。

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

相关专题

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

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

2023.07.20

1105

4

python能做什么
python能做什么

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

2023.07.25

2072

7

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

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

2023.07.31

1185

3

python教程
python教程

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

2023.08.03

8844

23

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

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

2023.08.04

1479

5

python eval
python eval

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

2023.08.04

1552

5

scratch和python区别
scratch和python区别

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

2023.08.11

881

5

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

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

2023.08.10

531

4

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

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

2023.08.11

1111

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PyCharm官方快速入门指南
PyCharm官方快速入门指南

共0课时 | 0人学习

Python函数定义官方教程
Python函数定义官方教程

共0课时 | 0人学习

Python 3.14.6官方文档
Python 3.14.6官方文档

共0课时 | 0人学习