python类需实现__format__方法才能支持f-string等格式说明符,仅__str__和__repr__无效,因format()优先调用__format__;未实现时回退至object.__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,避免静默失败
示例:
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 的核心概念和高级技巧!











