如何使用Python在XML声明后向XML文件追加注释？

xml.etree.ElementTree 内置了Comment方法用于创建XML注释，你之前操作没生效的核心原因是注释节点被挂在了根节点内部，要让注释出现在XML声明和根节点之间，有两种常用实现方式：

方法1：标准节点操作（推荐，Python 3.4+支持） #

通过节点的addprevious方法把注释插入为根节点的前置同级节点，属于标准XML节点操作，不会破坏文档结构：

from xml.etree.ElementTree import Element, ElementTree, Comment

# 创建根节点
root = Element("root")
# 创建目标注释节点
comment_node = Comment(" My comments ")
# 初始化文档树对象
tree = ElementTree(root)
# 将注释插入到根节点之前的顶层位置
tree.getroot().addprevious(comment_node)

# 写入XML文件，自动生成标准XML声明
with open("output.xml", "wb") as f:
    tree.write(f, encoding="utf-8", xml_declaration=True)

如果你使用Python 3.9及以上版本，想要更规整的换行缩进格式，可以在写入文件前加入缩进处理逻辑：

from xml.etree.ElementTree import indent
# 自动给文档添加标准缩进换行
indent(tree)

方法2：字符串拼接（全版本兼容） #

如果你的Python版本较低不支持节点插入操作，可以直接对生成的XML字符串做处理，逻辑简单兼容性强：

from xml.etree.ElementTree import Element, tostring

root = Element("root")
xml_content = tostring(root, encoding="utf-8", method="xml")
xml_declaration = b'<?xml version="1.0" encoding="utf-8"?>\n'
comment_block = b'<!-- My comments -->\n'
# 拼接声明、注释、根节点内容
final_content = xml_declaration + comment_block + xml_content.lstrip(xml_declaration)

with open("output.xml", "wb") as f:
    f.write(final_content)

两种方法执行后，生成的XML文件内容都完全符合预期：

<?xml version='1.0' encoding='utf-8'?>
<!-- My comments -->
<root>
</root>

内容的提问来源于stack exchange，提问作者user19263504