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

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

梦雪君_2981

梦雪君_2981

发布时间:2026-08-16 10:27:07

|

609人浏览过

|

来源于php中文网

原创

__format__方法必须返回字符串,它只接受format_spec参数并严格要求返回str类型,否则触发TypeError;需解析format_spec字符串、避免print或修改状态,且不继承__str__或__repr__。

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

__format__ 方法必须返回字符串,不能返回其他类型

Python 的 __format__ 方法本质是为 format() 函数和 f-string 提供支持,它只接受一个 format_spec 参数,并**必须返回 str 类型**。如果返回 int、None 或抛出未捕获的异常,会直接触发 TypeError: non-string returned 或 ValueError。

常见错误是误把格式化逻辑写成「打印」或「修改自身」,比如在方法里调用 print() 或给 self 赋值——这些都不影响 format() 的结果,反而可能掩盖真正的问题。

  • __format__ 里不要 print / logging / 修改实例状态
  • 所有格式化逻辑应聚焦于解析 format_spec 并拼接/转换出最终字符串
  • 若不支持某类 format spec(如 'x'),建议显式 raise ValueError(f"Unknown format spec '{format_spec}'"),而不是静默 fallback

format_spec 参数是字符串,不是字典或对象

format_spec 是传入 format(obj, spec) 或 f"{obj:spec}" 中冒号后面的全部内容,类型恒为 str,哪怕看起来像数字或关键字。它不会自动解析成整数、布尔值或命名参数——全靠你自己拆解。

例如 f"{obj:05.2f}" 中的 "05.2f" 是一个纯字符串;f"{obj:hex}" 中的 "hex" 也是字符串,不是内置函数 hex 的引用。

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

提示词大师-python版
提示词大师-python版

图片提示词生成器?不止如此。 马甲系统 —— 把脑海中的画面,翻译成AI能理解的专业表达。 用得越多,它越懂你:首次需要多问几句确认方向,用久了几乎一说就懂。 用得越多,它越快:缓存机制让后续对话越来越省。 RAG进化:成功案例持续入库,越跑越聪明。 输入「新手指南」查看完整功能介绍

下载
  • 用 if format_spec == "short": 做简单匹配
  • 复杂 spec(如带小数点、宽度、填充符)可用正则或 str.split() 解析,但注意兼容标准格式语法(参考 PEP 3101)
  • 若想复用内置类型(如 float/int)的格式规则,可将数据转成对应类型再调 format(),例如 format(float(self.value), format_spec)

__format__ 不影响 str() 和 repr(),三者职责分明

__str__ 控制 str(obj) 和 print(obj);__repr__ 控制 repr(obj) 和交互式输出;而 __format__ 只响应 format() 和 f-string 的显式格式说明符。它们互不继承,也不能靠「没定义就 fallback 到 __str__」来省事——没实现 __format__ 就直接报 TypeError。

  • 即使 __str__ 返回 "User(id=42)",f"{user:s}" 仍会失败,除非你实现了 __format__ 并处理 's'
  • 常见做法:对空 format_spec(即 f"{obj}")返回 self.__str__();对特定 spec(如 'id')返回字段值
  • 别在 __format__ 里调 self.__repr__() 除非真需要调试格式,否则容易混淆语义

实际例子:支持 'id'、'name' 和空 spec 的 User 类

假设有个 User 类,希望支持 f"{u}"(默认)、f"{u:id}"、f"{u:name}":

class User:
    def __init__(self, id_, name):
        self.id = id_
        self.name = name

    def __str__(self):
        return f"User({self.id}, {self.name})"

    def __format__(self, format_spec):
        if not format_spec:
            return str(self)
        elif format_spec == "id":
            return str(self.id)
        elif format_spec == "name":
            return self.name
        else:
            raise ValueError(f"Unknown format spec '{format_spec}'")

这样 f"{User(123, 'alice')}" → "User(123, alice)",f"{User(123, 'alice'):name}" → "alice"。注意 format_spec 区分大小写,'NAME' 会报错。

真正容易被忽略的是:当你的类嵌套在容器中(如 f"{users[0]:id}"),或用于 logging 的 %(msg)s 格式化时,__format__ 是否覆盖了预期行为——这时候得检查调用链里是否真走到了你的实现,而不是被中间层拦截或 fallback 到 str()。

热门AI工具

更多
LibLibAI
LibLibAI Hot

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

DeepSeek

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

豆包大模型

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

WorkBuddy

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

相关专题

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

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

1611

2023.07.20

python能做什么
python能做什么

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

3944

2023.07.25

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

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

1629

2023.07.31

python教程
python教程

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

22637

2023.08.03

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

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

2787

2023.08.04

python eval
python eval

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

2827

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