X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FxmlManager.py;h=9c84cc18f0fedf5f7749340ae19781536dbb9dba;hb=5af0795a0f8264bd5d9ca43f384b689f7203b654;hp=ad0d8150f74441edada274af9cc28d666c9ba199;hpb=75c387abdb9d9551aae852414ef189f761cc7a64;p=tools%2Fsat.git

diff --git a/src/xmlManager.py b/src/xmlManager.py
index ad0d815..9c84cc1 100644
--- a/src/xmlManager.py
+++ b/src/xmlManager.py
@@ -26,11 +26,23 @@ class xmlLogFile(object):
     '''Class to manage writing in salomeTools xml log file
     '''
     def __init__(self, filePath, rootname, attrib = {}):
+        '''Initialization
+        
+        :param filePath str: The path to the file where to write the log file
+        :param rootname str: The name of the root node of the xml file
+        :param attrib dict: the dictionary that contains the attributes and value of the root node
+        '''
+        # Initialize the filePath and ensure that the directory that contain the file exists (make it if necessary)
         self.logFile = filePath
         src.ensure_path_exists(os.path.dirname(filePath))
+        # Initialize the field that contain the xml in memory
         self.xmlroot = etree.Element(rootname, attrib = attrib)
     
     def write_tree(self, stylesheet=None):
+        '''Write the xml tree in the log file path. Add the stylesheet if asked.
+        
+        :param stylesheet str: The stylesheet to apply to the xml file
+        '''
         f = open(self.logFile, 'w')
         f.write("<?xml version='1.0' encoding='utf-8'?>\n")
         if stylesheet:
@@ -39,32 +51,62 @@ class xmlLogFile(object):
         f.close()  
         
     def add_simple_node(self, node_name, text=None, attrib={}):
+        '''Add a node with some attibutes and text to the root node.
+        
+        :param node_name str: the name of the node to add
+        :param text str: the text of the node
+        :param attrib dict: the dictionary containing the attribute of the new node
+        '''
         n = etree.Element(node_name, attrib=attrib)
         n.text = text
         self.xmlroot.append(n)
         return n
     
-    def append_node(self, node_name, text):
+    def append_node_text(self, node_name, text):
+        '''Append a new text to the node that has node_name as name
+        
+        :param node_name str: The name of the node on which append text
+        :param text str: The text to append
+        '''
+        # find the corresponding node
         for field in self.xmlroot:
             if field.tag == node_name:
+                # append the text
                 field.text += text
 
+    def append_node_attrib(self, node_name, attrib):
+        '''Append a new attributes to the node that has node_name as name
+        
+        :param node_name str: The name of the node on which append text
+        :param attrib dixt: The attrib to append
+        '''
+        self.xmlroot.find(node_name).attrib.update(attrib)
+
 class readXmlFile(object):
     '''Class to manage reading of an xml log file
     '''
     def __init__(self, filePath):
+        '''Initialization
+        
+        :param filePath str: The xml file to be read
+        '''
         self.filePath = filePath
         etree_inst = etree.parse(filePath)
         self.xmlroot = etree_inst.parse(filePath)
     
-    def get_attrib_text(self, attribname):
-        lres = []
-        for field in self.xmlroot:
-            if attribname in field.attrib:
-                lres.append((field.attrib[attribname], field.text))
-        return lres
+    def get_attrib(self, node_name):
+        '''Get the attibutes of the node node_name in self.xmlroot
+        
+        :param node_name str: the name of the node
+        '''
+        return self.xmlroot.find(node_name).attrib
     
     def get_node_text(self, node):
+        '''Get the text of the first node that has name that corresponds to the parameter node
+        
+        :param node str: the name of the node from which get the text
+        '''
+        # Loop on all root nodes
         for field in self.xmlroot:
             if field.tag == node:
                 return field.text
@@ -72,23 +114,34 @@ class readXmlFile(object):
 
 
 def update_hat_xml(logDir, application=None):
+    '''Create the xml file in logDir that contain all the xml file and have a name like YYYYMMDD_HHMMSS_namecmd.xml
+    
+    :param logDir str: the directory to parse
+    :param application str: the name of the application if there is any
+    '''
+    # Create an instance of xmlLogFile class to create hat.xml file
     xmlHatFilePath = os.path.join(logDir, 'hat.xml')
+    # If there is an application, add the attribute to the root node
     if application:
         xmlHat = xmlLogFile(xmlHatFilePath,  "LOGlist", {"application" : application})
     else:
         xmlHat = xmlLogFile(xmlHatFilePath,  "LOGlist", {"application" : "NO"})
-          
+    
+    # parse the log directory to find all the command logs, then add it to the xml file
     for fileName in os.listdir(logDir):
+        # YYYYMMDD_HHMMSS_namecmd.xml
         sExpr = "^[0-9]{8}_+[0-9]{6}_+.*.xml$"
         oExpr = re.compile(sExpr)
         if oExpr.search(fileName):
+            # get date and hour and format it
             date_hour_cmd = fileName.split('_')
             date_not_formated = date_hour_cmd[0]
             date = "%s/%s/%s" % (date_not_formated[6:8], date_not_formated[4:6], date_not_formated[0:4] )
             hour_not_formated = date_hour_cmd[1]
             hour = "%s:%s:%s" % (hour_not_formated[0:2], hour_not_formated[2:4], hour_not_formated[4:6])
             cmd = date_hour_cmd[2][:-len('.xml')]
-        
+            # add a node to the hat.xml file
             xmlHat.add_simple_node("LogCommand", text=fileName, attrib = {"date" : date, "hour" : hour, "cmd" : cmd})
     
+    # Write the file on the hard drive
     xmlHat.write_tree('hat.xsl')
\ No newline at end of file