讲师中心 微信公众号
AI工具推荐 视频效率加速

如何利用Python的__format__方法自定义类实例的字符串格式化?

浅杰酱_8221

浅杰酱_8221

发布时间:2026-08-15 08:33:24

|

156人浏览过

|

来源于php中文网

原创

__format__ 方法必须返回字符串,不能返回 None;它接收原始 format_spec 字符串,需手动解析并处理所有分支,空 format_spec 时建议返回 str(self)。

如何利用python的__format__方法自定义类实例的字符串格式化?

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

Python 的 __format__ 方法被 format() 函数和 f-string 调用时,**必须显式返回一个 str 类型值**。如果忘记 return 或返回了 None,会直接抛出 TypeError: non-empty format string passed to object.__format__(即使格式化字符串为空也会触发)。

  • 常见错误:在方法里只做 print 或 logging,没写 return
  • 正确做法:所有分支都返回 str,包括处理未知 format_spec 的兜底逻辑
  • 示例错误写法:
    def __format__(self, format_spec):
        print(f"Formatting with {format_spec}")
        # 缺少 return → TypeError
  • 推荐兜底:用 return str(self) 或 return self.__str__()

format_spec 参数是纯字符串,不自动解析成数字或布尔值

__format__ 接收的 format_spec 是原始字符串,比如 f"{obj:.2f}" 传进来的是 ".2f",f"{obj!s:upper}" 传进来的是 "upper" —— 它不会帮你转成 float 或调用 .upper(),全得自己拆解和判断。

  • 不要假设 format_spec 是某种类型;用 if format_spec == "hex" 或正则匹配(如 re.match(r'^\.(\d+)f$', format_spec))来解析
  • 支持标准格式码(如 d, x, e)需手动实现,Python 不会代理给 int() 或 float()
  • 建议提前约定好自定义格式码(如 "short", "debug"),避免和内置格式冲突

与 __str__ 和 __repr__ 的协作关系要理清

__format__ 不替代 __str__ 或 __repr__,而是补充它们:当显式使用格式化(如 format(obj, spec) 或 f"{obj:spec}")时才触发;否则仍走 __str__(print)或 __repr__(交互式显示)。

Python Use Agent
Python Use Agent

智能执行Python任务,自动生成、执行代码并反馈结果,无需额外配置,兼容旧命令。

下载
  • 不要在 __format__ 里重复实现 __str__ 逻辑,除非 format_spec 为空字符串(f"{obj:}")——此时可返回 str(self)
  • 如果希望空 format_spec 行为等同于 __str__,明确写 if not format_spec: return str(self)
  • 调试时可用 print(repr(format_spec)) 看实际传入值,避免因空格或不可见字符误判

在 f-string 中触发 __format__ 需带格式说明符

f-string 只有在花括号内写了冒号(:)才会调用 __format__。写 f"{obj}" 走的是 __str__,而 f"{obj:}"、f"{obj:!s}"、f"{obj:json}" 才会进 __format__。

立即学习“Python免费学习笔记(深入)”;

  • f"{obj:}" 传入空字符串 "" 给 format_spec
  • f"{obj:!s}" 先调用 __str__ 再格式化,不进 __format__
  • f"{obj:debug}" 才真正把 "debug" 传给 __format__
  • 测试时别漏掉冒号 —— 这是最常见的“写了 __format__ 却没生效”的原因

注意:format_spec 解析没有统一标准库工具,不同项目往往各自实现一套简化解析逻辑;越早定义清晰的格式码语义,后期维护成本越低。

热门AI工具

更多
PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

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

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

1631

2023.07.20

python能做什么
python能做什么

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

3964

2023.07.25

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

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

1629

2023.07.31

python教程
python教程

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

22797

2023.08.03

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

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

2807

2023.08.04

python eval
python eval

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

2847

2023.08.04

scratch和python区别
scratch和python区别

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

1123

2023.08.11

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

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

596

2023.08.10

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

0

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn