Python lxml保存文件缩进 配置pretty_print格式化输出

1次阅读

lxml.etree.tostring() 默认不缩进,必须显式传入 pretty_print=true 且 encoding=’utf-8’;推荐用 tree.write() 直接保存带声明和缩进的文件,解析时启用 remove_blank_text=true 避免空白干扰。

Python lxml保存文件缩进 配置pretty_print格式化输出

lxml.etree.tostring() 不生效?检查是否漏传 pretty_print=True

直接调用 etree.tostring() 默认不缩进,哪怕你用了 etree.ElementTree.write() 也一样——缩进不是默认行为。必须显式开启 pretty_print=True,而且它只在 tostring()write() 中起作用,跟创建或解析过程无关。

常见错误是写了 etree.tostring(root) 就以为能缩进,结果输出一行密文。正确做法是:

xml_str = etree.tostring(root, encoding='utf-8', pretty_print=True)

注意两点:一是 pretty_print 必须为 True(不能是字符串或 1),二是 encoding 设为 'utf-8' 才能避免字节对象问题;如果后续要写入文件,推荐用 write() 而非手动 decode + open。

tree.write() 保存带缩进的文件,别手动 write() 字符串

很多人把 tostring(..., pretty_print=True) 的结果 decode 成 str,再用 open(...).write(),这容易出编码错、换行错,还绕过 lxml 内置的 XML 声明处理。

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

更稳妥的做法是直接用 ElementTree.write(),它原生支持 pretty_printxml_declaration

tree.write('output.xml', encoding='utf-8', xml_declaration=True, pretty_print=True)
  • xml_declaration=True 会自动加 <?xml version='1.0' encoding='utf-8'?>,否则没有
  • 路径 'output.xml' 必须是字符串,不能是 Path 对象(除非先转成 str)
  • 如果文件已存在,write() 会直接覆盖,不提示

缩进失效的隐藏原因:文本节点里有空白字符

即使开了 pretty_print=True,输出仍可能挤成一团——大概率是原始 XML 或你手动添加的 Element 里混入了换行、空格等空白文本。lxml 把这些视作有效内容,缩进逻辑会退化。

解决方法是在解析时就清理空白,或构建时避免插入多余文本:

  • 解析时加 remove_blank_text=Trueparser = etree.XMLParser(remove_blank_text=True)
  • 新建节点后,别写 elem.text = 'n ' 这类手动换行,让 pretty_print 全权控制
  • 已有脏数据可用 etree.strip_tags(root, etree.Comment) 或遍历清理 .text/.tail,但要小心误删业务需要的空白

python 3.12+ 与旧版 lxml 的兼容性提醒

较新版本 lxml(如 5.0+)对 pretty_print 的实现更严格,尤其在处理命名空间或自闭合标签时,可能和旧版输出略有差异。如果你的 CI 环境升级后缩进“变奇怪”,先确认 lxml 版本:

import lxml; print(lxml.__version__)

若需稳定行为,建议锁定版本(如 lxml>=4.9.0,),并避免混合使用 <code>minidomlxml 处理同一棵树——它们对空白的处理逻辑完全不同,混用极易导致缩进崩溃。

真正麻烦的从来不是开不开 pretty_print,而是你以为开了,其实被空白文本、编码方式或版本差异悄悄关掉了。

text=ZqhQzanResources