& (アンパサンド) 記号を含んだ xml 文字列をパースしたい

Question

発生している問題

表記の通り、例えば、<div>&</div> のような文字列を、
xml.dom.minidom.parseString() の機能をつかってパースしたいのですが、
xml.parsers.expat.ExpatError となってしまいます。

該当のソースコード

import xml.etree.ElementTree as ET
import xml.dom.minidom as md

xmlRoot = ET.Element('root')
# ElementTreeでXMLを作成

# 文字列パースを介してminidomへ移す
document = md.parseString('<div>&</div>')

file = open('test.xml', 'w')
# エンコーディング、改行、全体のインデント、子要素の追加インデントを設定しつつファイルへ書き出し
document.writexml(file, encoding='utf-8', newl='\n', indent='', addindent='  ')
file.close()

やってみたこと

& (アンパサンド) をとりのぞいて .parseString() したところ、エラー無く終了したので、
& になにかしらのエスケープが必要なのではと考えているのですが、どのようにエスケープしたら良いでしょうか？
また、& 以外にもエスケープが必要な文字は存在するでしょうか？

そもそも xml.dom.minidom.parseString() ではなく、ほかの機能を使うべきだったり、他の言語を使用するべきなど、意見ありましたら、ご指摘お願いします。

Comments

[quickquip]

質問の意図が100%分からなくて
「絶対にXMLではありえない文字列をXML Parserで処理したい」
「XMLの規格に従おうとはまったく思ってないけれどXML Parserは使いたい」
というような質問に読めてしまうのですが……
（直截の回答はすでに付いている通りと思います）

Answer 1

Perplexityの回答

エスケープの必要性

XML では、特定の文字をエスケープする必要があります。これは、XML パーサーがそれらの文字を特別な意味を持つマークアップとして解釈してしまうためです。エスケープが必要な主な文字は以下の通りです:

• & (アンパサンド): & でエスケープ
• < (小なり記号): < でエスケープ
• > (大なり記号): > でエスケープ
• " (二重引用符): " でエスケープ
• ' (一重引用符): ' でエスケープ

解決策

あなたのコードでは、& をエスケープする必要があります。以下のように修正してください:

import xml.etree.ElementTree as ET
import xml.dom.minidom as md

xmlRoot = ET.Element('root')
# ElementTreeでXMLを作成

# 文字列パースを介してminidomへ移す
document = md.parseString('<div>&amp;</div>')

file = open('test.xml', 'w')
# エンコーディング、改行、全体のインデント、子要素の追加インデントを設定しつつファイルへ書き出し
document.writexml(file, encoding='utf-8', newl='\n', indent='', addindent='  ')
file.close()

この修正により、& がエスケープされ、xml.dom.minidom.parseString() が正常に動作するはずです。

代替手段

xml.dom.minidom は古いモジュールで、より新しい xml.etree.ElementTree の方が推奨されています。ElementTree を使えば、エスケープの必要はありません。以下のようにコードを書き換えることができます:

import xml.etree.ElementTree as ET

root = ET.Element('root')
div = ET.SubElement(root, 'div')
div.text = '&'

tree = ET.ElementTree(root)
tree.write('test.xml', encoding='utf-8', xml_declaration=True)

この方法では、& をエスケープする必要がなく、より簡潔なコードになります。

Comments

[IkazoIchikawa]

回答ありがとうございます。
ですが、最終的には、` ` もパースできるようにしたいのですが、これを指定するとパースエラーになってしまいます。(`xml.etree.ElementTree` も同様)
node.js で実現できないかと思い調査しましたが、xmldom ライブラリで xml はパースできるようなのですが、やはりこちらも` ` のパースでエラーになってしまいます。
うまい解決方法はないものでしょうか、、

Answer 2

& になにかしらのエスケープが必要なのではと考えているのですが、どのようにエスケープしたら良いでしょうか？

&としてください。

また、& 以外にもエスケープが必要な文字は存在するでしょうか？

<や>もタグ以外で使うには<や>のように書く必要がありますし、属性値に一重あるいは二重引用符を入れる場合は、（囲む引用符を変更することで回避する手段を取るという選択肢を別とすれば）'あるいは"と書くことになります。