xmlutils.py 1.4 KB

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