如何让Python类支持格式化输出_重写__format__自定义语法

大宇同学_3841

大宇同学_3841

2026-05-19

423人浏览

原创

python类需实现__format__方法才能支持f-string等格式说明符,仅__str__和__repr__无效,因format()优先调用__format__;未实现时回退至object.__format__,仅接受空格式串,否则报错。

如何让python类支持格式化输出_重写__format__自定义语法

Python 类默认不支持 str.format() 或 f-string 中的格式说明符(比如 {obj:.2f} 或 {obj!r}),除非你显式实现 __format__ 方法。只靠 __str__ 或 __repr__ 是不够的。

为什么 __str__ 和 __repr__ 不管用?

它们只控制 str(obj) 和 repr(obj) 的行为,而 format(obj, spec)(或 f"{obj:spec}")会优先调用 obj.__format__(spec)。如果没定义,就回退到 object.__format__,它只接受空格式串,否则报 ValueError: Unknown format code 'x' for object of type 'str' 这类错误。

常见报错示例:

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
<p>p = Point(3.14159, 2.71828)
f"{p:.2f}"  # TypeError: unsupported format string passed to Point.<strong>format</strong></p>

怎么写一个基础但可用的 __format__?

签名必须是 def __format__(self, format_spec: str) -> str:,且不能忽略 format_spec 参数(哪怕你暂时不用)。最简安全写法是把格式串当“风格名”处理:

  • 空字符串 "" → 返回 __str__ 结果(兼容默认行为)
  • "r" 或 "repr" → 返回 __repr__
  • "xy" → 自定义字段顺序,如 "(x=3.14, y=2.72)"
  • 其他非法格式串可抛 ValueError,避免静默失败

示例:

361SCAN security check your skill python scripts
361SCAN security check your skill python scripts

扫描并分析已安装技能,用于查看指定技能目录的名称、描述和详情,或列出所有已安装的技能。

下载
class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
<pre class="brush:python;toolbar:false;">def __str__(self):
    return f"({self.x:.2f}, {self.y:.2f})"

def __repr__(self):
    return f"Point({self.x!r}, {self.y!r})"

def __format__(self, format_spec):
    if not format_spec:
        return str(self)
    elif format_spec == "r":
        return repr(self)
    elif format_spec == "xy":
        return f"(x={self.x:.2f}, y={self.y:.2f})"
    else:
        raise ValueError(f"Unknown format spec '{format_spec}' for {type(self).__name__}")

这样就能用:f"{p}"、f"{p:r}"、f"{p:xy}" 都正常工作。

想支持数字格式化语法(如 .2f)怎么办?

这需要你手动解析 format_spec 字符串——Python 没有内置工具帮你拆解,但标准库的 string 模块里有个隐含的 _string.formatter_field_name_split 不建议用,更稳妥的是复用内置类型的格式化逻辑:

  • 若你的类本质是数值包装(如 Money、Angle),可委托给 float(self).__format__(format_spec)
  • 若含多个数值字段(如 Point),可对每个字段分别调用 self.x.__format__(format_spec),但要注意:不是所有类型都支持同一格式串(int 不认 .2f)
  • 推荐做法:只允许你明确支持的格式子集,例如限定为 g、f、e 及精度前缀,并用正则粗筛:re.match(r'^\d*(?:\.\d+)?[gfe]$', format_spec)

关键点:别试图完全兼容 Python 全部格式语法,按需实现,否则容易漏边界 case(比如带千位分隔符 , 或对齐符号 )。

容易被忽略的兼容性细节

__format__ 方法在 str.format()、f-string、format() 函数中都会触发,但它和 __bytes__、__index__ 等一样,不会自动参与类型转换。特别注意:

  • 继承自内置类型(如 float 子类)时,若未重写 __format__,会沿用父类逻辑,可能绕过你的自定义逻辑
  • 使用 !s / !r 转换器(如 f"{obj!r:10}")时,!r 先调 repr() 得字符串,再对字符串调 __format__ —— 此时 format_spec 是作用在字符串上,不是你的对象上
  • 某些第三方库(如 dataclasses 自动生成的 __repr__)可能干扰你的格式设计,建议显式定义 __repr__ 避免意外

真正麻烦的从来不是写 __format__,而是决定哪些格式语义对你这个类有意义,以及如何让使用者一眼看懂 :hex 和 :short 到底差在哪。

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

相关专题

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

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

2023.07.20

1771

4

python能做什么
python能做什么

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

2023.07.25

4584

7

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

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

2023.07.31

1729

3

python教程
python教程

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

2023.08.03

27017

23

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

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

2023.08.04

3267

5

python eval
python eval

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

2023.08.04

3287

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

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

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

2023.08.11

2543

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习