Faithfully Preserve Comments in Parsed XML

by

Tested with Python 2.7 and 3.5, the following code should work as intended.

#!/usr/bin/env python
# CommentedTreeBuilder.py
from xml.etree import ElementTree

class CommentedTreeBuilder(ElementTree.TreeBuilder):
    def comment(self, data):
        self.start(ElementTree.Comment, {})
        self.data(data)
        self.end(ElementTree.Comment)

Then, in the main code use

parser = ElementTree.XMLParser(target=CommentedTreeBuilder())

as the parser instead of the current one.

By the way, comments work correctly out of the box with lxml. That is, you can just do

import lxml.etree as ET
tree = ET.parse(filename)

without needing any of the above.

More Related Contents:

  1. Merge xml files with nested elements without external libraries
  2. Parsing XML with namespace in Python via ‘ElementTree’
  3. Using Python Iterparse For Large XML Files
  4. How do I get Python’s ElementTree to pretty print to an XML file?
  5. Can ElementTree be told to preserve the order of attributes?
  6. How to create with Python’s cElementTree
  7. Empty list returned from ElementTree findall
  8. Remove whitespaces in XML string
  9. parsing xml containing default namespace to get an element value using lxml
  10. Using XPath in ElementTree
  11. parsing XML file gets UnicodeEncodeError (ElementTree) / ValueError (lxml)
  12. Reading XML file and fetching its attributes value in Python
  13. How to write XML declaration using xml.etree.ElementTree
  14. Converting xml to dictionary using ElementTree
  15. Is there a way to get a line number from an ElementTree Element
  16. Parsing compressed xml feed into ElementTree
  17. Find element by text with XPath in ElementTree
  18. How do I parse and write XML using Python’s ElementTree without moving namespaces around?
  19. Use xml.etree.ElementTree to print nicely formatted xml files [duplicate]
  20. Emitting namespace specifications with ElementTree in Python
  21. ElementTree findall() returning empty list
  22. Execute python script while open terminal
  23. Division in Python 2.7. and 3.3 [duplicate]
  24. How to check the version of Python modules
  25. Cleanest way to get last item from Python iterator
  26. How to update/modify an XML file in python?
  27. Why python’s list slicing doesn’t produce index out of bound error? [duplicate]
  28. Opencv – Grayscale mode Vs gray color conversion
  29. How to make a simple multithreaded socket server in Python that remembers clients
  30. subprocess.Popen in different console

Leave a Comment