如何在Python中使用__format__自定义类实例输出格式

梦辰君_6902

梦辰君_6902

2026-10-13

378人浏览

原创

该用__format__当需支持format()或f-string的格式说明符(如f"{obj:.2f}"),而非替代__str__;它专用于解析format_spec实现多格式变体,与__str__、__repr__职责分离且互不影响。

如何在python中使用__format__自定义类实例输出格式

什么时候该用 __format__ 而不是 __str__ 或 __repr__

__format__ 是为 format() 函数和 f-string 中的格式说明符服务的,不是用来替代 __str__ 的通用显示逻辑。比如你写 f"{obj:.2f}" 或 format(obj, ".2f") 时,Python 才会调用 __format__;而 print(obj) 或 str(obj) 仍走 __str__。如果你的类需要支持多种格式变体(如货币、百分比、科学计数),__format__ 就是唯一正解。

常见错误是把所有格式逻辑塞进 __str__,结果发现 f"{x:%}" 报 ValueError: Unknown format code '%' for object of type 'str' —— 因为 __str__ 返回字符串后,格式化就结束了,Python 不会再解析里面的说明符。

__format__ 的参数 format_spec 怎么解析

format_spec 是传入的格式字符串,比如 f"{obj:#x}" 里就是 "#x",它不带花括号,也不含变量名。你需要自己按规则解析它,Python 不提供内置解析器。

  • 空字符串 "" 表示默认格式,常对应 __str__ 行为,但也可自定义(如返回简写)
  • 常见前缀如 "!"(转换标志)、":"(分隔符)不会出现在 format_spec 中 —— 它们是 f-string 语法的一部分,到 __format__ 时只剩冒号后的部分
  • 建议用 str.partition(":") 或正则提取关键字段,别硬写 if format_spec == "hex" 这种死匹配,实际中用户可能写 "0x"、"#x"、"x"

示例:一个表示角度的类支持 "d"(度)、"rad"(弧度)、"deg"(同 d):

python-parallelization
python-parallelization

将顺序 Python 代码转换为并行/并发实现,用于在需要并行化 Python 代码、提升性能时使用。

下载
def __format__(self, format_spec):
    if format_spec in ("", "d", "deg"):
        return f"{self.degrees:.1f}°"
    elif format_spec == "rad":
        return f"{self.radians:.3f} rad"
    else:
        raise ValueError(f"Unknown format spec {format_spec!r}")

和内置类型格式说明符对齐的坑

用户习惯写 f"{x:.2f}",如果你的类也想支持小数位控制,就得手动解析 format_spec 里的精度部分。Python 不会帮你拆 ".2f" —— 你得用 string.Formatter.parse 或正则(推荐 re.match(r"^\.(\d+)([eEfFgG])?$", format_spec))。

  • 忽略精度会导致 f"{obj:.2f}" 输出全精度数字,违背直觉
  • 误把 "s" 当作字符串格式(像 str.format 那样)—— 实际上 "s" 是给字符串类型的,你的类若非 str 子类,__format__ 不会自动处理它;必须显式支持,否则抛 ValueError
  • 如果返回值不是字符串,会直接报 TypeError: __format__ must return a string

性能提示:频繁调用 __format__(如日志循环)时,避免在函数内重复编译正则或构造 Formatter 实例,应提前缓存。

和 __str__ / __repr__ 的协作关系

__format__ 不继承 __str__,也不影响 __repr__。三者完全独立。典型协作模式是:

  • __str__ 返回最常用、可读性最强的默认文本(如 "Point(3.5, -2.1)")
  • __repr__ 返回无歧义、可调试的表示(如 "Point(x=3.5, y=-2.1)")
  • __format__ 专注响应外部格式请求(如 "{:.1f}" 输出坐标值,"csv" 输出逗号分隔)

容易被忽略的一点:当 format_spec 为空时,很多开发者直接返回 str(self),但这会丢失语义 —— 比如你希望空格式输出 ID 而不是完整对象描述,那就该单独处理 if not format_spec: 分支,而不是无脑委托。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1731

4

python能做什么
python能做什么

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

2023.07.25

4364

7

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

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

2023.07.31

1689

3

python教程
python教程

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

2023.08.03

25557

23

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

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

2023.08.04

3107

5

python eval
python eval

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

2023.08.04

3127

5

scratch和python区别
scratch和python区别

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

2023.08.11

1183

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2423

5

热门下载

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

精品课程

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