XmlExporter.write_xml() - Code Metrics - Inspection of "Merge pull request #302 from FreeOpcUa/xmlexporter" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8f029f...e8ef15 )

by Olivier

created 2016-09-21 07:26 UTC

XmlExporter.write_xml() B

↳ Parent: XmlExporter

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
cc	2
c	4
b	1
f	1
dl	0
loc	24
rs	8.9713

"""
from a list of nodes in the address space, build an XML file
format is the one from opc-ua specification
"""
import logging
from collections import OrderedDict
import xml.etree.ElementTree as Et

from opcua import ua
from opcua.ua import object_ids as o_ids


class XmlExporter(object):

    def __init__(self, server):
        self.logger = logging.getLogger(__name__)
        self.server = server
        self.aliases = {}

        node_set_attributes = OrderedDict()
        node_set_attributes['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
        node_set_attributes['xmlns:uax'] = 'http://opcfoundation.org/UA/2008/02/Types.xsd'
        node_set_attributes['xmlns:xsd'] = 'http://www.w3.org/2001/XMLSchema'
        node_set_attributes['xmlns'] = 'http://opcfoundation.org/UA/2011/03/UANodeSet.xsd'

        self.etree = Et.ElementTree(Et.Element('UANodeSet', node_set_attributes))

    def build_etree(self, node_list, uris=None):
        """
        Create an XML etree object from a list of nodes; custom namespace uris are optional
        Args:
            node_list: list of Node objects for export
            uris: list of namespace uri strings

        Returns:
        """
        self.logger.info('Building XML etree')

        # add all nodes in the list to the XML etree
        for node in node_list:
            self.node_to_etree(node)

        # add aliases to the XML etree
        self._add_alias_els()

        if uris:
            # add namespace uris to the XML etree
            self._add_namespace_uri_els(uris)

    def write_xml(self, xmlpath, pretty=True):
        """
        Write the XML etree in the exporter object to a file
        Args:
            xmlpath: string representing the path/file name

        Returns:
        """
        # try to write the XML etree to a file
        self.logger.info('Exporting XML file to %s', xmlpath)
        #from IPython import embed
        #embed()
        if pretty:
            indent(self.etree.getroot())
            self.etree.write(xmlpath, 
                             short_empty_elements=False, 
                             encoding='utf-8', 
                             xml_declaration=True
                             )
        else:
            self.etree.write(xmlpath, 
                             short_empty_elements=False, 
                             encoding='utf-8', 
                             xml_declaration=True)

    def dump_etree(self):
        """
        Dump etree to console for debugging
        Returns:
        """
        self.logger.info('Dumping XML etree to console')
        Et.dump(self.etree)

    def node_to_etree(self, node):
        """
        Add the necessary XML sub elements to the etree for exporting the node
        Args:
            node: Node object which will be added to XML etree

        Returns:
        """
        node_class = node.get_node_class()
        print("Exporting: ", node)

        if node_class is ua.NodeClass.Object:
            self.add_etree_object(node)
        elif node_class is ua.NodeClass.ObjectType:
            self.add_etree_object_type(node)
        elif node_class is ua.NodeClass.Variable:
            self.add_etree_variable(node)
        elif node_class is ua.NodeClass.VariableType:
            self.add_etree_variable_type(node)
        elif node_class is ua.NodeClass.ReferenceType:
            self.add_etree_reference(node)
        elif node_class is ua.NodeClass.DataType:
            self.add_etree_datatype(node)
        elif node_class is ua.NodeClass.Method:
            self.add_etree_method(node)
        else:
            self.logger.info("Exporting node class not implemented: %s ", node_class)

    def _add_sub_el(self, el, name, text):
        child_el = Et.SubElement(el, name)
        child_el.text = text
        return child_el

    def _add_node_common(self, nodetype, node):
        browsename = node.get_browse_name().to_string()
        nodeid = node.nodeid.to_string()
        parent = node.get_parent()
        displayname = node.get_display_name().Text.decode('utf-8')
        desc = node.get_description().Text
        print("NODE COMMON", node)
        node_el = Et.SubElement(self.etree.getroot(),
                                nodetype,
                                BrowseName=browsename,
                                NodeId=nodeid)
        if parent is not None:
            node_el.attrib["ParentNodeId"] = parent.nodeid.to_string()
        if desc not in (None, ""):
            self._add_sub_el(node_el, 'Description', desc.decode('utf-8'))
        self._add_sub_el(node_el, 'DisplayName', displayname)
        return node_el

    def add_etree_object(self, obj):
        """
        Add a UA object element to the XML etree
        """
        obj_el = self._add_node_common("UAObject", obj)
        self._add_ref_els(obj_el, obj)

    def add_etree_object_type(self, node):
        """
        Add a UA object type element to the XML etree
        """
        obj_el = self._add_node_common("UAObjectType", node)
        abstract = node.get_attribute(ua.AttributeIds.IsAbstract).Value.Value
        if abstract:
            obj_el.attrib["IsAbstract"] = 'true'
        self._add_ref_els(obj_el, node)

    def add_variable_common(self, node, el):
        dtype = node.get_data_type()
        if dtype.Identifier in o_ids.ObjectIdNames:
            dtype_name = o_ids.ObjectIdNames[dtype.Identifier]
            self.aliases[dtype_name] = dtype.to_string()
        else:
            dtype_name = dtype.to_string()
        rank = node.get_value_rank()
        el.attrib["DataType"] = dtype_name
        el.attrib["ValueRank"] = str(int(rank))
        value_to_etree(el, dtype_name, dtype, node)

    def add_etree_variable(self, node):
        """
        Add a UA variable element to the XML etree
        """
        var_el = self._add_node_common("UAVariable", node)
        self.add_variable_common(node, var_el)

        accesslevel = node.get_attribute(ua.AttributeIds.AccessLevel).Value.Value
        useraccesslevel = node.get_attribute(ua.AttributeIds.UserAccessLevel).Value.Value

        # We only write these values if they are different from defaults
        # default must of course mange the one in manage_nodes.py
        # and other OPC UA servers
        if accesslevel != ua.AccessLevel.CurrentRead.mask:
            var_el.attrib["AccessLevel"] = str(accesslevel)
        if useraccesslevel != ua.AccessLevel.CurrentRead.mask:
            var_el.attrib["UserAccessLevel"] = str(useraccesslevel)
        self._add_ref_els(var_el, node)

    def add_etree_variable_type(self, node):
        """
        Add a UA variable type element to the XML etree
        """

        var_el = self._add_node_common("UAVariable", node)
        self.add_variable_common(node, var_el)

        abstract = node.get_attribute(ua.AttributeIds.IsAbstract)
        if abstract:
            var_el.attrib["IsAbstract"] = abstract

        self._add_ref_els(var_el, node)

    def add_etree_method(self, obj):
        obj_el = self._add_node_common("UAMethod", obj)
        self._add_ref_els(obj_el, obj)

    def add_etree_reference(self, obj):
        obj_el = self._add_node_common("UAReference", obj)
        self._add_ref_els(obj_el, obj)

    def add_etree_datatype(self, obj):
        """
        Add a UA data type element to the XML etree
        """
        obj_el = self._add_node_common("UADataType", obj)
        self._add_ref_els(obj_el, obj)

    def _add_namespace_uri_els(self, uris):
        nuris_el = Et.Element('NamespaceUris')

        for uri in uris:
            self._add_sub_el(nuris_el, 'Uri', uri)

        self.etree.getroot().insert(0, nuris_el)

    def _add_alias_els(self):
        aliases_el = Et.Element('Aliases')

        for k, v in self.aliases.items():
            ref_el = Et.SubElement(aliases_el, 'Alias', Alias=k)
            ref_el.text = v

        self.etree.getroot().insert(0, aliases_el)

    def _add_ref_els(self, parent_el, obj):
        refs = obj.get_references()
        refs_el = Et.SubElement(parent_el, 'References')

        for ref in refs:
            if ref.ReferenceTypeId.Identifier in o_ids.ObjectIdNames:
                ref_name = o_ids.ObjectIdNames[ref.ReferenceTypeId.Identifier]
            else:
                ref_name = ref.ReferenceTypeId.to_string()
            ref_el = Et.SubElement(refs_el, 'Reference', ReferenceType=ref_name)
            if not ref.IsForward:
                ref_el.attrib['IsForward'] = 'false'
            ref_el.text = ref.NodeId.to_string()

            # add any references that gets used to aliases dict; this gets handled later
            self.aliases[ref_name] = ref.ReferenceTypeId.to_string()


def value_to_etree(el, dtype_name, dtype, node):
    var = node.get_data_value().Value
    val_el = Et.SubElement(el, 'Value')
    _value_to_etree(val_el, dtype_name, dtype, var.Value)


def _value_to_etree(el, dtype_name, dtype, val):
    if isinstance(val, (list, tuple)):
        list_el = Et.SubElement(el, "uax:ListOf" + dtype_name)
        for nval in val:
            _value_to_etree(list_el, dtype_name, dtype, nval)
    else:
        if dtype.Identifier is int and dtype.Identifier > 21:  # this is an extentionObject:
            _extobj_to_etree(el, dtype_name, dtype)
        else:
            val_el = Et.SubElement(el, "uax:" + dtype_name)
            val_el.text = str(val)


def _extobj_to_etree(val_el, dtype_name, dtype, val):
    obj_el = Et.SubElement(val_el, "uax:ExtensionObject")
    type_el = Et.SubElement(obj_el, "uax:TypeId")
    id_el = Et.SubElement(type_el, "uax:Identifier")
    id_el.text = val.TypeId.to_string()
    body_el = Et.SubElement(obj_el, "uax:Body")
    struct_el = Et.SubElement(body_el, "uax:" + dtype_name)
    # FIXME: finish
   

def indent(elem, level=0):
    '''
    copy and paste from http://effbot.org/zone/element-lib.htm#prettyprint
    it basically walks your tree and adds spaces and newlines so the tree is
    printed in a nice way
    '''
    i = "\n" + level*"  "
    if len(elem):
        if not elem.text or not elem.text.strip():
            elem.text = i + "  "
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
        for elem in elem:
            indent(elem, level+1)
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
    else:
        if level and (not elem.tail or not elem.tail.strip()):
            elem.tail = i


1			"""
2			from a list of nodes in the address space, build an XML file
3			format is the one from opc-ua specification
4			"""
5			import logging
6			from collections import OrderedDict
7			import xml.etree.ElementTree as Et
8
9			from opcua import ua
10			from opcua.ua import object_ids as o_ids
11
12
13			class XmlExporter(object):
14
15			def __init__(self, server):
16			self.logger = logging.getLogger(__name__)
17			self.server = server
18			self.aliases = {}
19
20			node_set_attributes = OrderedDict()
21			node_set_attributes['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
22			node_set_attributes['xmlns:uax'] = 'http://opcfoundation.org/UA/2008/02/Types.xsd'
23			node_set_attributes['xmlns:xsd'] = 'http://www.w3.org/2001/XMLSchema'
24			node_set_attributes['xmlns'] = 'http://opcfoundation.org/UA/2011/03/UANodeSet.xsd'
25
26			self.etree = Et.ElementTree(Et.Element('UANodeSet', node_set_attributes))
27
28			def build_etree(self, node_list, uris=None):
29			"""
30			Create an XML etree object from a list of nodes; custom namespace uris are optional
31			Args:
32			node_list: list of Node objects for export
33			uris: list of namespace uri strings
34
35			Returns:
36			"""
37			self.logger.info('Building XML etree')
38
39			# add all nodes in the list to the XML etree
40			for node in node_list:
41			self.node_to_etree(node)
42
43			# add aliases to the XML etree
44			self._add_alias_els()
45
46			if uris:
47			# add namespace uris to the XML etree
48			self._add_namespace_uri_els(uris)
49
50			def write_xml(self, xmlpath, pretty=True):
51			"""
52			Write the XML etree in the exporter object to a file
53			Args:
54			xmlpath: string representing the path/file name
55
56			Returns:
57			"""
58			# try to write the XML etree to a file
59			self.logger.info('Exporting XML file to %s', xmlpath)
60			#from IPython import embed
61			#embed()
62			if pretty:
63			indent(self.etree.getroot())
64			self.etree.write(xmlpath,
65			short_empty_elements=False,
66			encoding='utf-8',
67			xml_declaration=True
68			)
69			else:
70			self.etree.write(xmlpath,
71			short_empty_elements=False,
72			encoding='utf-8',
73			xml_declaration=True)
74
75			def dump_etree(self):
76			"""
77			Dump etree to console for debugging
78			Returns:
79			"""
80			self.logger.info('Dumping XML etree to console')
81			Et.dump(self.etree)
82
83			def node_to_etree(self, node):
84			"""
85			Add the necessary XML sub elements to the etree for exporting the node
86			Args:
87			node: Node object which will be added to XML etree
88
89			Returns:
90			"""
91			node_class = node.get_node_class()
92			print("Exporting: ", node)
93
94			if node_class is ua.NodeClass.Object:
95			self.add_etree_object(node)
96			elif node_class is ua.NodeClass.ObjectType:
97			self.add_etree_object_type(node)
98			elif node_class is ua.NodeClass.Variable:
99			self.add_etree_variable(node)
100			elif node_class is ua.NodeClass.VariableType:
101			self.add_etree_variable_type(node)
102			elif node_class is ua.NodeClass.ReferenceType:
103			self.add_etree_reference(node)
104			elif node_class is ua.NodeClass.DataType:
105			self.add_etree_datatype(node)
106			elif node_class is ua.NodeClass.Method:
107			self.add_etree_method(node)
108			else:
109			self.logger.info("Exporting node class not implemented: %s ", node_class)
110
111			def _add_sub_el(self, el, name, text):
112			child_el = Et.SubElement(el, name)
113			child_el.text = text
114			return child_el
115
116			def _add_node_common(self, nodetype, node):
117			browsename = node.get_browse_name().to_string()
118			nodeid = node.nodeid.to_string()
119			parent = node.get_parent()
120			displayname = node.get_display_name().Text.decode('utf-8')
121			desc = node.get_description().Text
122			print("NODE COMMON", node)
123			node_el = Et.SubElement(self.etree.getroot(),
124			nodetype,
125			BrowseName=browsename,
126			NodeId=nodeid)
127			if parent is not None:
128			node_el.attrib["ParentNodeId"] = parent.nodeid.to_string()
129			if desc not in (None, ""):
130			self._add_sub_el(node_el, 'Description', desc.decode('utf-8'))
131			self._add_sub_el(node_el, 'DisplayName', displayname)
132			return node_el
133
134			def add_etree_object(self, obj):
135			"""
136			Add a UA object element to the XML etree
137			"""
138			obj_el = self._add_node_common("UAObject", obj)
139			self._add_ref_els(obj_el, obj)
140
141			def add_etree_object_type(self, node):
142			"""
143			Add a UA object type element to the XML etree
144			"""
145			obj_el = self._add_node_common("UAObjectType", node)
146			abstract = node.get_attribute(ua.AttributeIds.IsAbstract).Value.Value
147			if abstract:
148			obj_el.attrib["IsAbstract"] = 'true'
149			self._add_ref_els(obj_el, node)
150
151			def add_variable_common(self, node, el):
152			dtype = node.get_data_type()
153			if dtype.Identifier in o_ids.ObjectIdNames:
154			dtype_name = o_ids.ObjectIdNames[dtype.Identifier]
155			self.aliases[dtype_name] = dtype.to_string()
156			else:
157			dtype_name = dtype.to_string()
158			rank = node.get_value_rank()
159			el.attrib["DataType"] = dtype_name
160			el.attrib["ValueRank"] = str(int(rank))
161			value_to_etree(el, dtype_name, dtype, node)
162
163			def add_etree_variable(self, node):
164			"""
165			Add a UA variable element to the XML etree
166			"""
167			var_el = self._add_node_common("UAVariable", node)
168			self.add_variable_common(node, var_el)
169
170			accesslevel = node.get_attribute(ua.AttributeIds.AccessLevel).Value.Value
171			useraccesslevel = node.get_attribute(ua.AttributeIds.UserAccessLevel).Value.Value
172
173			# We only write these values if they are different from defaults
174			# default must of course mange the one in manage_nodes.py
175			# and other OPC UA servers
176			if accesslevel != ua.AccessLevel.CurrentRead.mask:
177			var_el.attrib["AccessLevel"] = str(accesslevel)
178			if useraccesslevel != ua.AccessLevel.CurrentRead.mask:
179			var_el.attrib["UserAccessLevel"] = str(useraccesslevel)
180			self._add_ref_els(var_el, node)
181
182			def add_etree_variable_type(self, node):
183			"""
184			Add a UA variable type element to the XML etree
185			"""
186
187			var_el = self._add_node_common("UAVariable", node)
188			self.add_variable_common(node, var_el)
189
190			abstract = node.get_attribute(ua.AttributeIds.IsAbstract)
191			if abstract:
192			var_el.attrib["IsAbstract"] = abstract
193
194			self._add_ref_els(var_el, node)
195
196			def add_etree_method(self, obj):
197			obj_el = self._add_node_common("UAMethod", obj)
198			self._add_ref_els(obj_el, obj)
199
200			def add_etree_reference(self, obj):
201			obj_el = self._add_node_common("UAReference", obj)
202			self._add_ref_els(obj_el, obj)
203
204			def add_etree_datatype(self, obj):
205			"""
206			Add a UA data type element to the XML etree
207			"""
208			obj_el = self._add_node_common("UADataType", obj)
209			self._add_ref_els(obj_el, obj)
210
211			def _add_namespace_uri_els(self, uris):
212			nuris_el = Et.Element('NamespaceUris')
213
214			for uri in uris:
215			self._add_sub_el(nuris_el, 'Uri', uri)
216
217			self.etree.getroot().insert(0, nuris_el)
218
219			def _add_alias_els(self):
220			aliases_el = Et.Element('Aliases')
221
222			for k, v in self.aliases.items():
223			ref_el = Et.SubElement(aliases_el, 'Alias', Alias=k)
224			ref_el.text = v
225
226			self.etree.getroot().insert(0, aliases_el)
227
228			def _add_ref_els(self, parent_el, obj):
229			refs = obj.get_references()
230			refs_el = Et.SubElement(parent_el, 'References')
231
232			for ref in refs:
233			if ref.ReferenceTypeId.Identifier in o_ids.ObjectIdNames:
234			ref_name = o_ids.ObjectIdNames[ref.ReferenceTypeId.Identifier]
235			else:
236			ref_name = ref.ReferenceTypeId.to_string()
237			ref_el = Et.SubElement(refs_el, 'Reference', ReferenceType=ref_name)
238			if not ref.IsForward:
239			ref_el.attrib['IsForward'] = 'false'
240			ref_el.text = ref.NodeId.to_string()
241
242			# add any references that gets used to aliases dict; this gets handled later
243			self.aliases[ref_name] = ref.ReferenceTypeId.to_string()
244
245
246			def value_to_etree(el, dtype_name, dtype, node):
247			var = node.get_data_value().Value
248			val_el = Et.SubElement(el, 'Value')
249			_value_to_etree(val_el, dtype_name, dtype, var.Value)
250
251
252			def _value_to_etree(el, dtype_name, dtype, val):
253			if isinstance(val, (list, tuple)):
254			list_el = Et.SubElement(el, "uax:ListOf" + dtype_name)
255			for nval in val:
256			_value_to_etree(list_el, dtype_name, dtype, nval)
257			else:
258			if dtype.Identifier is int and dtype.Identifier > 21: # this is an extentionObject:
259			_extobj_to_etree(el, dtype_name, dtype)
260			else:
261			val_el = Et.SubElement(el, "uax:" + dtype_name)
262			val_el.text = str(val)
263
264
265			def _extobj_to_etree(val_el, dtype_name, dtype, val):
266			obj_el = Et.SubElement(val_el, "uax:ExtensionObject")
267			type_el = Et.SubElement(obj_el, "uax:TypeId")
268			id_el = Et.SubElement(type_el, "uax:Identifier")
269			id_el.text = val.TypeId.to_string()
270			body_el = Et.SubElement(obj_el, "uax:Body")
271			struct_el = Et.SubElement(body_el, "uax:" + dtype_name)
272			# FIXME: finish
273
274
275			def indent(elem, level=0):
276			'''
277			copy and paste from http://effbot.org/zone/element-lib.htm#prettyprint
278			it basically walks your tree and adds spaces and newlines so the tree is
279			printed in a nice way
280			'''
281			i = "\n" + level*" "
282			if len(elem):
283			if not elem.text or not elem.text.strip():
284			elem.text = i + " "
285			if not elem.tail or not elem.tail.strip():
286			elem.tail = i
287			for elem in elem:
288			indent(elem, level+1)
289			if not elem.tail or not elem.tail.strip():
290			elem.tail = i
291			else:
292			if level and (not elem.tail or not elem.tail.strip()):
293			elem.tail = i
294

FreeOpcUa / python-opcua

Push — master ( 8f029f...e8ef15 )

XmlExporter.write_xml() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like