Changeset ea67541 in sasview for src/sans/dataloader

Timestamp:

Apr 3, 2014 5:22:58 AM (11 years ago)

Author:

Jeff Krzywon <jeffery.krzywon@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

caf273b

Parents:

307fa4f

Message:

Fix for ticket #204 - processing instructions were not being set properly when saving as cansas data file.

Location:

src/sans/dataloader/readers

Files:

• cansas_reader.py (modified) (8 diffs)
• xml_reader.py (modified) (6 diffs)

src/sans/dataloader/readers/cansas_reader.py

@@ -28 +28 @@
 
 _ZERO = 1e-16
+PREPROCESS = "xmlpreprocess"
 HAS_CONVERTER = True
 try:
@@ -212 +213 @@
                             data1d.filename = name
                             data1d.meta_data["loader"] = "CanSAS 1D"
+                            
+                            # Get all preprocessing events
+                            self.reader.setProcessingInstructions()
+                            data1d.meta_data[PREPROCESS] = \
+                                    self.reader.processingInstructions
+                            
+                            # Parse the XML file
                             return_value, extras = \
                                 self._parse_entry(entry, ns, data1d)
@@ -247 +255 @@
         return None
     
-    def _create_unique_key(self, dictionary, name, i):
+    def _create_unique_key(self, dictionary, name, i = 0):
         """
         Create a unique key value for any dictionary to prevent overwriting
-        
+        Recurses until a unique key value is found.
         
         :param dictionary: A dictionary with any number of entries
         :param name: The index of the item to be added to dictionary
-        :param i: The number to be appended to the name
+        :param i: The number to be appended to the name, starts at 0
         """
         if dictionary.get(name) is not None:
@@ -291 +299 @@
                     if HAS_CONVERTER == True:
                         try:
-                            ## Check local units - bad units should raise KeyError
+                            ## Check local units - bad units raise KeyError
                             Converter(local_unit)
                             data_conv_q = Converter(attr['unit'])
@@ -347 +355 @@
                             CANSAS_NS.get(self.cansas_version).get("ns"), "}")
         unit = ''
+        tagname = ''
+        tagname_original = ''
         
         # Go through each child in the parent element
@@ -440 +450 @@
                         exec item
                 # Don't bother saving empty information unless it is a float
-                if cs_values.ns_variable is not None and node_value is not None and \
+                if cs_values.ns_variable is not None and \
+                            node_value is not None and \
                             node_value.isspace() == False:
                     # Format a string and then execute it.
-                    store_me = cs_values.ns_variable.format("data1d", node_value, tagname)
+                    store_me = cs_values.ns_variable.format("data1d", \
+                                                            node_value, tagname)
                     exec store_me
                 # Get attributes and process them
@@ -503 +515 @@
         
         main_node = doc.createElement("SASroot")
-        if self.cansas_version == "1.1":
-            pi = doc.createProcessingInstruction('xml-stylesheet', \
-                                    'type="text/xsl" href="cansasxml-html.xsl"')
-            root = doc.firstChild
-            doc.insertBefore(pi, root)
+        
+        doc = self.setProcessingInstructions(doc, datainfo.meta_data[PREPROCESS])
         main_node.setAttribute("version", self.cansas_version)
         main_node.setAttribute("xmlns", ns)
@@ -789 +798 @@
         fd.write(doc.toprettyxml())
         fd.close()
+    
+    ## Once I convert the writer to lxml from minidom
+    ## This can be moved into xml_reader
+    def setProcessingInstructions(self, minidomObject, dic):
+        xmlroot = minidomObject.firstChild
+        for item in dic:
+            pi = minidomObject.createProcessingInstruction(item, dic[item])
+            minidomObject.insertBefore(pi, xmlroot)
+        return minidomObject
+    
+    

src/sans/dataloader/readers/xml_reader.py

@@ -14 +14 @@
 
 from lxml import etree
-parser = etree.ETCompatXMLParser()
+parser = etree.ETCompatXMLParser(remove_comments=True, remove_pis=False)
 
 class XMLreader():
@@ -23 +23 @@
     schema = None
     schemadoc = None
+    processingInstructions = None
     
     def __init__(self, xml = None, schema = None, root = None):
         self.xml = xml
         self.schema = schema
+        self.processingInstructions = {}
         if xml is not None:
             self.setXMLFile(xml, root)
@@ -48 +50 @@
     
     def setXMLFile(self, xml, root = None):
+        """
+        Set the XML file and parse
+        """
         try:
             self.xml = xml
@@ -58 +63 @@
     
     def setSchema(self, schema):
+        """
+        Set the schema file and parse
+        """
         try:
             self.schema = schema
@@ -78 +86 @@
     def findInvalidXML(self):
         """
-        Finds the first offending element that should not be present in an XML file
+        Finds the first offending element that should not be present in XML file
         """
         firstError = ""
@@ -96 +104 @@
         self.setSchema(self.schema)
         
+    def toString(self, etreeElement):
+        """
+        Converts and etree element into a string
+        """
+        return etree.tostring(etreeElement)
+    
+    def setProcessingInstructions(self):
+        """
+        Take out all processing instructions and create a dictionary from them
+        """
+        dic = {}
+        pi = self.xmlroot.getprevious()
+        while pi is not None:
+            attr = {}
+            pi_name = ""
+            pi_string = self.toString(pi)
+            if isinstance(pi_string, str):
+                pi_string = pi_string.replace("<?", "").replace("?>", "")
+                split = pi_string.split(" ", 1)
+                pi_name = split[0]
+                attr = split[1]
+            new_pi_name = self._create_unique_key(dic, pi_name)
+            dic[new_pi_name] = attr
+            pi = pi.getprevious()
+        self.processingInstructions = dic
+        
+    def _create_unique_key(self, dictionary, name, i = 0):
+        """
+        Create a unique key value for any dictionary to prevent overwriting
+        Recurses until a unique key value is found.
+        
+        :param dictionary: A dictionary with any number of entries
+        :param name: The index of the item to be added to dictionary
+        :param i: The number to be appended to the name, starts at 0
+        """
+        if dictionary.get(name) is not None:
+            i += 1
+            name = name.split("_")[0]
+            name += "_{0}".format(i)
+            name = self._create_unique_key(dictionary, name, i)
+        return name
+    
+