2.17 在字符串中處理html和xml

問題

你想將HTML或者XML實體如 &entity; 或 &#code; 替換為對應(yīng)的文本。再者，你需要轉(zhuǎn)換文本中特定的字符(比如<, >, 或 &)。

解決方案

如果你想替換文本字符串中的 ‘<' 或者 ‘>' ，使用 html.escape() 函數(shù)可以很容易的完成。比如：

>>> s = 'Elements are written as "<tag>text</tag>".'
>>> import html
>>> print(s)
Elements are written as "<tag>text</tag>".
>>> print(html.escape(s))
Elements are written as &quot;&lt;tag&gt;text&lt;/tag&gt;&quot;.

>>> # Disable escaping of quotes
>>> print(html.escape(s, quote=False))
Elements are written as "&lt;tag&gt;text&lt;/tag&gt;".
>>>

如果你正在處理的是ASCII文本，并且想將非ASCII文本對應(yīng)的編碼實體嵌入進去，可以給某些I/O函數(shù)傳遞參數(shù) errors='xmlcharrefreplace' 來達到這個目。比如：

>>> s = 'Spicy Jalape?o'
>>> s.encode('ascii', errors='xmlcharrefreplace')
b'Spicy Jalapeño'
>>>

為了替換文本中的編碼實體，你需要使用另外一種方法。如果你正在處理HTML或者XML文本，試著先使用一個合適的HTML或者XML解析器。通常情況下，這些工具會自動替換這些編碼值，你無需擔心。

有時候，如果你接收到了一些含有編碼值的原始文本，需要手動去做替換，通常你只需要使用HTML或者XML解析器的一些相關(guān)工具函數(shù)/方法即可。比如：

>>> s = 'Spicy "Jalapeño&quot.'
>>> from html.parser import HTMLParser
>>> p = HTMLParser()
>>> p.unescape(s)
'Spicy "Jalape?o".'
>>>
>>> t = 'The prompt is >>>'
>>> from xml.sax.saxutils import unescape
>>> unescape(t)
'The prompt is >>>'
>>>

討論

在生成HTML或者XML文本的時候，如果正確的轉(zhuǎn)換特殊標記字符是一個很容易被忽視的細節(jié)。特別是當你使用 print() 函數(shù)或者其他字符串格式化來產(chǎn)生輸出的時候。使用像 html.escape() 的工具函數(shù)可以很容易的解決這類問題。

如果你想以其他方式處理文本，還有一些其他的工具函數(shù)比如 xml.sax.saxutils.unescapge() 可以幫助你。然而，你應(yīng)該先調(diào)研清楚怎樣使用一個合適的解析器。比如，如果你在處理HTML或XML文本，使用某個解析模塊比如 html.parse 或 xml.etree.ElementTree 已經(jīng)幫你自動處理了相關(guān)的替換細節(jié)。