如何使用 Python 元素樹生成帶有 BOM 的 XML、UTF-8？

Question

要為 ASP.NET 生成資源 XML 文件，第三方工具需要 BOM（遷移到工具的新版本時）。 同時需要XML prolog like <?xml version='1.0' encoding='utf-8'?> 。

問題是當使用 ElementTree 命令時...

tree.write(lang_resx_fpath, encoding='utf-8')

生成的文件不包含 BOM。 使用命令時...

tree.write(lang_resx_fpath, encoding='utf-8-sig')

結果確實包含 BOM； 但是， XML prolog 包含encoding='utf-8-sig' 。

我應該如何生成包含 BOM 和encoding='utf-8'文件？

更新：

我已經通過再次讀取、替換和寫入文件來解決它，就像這樣......

with open(lang_resx_fpath, 'r', encoding='utf-8-sig') as f:
    content = f.read()

content = content.replace("encoding='utf-8-sig'", "encoding='utf-8'")

with open(lang_resx_fpath, 'w', encoding='utf-8-sig') as f:
    f.write(content)

無論如何，有沒有更清潔的解決方案？

Answer 1

窺視 ElementTree.write 的來源表明 prolog 在那里被硬編碼（ https://github.com/python/cpython/blob/main/Lib/xml/etree/ElementTree.py或永久鏈接Z5E056C500A1C508/07BADE5Z11 /cpython/blob/ee0ac328d38a86f7907598c94cb88a97635b32f8/Lib/xml/etree/ElementTree.py ）。 因此，可能使用 ET 的內部是唯一的選擇（除了猴子路徑模塊），編寫所需的序言並將 BOM 保存在文件中：

import xml.etree.ElementTree as ET
qnames, namespaces = ET._namespaces(tree._root, None)
with open(lang_resx_fpath,'w',encoding='utf-8-sig') as f:
    f.write("<?xml version='1.0' encoding='utf-8'?>\n"     )
    ET._serialize_xml(f.write,
                        tree._root, qnames, namespaces,
                       short_empty_elements=False)

可能它並不比您的解決方案更優雅（甚至可能更不優雅）。 唯一的好處是它不需要兩次寫入文件，除了一些巨大的 XML 文件之外，這將是次要的好處。