#!/usr/bin/env python
-#-*- coding:utf-8 -*-
+# -*- coding:utf-8 -*-
# Copyright (C) 2010-2013 CEA/DEN
#
# This library is free software; you can redistribute it and/or
import os
import shutil
-try: # For python2
+try: # For python2
import sys
- reload(sys)
- sys.setdefaultencoding('utf8')
+
+ reload(sys)
+ sys.setdefaultencoding("utf8")
except:
pass
verbose = False
+
class XmlLogFile(object):
- '''Class to manage writing in salomeTools xml log file
- '''
- def __init__(self, filePath, rootname, attrib = {}):
- '''Initialization
-
+ """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
+ :param attrib dict: the dictionary that contains the attributes
and value of the root node
- '''
- # Initialize the filePath and ensure that the directory
+ """
+ # 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)
+ self.xmlroot = etree.Element(rootname, attrib=attrib)
+
+ def write_tree(self, stylesheet=None, file_path=None):
+ """Write the xml tree in the log file path. Add the stylesheet if asked.
- def write_tree(self, stylesheet=None, file_path = 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
- '''
+ """
log_file_path = self.logFile
if file_path:
- log_file_path = file_path
+ log_file_path = file_path
try:
- with open(log_file_path, 'w') as f:
- f.write("<?xml version='1.0' encoding='utf-8'?>\n")
- if stylesheet:
- # example as href='./hat.xsl'
- # as local file xml with local file xsl
- # with 'python3 -m http.server 8765 &' and
- # 'chromium-browser http://localhost:8765/hat.xml' or
- # 'firefox http://localhost:8765/hat.xml'
- f.write("<?xml-stylesheet type='text/xsl' href='./%s'?>\n" % stylesheet)
- pass
- res= etree.tostring(self.xmlroot, encoding='utf-8')
- f.write(res)
+ with open(log_file_path, "w") as f:
+ f.write("<?xml version='1.0' encoding='utf-8'?>\n")
+ if stylesheet:
+ # example as href='./hat.xsl'
+ # as local file xml with local file xsl
+ # with 'python3 -m http.server 8765 &' and
+ # 'chromium-browser http://localhost:8765/hat.xml' or
+ # 'firefox http://localhost:8765/hat.xml'
+ f.write(
+ "<?xml-stylesheet type='text/xsl' href='./%s'?>\n" % stylesheet
+ )
+ pass
+ res = etree.tostring(self.xmlroot, encoding="utf-8")
+ f.write(res)
except IOError:
- pass
-
+ pass
+
def add_simple_node(self, node_name, text=None, attrib={}):
- '''Add a node with some attibutes and text to the root node.
-
+ """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
+ :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_text(self, node_name, text):
- '''Append a new text to the node that has node_name as name
-
+ """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:
field.text += text
def append_node_attrib(self, node_name, attrib):
- '''Append a new attributes to the node that has node_name as name
-
+ """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
- '''
+ """Class to manage reading of an xml log file"""
+
def __init__(self, filePath):
- '''Initialization
-
+ """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 getRootAttrib(self):
- '''Get the attibutes of the self.xmlroot
-
+ """Get the attibutes of the self.xmlroot
+
:return: The attributes of the root node
:rtype: dict
- '''
+ """
return self.xmlroot.attrib
-
+
def get_attrib(self, node_name):
- '''Get the attibutes of the node node_name in self.xmlroot
-
+ """Get the attibutes of the node node_name in self.xmlroot
+
:param node_name str: the name of the node
:return: the attibutes of the node node_name in self.xmlroot
:rtype: dict
- '''
+ """
attrib = self.xmlroot.find(node_name).attrib
# To be python 3 compatible, convert bytes to str if there are any
fixedAttrib = {}
value = attrib[k]
fixedAttrib[key] = value
return fixedAttrib
-
+
def get_node_text(self, node):
- '''Get the text of the first node that has name
+ """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
- :return: the text of the first node that has name
+ :return: the text of the first node that has name
that corresponds to the parameter node
:rtype: str
- '''
+ """
return self.xmlroot.find(node).text
-
+
+
def add_simple_node(root_node, node_name, text=None, attrib={}):
- '''Add a node with some attibutes and text to the root node.
+ """Add a node with some attibutes and text to the root node.
- :param root_node etree.Element: the Etree element where to add the new node
+ :param root_node etree.Element: the Etree element where to add the new 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
+ :param attrib dict: the dictionary containing the
attribute of the new node
- '''
+ """
n = etree.Element(node_name, attrib=attrib)
n.text = text
root_node.append(n)
return n
+
def append_node_attrib(root_node, attrib):
- '''Append a new attributes to the node that has node_name as name
-
- :param root_node etree.Element: the Etree element
+ """Append a new attributes to the node that has node_name as name
+
+ :param root_node etree.Element: the Etree element
where to append the new attibutes
:param attrib dixt: The attrib to append
- '''
+ """
root_node.attrib.update(attrib)
+
def find_node_by_attrib(xmlroot, name_node, key, value):
- '''Find the nfirst ode from xmlroot that has name name_node and that has in
+ """Find the nfirst ode from xmlroot that has name name_node and that has in
its attributes {key : value}. Return the node
-
+
:param xmlroot etree.Element: the Etree element where to search
:param name_node str: the name of node to search
:param key str: the key to search
:param value str: the value to search
:return: the found node
:rtype: xmlroot etree.Element
- '''
- l_nodes = xmlroot.findall(name_node)
+ """
+ l_nodes = xmlroot.findall(name_node)
for node in l_nodes:
if key not in node.attrib.keys():
continue
if node.attrib[key] == value:
return node
return None
-
+
def write_report(filename, xmlroot, stylesheet):
"""Writes a report file from a XML tree.
-
+
:param filename str: The path to the file to create
:param xmlroot etree.Element: the Etree element to write to the file
:param stylesheet str: The stylesheet to add to the begin of the file
"""
dirname = os.path.dirname(filename)
if not os.path.exists(dirname):
- os.makedirs(dirname)
+ os.makedirs(dirname)
if len(stylesheet) > 0:
- styleName = stylesheet
+ styleName = stylesheet
else:
- styleName = None
+ styleName = None
with open(filename, "w") as f:
- f.write("<?xml version='1.0' encoding='utf-8'?>\n")
- if styleName is not None:
- f.write("<?xml-stylesheet type='text/xsl' href='%s'?>\n" % styleName)
- res = etree.tostring(xmlroot, encoding='utf-8')
- # print("********** etree.tostring %s" % res)
- f.write(res)
+ f.write("<?xml version='1.0' encoding='utf-8'?>\n")
+ if styleName is not None:
+ f.write("<?xml-stylesheet type='text/xsl' href='%s'?>\n" % styleName)
+ res = etree.tostring(xmlroot, encoding="utf-8")
+ # print("********** etree.tostring %s" % res)
+ f.write(res)
# create fileStyle in dirname if not existing
if styleName is not None:
- styleFile = os.path.join(dirname, styleName)
- if not os.path.exists(styleFile):
- # copy if from "salomeTools/src/xsl"
- srcdir = os.path.dirname(src.__file__)
- srcFile = os.path.join(srcdir, "xsl", styleName)
- if verbose: print("write_report %s style %s" % (srcFile, styleFile))
- shutil.copy(srcFile, dirname)
+ styleFile = os.path.join(dirname, styleName)
+ if not os.path.exists(styleFile):
+ # copy if from "salomeTools/src/xsl"
+ srcdir = os.path.dirname(src.__file__)
+ srcFile = os.path.join(srcdir, "xsl", styleName)
+ if verbose:
+ print("write_report %s style %s" % (srcFile, styleFile))
+ shutil.copy(srcFile, dirname)
+
def escapeSequence(aStr):
"""
' (apostrophe or single quote) as '
" (double-quote) as "
"""
- replaces = [ ('&', '&'),
- ('>', '>'),
- ('<', '<'),
- ("'", '''),
- ('"', '"'),
- ]
+ replaces = [
+ ("&", "&"),
+ (">", ">"),
+ ("<", "<"),
+ ("'", "'"),
+ ('"', """),
+ ]
res = aStr
- for ini, fin in replaces: # order matters
- res = res.replace(ini, fin)
+ for ini, fin in replaces: # order matters
+ res = res.replace(ini, fin)
return res
-
-
