6.5 將字典轉(zhuǎn)換為XML

問題

你想使用一個Python字典存儲數(shù)據(jù)，并將它轉(zhuǎn)換成XML格式。

解決方案

盡管 xml.etree.ElementTree 庫通常用來做解析工作，其實它也可以創(chuàng)建XML文檔。例如，考慮如下這個函數(shù)：

from xml.etree.ElementTree import Element

def dict_to_xml(tag, d):
'''
Turn a simple dict of key/value pairs into XML
'''
elem = Element(tag)
for key, val in d.items():
    child = Element(key)
    child.text = str(val)
    elem.append(child)
return elem

下面是一個使用例子：

>>> s = { 'name': 'GOOG', 'shares': 100, 'price':490.1 }
>>> e = dict_to_xml('stock', s)
>>> e
<Element 'stock' at 0x1004b64c8>
>>>

轉(zhuǎn)換結(jié)果是一個 Element 實例。對于I/O操作，使用 xml.etree.ElementTree 中的 tostring()函數(shù)很容易就能將它轉(zhuǎn)換成一個字節(jié)字符串。例如：

>>> from xml.etree.ElementTree import tostring
>>> tostring(e)
b'<stock><price>490.1</price><shares>100</shares><name>GOOG</name></stock>'
>>>

如果你想給某個元素添加屬性值，可以使用 set() 方法：

>>> e.set('_id','1234')
>>> tostring(e)
b'<stock _id="1234"><price>490.1</price><shares>100</shares><name>GOOG</name>
</stock>'
>>>

如果你還想保持元素的順序，可以考慮構(gòu)造一個 OrderedDict 來代替一個普通的字典。請參考1.7小節(jié)。

討論

當(dāng)創(chuàng)建XML的時候，你被限制只能構(gòu)造字符串類型的值。例如：

def dict_to_xml_str(tag, d):
    '''
    Turn a simple dict of key/value pairs into XML
    '''
    parts = ['<{}>'.format(tag)]
    for key, val in d.items():
        parts.append('<{0}>{1}</{0}>'.format(key,val))
    parts.append('</{}>'.format(tag))
    return ''.join(parts)

問題是如果你手動的去構(gòu)造的時候可能會碰到一些麻煩。例如，當(dāng)字典的值中包含一些特殊字符的時候會怎樣呢？

>>> d = { 'name' : '<spam>' }

>>> # String creation
>>> dict_to_xml_str('item',d)
'<item><name><spam></name></item>'

>>> # Proper XML creation
>>> e = dict_to_xml('item',d)
>>> tostring(e)
b'<item><name>&lt;spam&gt;</name></item>'
>>>

注意到程序的后面那個例子中，字符 ‘<' 和 ‘>' 被替換成了 < 和 >

下面僅供參考，如果你需要手動去轉(zhuǎn)換這些字符，可以使用 xml.sax.saxutils 中的 escape() 和 unescape() 函數(shù)。例如：

>>> from xml.sax.saxutils import escape, unescape
>>> escape('<spam>')
'&lt;spam&gt;'
>>> unescape(_)
'<spam>'
>>>

除了能創(chuàng)建正確的輸出外，還有另外一個原因推薦你創(chuàng)建 Element 實例而不是字符串，那就是使用字符串組合構(gòu)造一個更大的文檔并不是那么容易。而 Element 實例可以不用考慮解析XML文本的情況下通過多種方式被處理。也就是說，你可以在一個高級數(shù)據(jù)結(jié)構(gòu)上完成你所有的操作，并在最后以字符串的形式將其輸出。