| 1 |
""" |
| 2 |
Utilities for XML generation/parsing. |
| 3 |
""" |
| 4 |
|
| 5 |
import re |
| 6 |
from xml.sax.saxutils import XMLGenerator |
| 7 |
|
| 8 |
|
| 9 |
class UnserializableContentError(ValueError): |
| 10 |
pass |
| 11 |
|
| 12 |
|
| 13 |
class SimplerXMLGenerator(XMLGenerator): |
| 14 |
def addQuickElement(self, name, contents=None, attrs=None): |
| 15 |
"Convenience method for adding an element with no children" |
| 16 |
if attrs is None: |
| 17 |
attrs = {} |
| 18 |
self.startElement(name, attrs) |
| 19 |
if contents is not None: |
| 20 |
self.characters(contents) |
| 21 |
self.endElement(name) |
| 22 |
|
| 23 |
def characters(self, content): |
| 24 |
if content and re.search(r"[\x00-\x08\x0B-\x0C\x0E-\x1F]", content): |
| 25 |
# Fail loudly when content has control chars (unsupported in XML 1.0) |
| 26 |
# See https://www.w3.org/International/questions/qa-controls |
| 27 |
raise UnserializableContentError( |
| 28 |
"Control characters are not supported in XML 1.0" |
| 29 |
) |
| 30 |
XMLGenerator.characters(self, content) |
| 31 |
|
| 32 |
def startElement(self, name, attrs): |
| 33 |
# Sort attrs for a deterministic output. |
| 34 |
sorted_attrs = dict(sorted(attrs.items())) if attrs else attrs |
| 35 |
super().startElement(name, sorted_attrs) |