如何在Python中通过__format__定制类对象的格式化字符串输出

阿静酱_1545

阿静酱_1545

2026-09-23

520人浏览

原创

__format__方法必须返回字符串而非print输出,其spec参数直接接收格式说明符(如"coord"、"polar"),需手动解析并返回对应格式化字符串,不支持的spec应抛valueerror。

如何在python中通过__format__定制类对象的格式化字符串输出

__format__ 方法必须返回字符串,不能只 print

很多人写 __format__ 时习惯在里面用 print() 输出,结果发现 f"{obj:s}"format(obj, "s") 依然显示默认的 <__main__.x object at></__main__.x>。这是因为 __format__ 的职责是**返回格式化后的字符串**,不是执行打印动作。

正确做法是拼接并 return 字符串:

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y
<pre class="brush:python;toolbar:false;">def __format__(self, spec):
    if spec == "coord":
        return f"({self.x}, {self.y})"
    elif spec == "polar":
        r = (self.x**2 + self.y**2)**0.5
        return f"r={r:.2f}"
    else:
        return str(self)  # fallback

调用验证:

pt = Point(3, 4)
f"{pt:coord}""(3, 4)"
format(pt, "polar")"r=5.00"

spec 参数就是 format 字符串中冒号后的部分

__format__ 的第二个参数 spec 直接来自格式说明符,比如 f"{obj:.2f}" 中的 ".2f"f"{obj:!s}" 中的 "!s"(注意:转换标志如 !s!r 不会传给 spec,它们在调用 __format__ 前就被处理掉了)。

  • 如果没写冒号,spec 是空字符串 ""
  • f"{obj:6d}"spec == "6d"
  • format(obj, ">10")spec == ">10"
  • 不支持的 spec 应该抛 ValueError,而不是静默忽略

常见误判:以为 spec 会自动解析成宽度/对齐/精度——它不会。你得自己解析,比如用正则或字符串方法拆解 "。

和 __str__ / __repr__ 的分工要清晰

__format__ 不是 __str__ 的替代品,而是补充。当格式说明符存在时(即用了冒号),Python 优先调用 __format__;否则才退回到 __str__(或 __repr__)。

所以别这样写:

A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.
A Python CLI skill for Cutout.Pro visual APIs — background removal, face cutout, and photo enhancement. Supports file upload & image URL input.

调用 Cutout.Pro 视觉处理 API 进行背景移除、人像抠图和照片增强,支持文件上传与图片 URL 输入。

下载
def __format__(self, spec):
    return f"Point({self.x}, {self.y})"  # 和 __str__ 完全一样 → 冗余

应该让 __format__ 处理“有上下文”的格式需求:

  • 单位("km""mi"
  • 坐标系("cartesian""latlon"
  • 导出格式("json""csv"
  • 缩写模式("short" vs "long"

__str__ 保持简洁可读,__repr__ 保持可调试、可重建。

嵌套格式化时,__format__ 里不要硬编码类型检查

如果你的对象字段本身支持格式化(比如 self.timestampdatetime),别手动转成字符串再拼接:

# ❌ 错误:丢失子对象的格式能力
return f"Time: {self.timestamp.isoformat()}"
<h1>✅ 正确:把 spec 透传下去(如果适用)</h1><p>return f"Time: {self.timestamp:{spec}}"  # 让 datetime 自己处理 ".3f" 等</p>

但要注意:不是所有 spec 都适用于子字段。安全做法是提取子字段关心的部分,例如:

if spec.endswith("z"):
  tz_spec = spec[:-1] or ""
  return f"{self.dt:{tz_spec}}Z"

直接把原始 spec 全传给子对象,容易触发 ValueError(比如把 "coord" 传给 int)。

真正麻烦的是多层嵌套 + 自定义 spec 解析逻辑,这时候建议用 string.Formatter 子类或提前归一化 spec,而不是在每个 __format__ 里重复写解析代码。

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

相关文章

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

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

下载

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3684

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

21137

23

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

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

2023.08.04

2607

5

python eval
python eval

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

2023.08.04

2667

5

scratch和python区别
scratch和python区别

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

2023.08.11

1083

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2063

5

热门下载

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

精品课程

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