如何在Python中处理多行字符串以保持代码缩进整齐?

老磊姑娘_9831

老磊姑娘_9831

2026-06-14

214人浏览

原创

Python三引号字符串保留缩进空格,易致SQL/JSON错误;应使用textwrap.dedent()剔除公共前缀空格,或inspect.cleandoc()处理docstring,注意避免空格与Tab混用。

如何在python中处理多行字符串以保持代码缩进整齐?

用三引号字符串时缩进空格会原样保留

Python 的 '''""" 多行字符串会把换行和所有空白字符(包括缩进空格)一并存进去,这在函数体或类方法里写文档字符串或 SQL 模板时特别容易导致意外的前导空格。

常见错误现象:print(repr(sql)) 显示字符串开头有多个空格,导致 SQL 执行失败或 JSON 解析报 JSONDecodeError: Expecting value

  • 如果缩进用的是 4 个空格,每行开头都会多出 4 个空格
  • 用 Tab 缩进更危险:不同编辑器对 Tab 宽度解释不一致,repr() 可能显示 '\t' 或等宽空格
  • 不能靠手动删缩进——那样会破坏代码可读性,也不符合 PEP 8

textwrap.dedent() 剔除公共前缀空格

textwrap.dedent() 会分析所有非空行,找出最小的公共前导空白(只统计空格和 Tab),然后统一删掉。它不碰行首空行、也不动中间或末尾的空格。

使用场景:定义多行配置、SQL 查询、带缩进的模板字符串。

import textwrap
<p>def build_query(user_id):
sql = textwrap.dedent("""\
SELECT name, email
FROM users
WHERE id = %s
ORDER BY created_at DESC
""").strip()
return sql % user_id
</p>
  • 必须加 \ 在第一行末尾,否则第一行换行符会变成字符串开头的空行
  • 结尾调用 .strip() 是为了去掉末尾换行和可能的空格(dedent 不处理尾部)
  • 注意:如果某行缩进比其他行少(比如只有 2 个空格),它会成为“公共前缀”的上限,其他行只删这么多

inspect.cleandoc() 更适合文档字符串

inspect.cleandoc() 是专为 docstring 设计的,行为类似 dedent(),但额外处理了首行缩进逻辑:它会忽略第一行的缩进(哪怕第一行是空行),从第二行开始计算公共前缀。

适用场景:函数/类的 __doc__、需要保持语义清晰的说明文本。

python全能编程助手
python全能编程助手

SkillSub Pro - Python 题解与代码注释双功能技能功能概述SkillSub Pro - Python 题解与代码注释双功能技能是一项面向实际任务的技能,主要用于SkillSub Pro 是一个 Python 题解生成与代码注释的 双功能合体技能 ,专为学生、算法学习者和开发者设计;✅ 一个技能,两种用途 :;核心要点📝 题解模式 :输入题目/题号,自动生成完整 Python 题解(含详细注释、解题思路、复杂度分析);💬 注释模式 :输入 Python 代码,自动添加详细中。它将相关步骤、

下载
import inspect
<p>def format_help():
"""格式化帮助文本。</p><pre class="brush:php;toolbar:false;">支持以下选项:
  --verbose   输出详细日志
  --dry-run   不执行实际操作
"""
return inspect.cleandoc(format_help.__doc__)

  • 不用手动加 \,对 docstring 更友好
  • 如果 docstring 首行有内容且缩进不一致(比如首行顶格、其余行缩进),cleandoc 仍能合理处理
  • 不适用于需要精确控制首行缩进的场景(如生成带缩进的 YAML 片段)

用 f-string + dedent 拼接动态内容要小心换行位置

f-string 本身不支持跨行直接嵌入多行字符串,强行换行会触发语法错误。必须把 f"..." 写在单行内,再用 dedent 处理内部值。

容易踩的坑:在 f-string 中直接换行、或把变量插在 dedent 调用之外。

  • ❌ 错误写法:f"""SELECT * FROM {table}\nWHERE id > {min_id}""" —— 换行符和缩进全被保留
  • ✅ 正确写法:先构造干净字符串,再用 f-string 插值,或把插值放在 dedent 之后:textwrap.dedent(f"SELECT * FROM {table} ...")
  • 性能影响:dedent 是纯 Python 实现,对超长字符串(>10KB)会有轻微开销,但日常使用无感

真正麻烦的是混合了缩进风格的字符串(比如空格 + Tab 混用),dedentcleandoc 都会失效——它们按字符逐个比对前缀,Tab 和空格不等价。这种情况下,要么统一缩进风格,要么手动用正则清理。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1531

4

python能做什么
python能做什么

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

2023.07.25

3584

7

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

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

2023.07.31

1549

3

python教程
python教程

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

2023.08.03

20477

23

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

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

2023.08.04

2547

5

python eval
python eval

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

2023.08.04

2587

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2003

5

热门下载

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

精品课程

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