在Python中处理XML时，很多配置或报文文件都带有大量注释用来说明字段含义。如果直接用常见解析方式读取，注释很容易被忽略甚至彻底丢弃，导致二次生成文件时说明信息丢失。借助合适的解析器与节点遍历方法，完全可以在读取、修改、写回的全过程中保留注释内容。
为什么普通解析会丢掉注释
Python标准库中，xml.etree.ElementTree 是最常被使用的XML解析模块，它设计目标是轻量、快速，因此只构建元素树，把注释、处理指令等辅助节点全部忽略。当你调用 ET.parse() 读取一个带注释的文件后，再 tree.write() 输出，原始注释就不会出现。
相比之下，xml.dom.minidom 这类基于W3C DOM规范的解析器，会把每个XML组成部分都映射为节点，注释对应 Node.COMMENT_NODE 类型。只要遍历时不主动跳过，就能拿到注释文本。理解这一点，是保留注释的前提。
使用minidom读取并保留注释
下面示例展示如何读取一个包含注释的XML，并逐个打印元素与注释。注意 nodeType 的判断方式，以及注释文本存放在 data 属性中。
from xml.dom import minidom
xml_text = '''<?xml version="1.0"?>
<root>
<!-- 这是用户配置 -->
<user id="1">
<!-- 姓名节点 -->
<name>张三</name>
</user>
</root>
'''
doc = minidom.parseString(xml_text)
def walk(node, depth=0):
for child in node.childNodes:
if child.nodeType == child.ELEMENT_NODE:
print(' ' * depth + '元素: ' + child.tagName)
walk(child, depth + 1)
elif child.nodeType == child.COMMENT_NODE:
print(' ' * depth + '注释: ' + child.data)
walk(doc.documentElement)
运行后可以看到，元素与注释都按层级输出。这种方式特别适合需要审计配置含义的场景，比如运维平台展示XML时附带原始说明。
如果只想提取所有注释，也可以直接收集 COMMENT_NODE 类型的节点，而不必递归整棵树。但在实际项目中，保留节点位置关系往往更重要，因此建议沿用上面的遍历结构。
修改XML并写回注释
minidom解析出的文档对象本身支持修改。我们可以在保留注释的同时新增元素，然后调用 toprettyxml() 写回。需要注意的是，该方法会在每行末尾产生多余空行，可通过简单后处理清除。
from xml.dom import minidom
xml_text = '''<root>
<!-- 旧注释 -->
<item>A</item>
</root>'''
doc = minidom.parseString(xml_text)
root = doc.documentElement
# 新增一个带注释的元素
comment = doc.createComment('新插入的注释')
root.appendChild(comment)
new_item = doc.createElement('item')
new_item.appendChild(doc.createTextNode('B'))
root.appendChild(new_item)
# 写回并清理空行
raw = doc.toprettyxml(indent=' ')
cleaned = 'n'.join(line for line in raw.splitlines() if line.strip())
print(cleaned)
上述代码在根节点后追加了注释与元素，输出文件中两者均存在。这样脚本既能自动化调整配置，又不破坏人工撰写的说明文字。
若使用 ElementTree 并希望保留注释，可借助第三方库如 lxml，其 etree 模块提供 parser 的 remove_comments=False 参数。不过在标准环境受限时，minidom仍是零依赖的稳妥方案。
两种方案对比
为方便选型，下面列出常见差异：
| 解析方式 | 是否默认保留注释 | 依赖情况 | 适用场景 |
|---|---|---|---|
| xml.etree.ElementTree | 否 | 标准库 | 纯数据抽取、无需注释 |
| xml.dom.minidom | 是 | 标准库 | 需保留结构及注释的读写 |
| lxml.etree | 可配置 | 第三方 | 高性能且需注释保留 |
从表中可以看出，如果项目不能引入外部包，minidom是唯一原生保留注释的选择。它的API稍显冗长，但节点模型清晰，便于精确控制输出内容。
实际编码时，建议封装一个通用的遍历函数，将注释与元素分别送入回调函数，业务层就能专注处理数据，而不必重复判断节点类型。
常见误区与注意点
有人尝试用正则表达式删除或提取注释，这在XML结构复杂时极易出错，比如注释里出现 -- 或嵌套标签片段。使用DOM解析才是符合规范的做法。
另外，minidom在 parse() 文件时若XML声明带编码，写回时需确认输出编码一致，否则中文注释可能乱码。可在 toprettyxml() 后以 encoding='utf-8' 参数显式指定，并用相同编码写入磁盘文件。