XML Converter

Summary

Base functionality for matching and converting XML trees is implemented.

See: #145 (closed)

This should be reviewed and merged relatively soon. Follow-up issues will be created for the following tasks:

• user and API documentation (#159)
• design and implement more unit tests (#160)
• integration tests (#161)
• issue for creating attribute node converter and completing the text node converter (#158 (closed))

Focus

Have a look at #145 (closed) and check whether the requirements are met.

Test Environment

There are unit tests.

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caoscrawler/structure_elements.py

@@ -175,11 +175,9 @@ class XMLTagElement(StructureElement):
     Stores elements of an XML tree.
     """
 
-    def __init__(self, element: lxml.etree.Element,
-                 tree: lxml.etree.ElementTree):
-        super().__init__(tree.getelementpath(element))
+    def __init__(self, element: lxml.etree.Element):
+        super().__init__(element.getroottree().getelementpath(element))
         self.tag = element
-        self.tree = tree
 
 
 class XMLTextNode(StructureElement):
@@ -187,8 +185,7 @@ class XMLTextNode(StructureElement):
     Stores text nodes of XML trees.
     """
 
-    def __init__(self, element: lxml.etree.Element,
-                 tree: lxml.etree.ElementTree):
+    def __init__(self, element: lxml.etree.Element):
         """
         Initializes this XML text node.
 
@@ -199,7 +196,7 @@ class XMLTextNode(StructureElement):
         - XMLTextNodes just have a text and the name is just for identifying the structure element.
           They can only be matched using the match entry in the XMLTextNodeConverter.
         """
-        super().__init__(tree.getelementpath(element))
+        super().__init__(element.getroottree().getelementpath(element))
         self.tag = element
         self.value = element.text
 
@@ -219,7 +216,8 @@ class XMLAttributeNode(StructureElement):
         key: The key which identifies the attribute in the list of attributes.
         tree: The tree containing the element which is used to set the node path.
         """
-        super().__init__(tree.getelementpath(element))
+        super().__init__(element.getroottree().getelementpath(element))
         self.value = element.attrib[key]
         self.key = key
+        # TODO: use getpath instead of getlementpath?
         self.tag = element