XmlExporter.node_to_etree() - Code Metrics - Inspection of "fix importing unknown reference type" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 33fbe2...77cc72 )

by Olivier

created 2016-08-21 19:34 UTC

XmlExporter.node_to_etree() D

↳ Parent: XmlExporter

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	8
dl	0
loc	27
rs	4
c	2
b	0
f	0

"""
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 xml.dom import minidom

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 all required aliases to the XML etree; must be done after nodes are added
        self._add_alias_els()

        if uris:
            # add all namespace uris to the XML etree; must be done after aliases are added
            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:
            self.etree.write(xmlpath + "-not-pretty.xml", short_empty_elements=False)
            rough_string = Et.tostring(self.etree.getroot(), 'utf-8')
            reparsed = minidom.parseString(rough_string)
            pretty_string = reparsed.toprettyxml(indent="    ")
            with open(xmlpath, "wt") as f:
                f.write(pretty_string)
        else:
            self.etree.write(xmlpath, short_empty_elements=False)

    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_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(encoding='UTF8')
        desc = node.get_description().Text
        if desc is None:
            desc = ""
        print("NODE COMMON", node, desc)
        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, ""):
            node_el.attrib["Description"] = desc
        disp_el = Et.SubElement(node_el, 'DisplayName', )
        disp_el.text = 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
        obj_el.attrib["IsAbstract"] = abstract
        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:
            datatype = o_ids.ObjectIdNames[dtype.Identifier]
            self.aliases[datatype] = dtype.to_string()
        else:
            datatype = dtype.to_string()
        rank = node.get_value_rank()
        value = str(node.get_value())
        print("VAR COMMON", node, rank, value, datatype)

        el.attrib["DataType"] = datatype
        el.attrib["ValueRank"] = str(rank)
        val_el = Et.SubElement(el, 'Value')
        valx_el = Et.SubElement(val_el, 'uax:' + datatype)
        valx_el.text = value

    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)
        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:
            uri_el = Et.SubElement(nuris_el, 'Uri')
            uri_el.text = 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_forward = str(ref.IsForward).lower()
            ref_nodeid = ref.NodeId.to_string()
            ref_el = Et.SubElement(refs_el, 'Reference', IsForward=ref_forward, ReferenceType=ref_name)
            ref_el.text = ref_nodeid

            # add any references that gets used to aliases dict; this gets handled later
            self.aliases[ref_name] = ref_nodeid


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			from xml.dom import minidom
9
10			from opcua import ua
11			from opcua.ua import object_ids as o_ids
12
13
14			class XmlExporter(object):
15
16			def __init__(self, server):
17			self.logger = logging.getLogger(__name__)
18			self.server = server
19			self.aliases = {}
20
21			node_set_attributes = OrderedDict()
22			node_set_attributes['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
23			node_set_attributes['xmlns:uax'] = 'http://opcfoundation.org/UA/2008/02/Types.xsd'
24			node_set_attributes['xmlns:xsd'] = 'http://www.w3.org/2001/XMLSchema'
25			node_set_attributes['xmlns'] = 'http://opcfoundation.org/UA/2011/03/UANodeSet.xsd'
26
27			self.etree = Et.ElementTree(Et.Element('UANodeSet', node_set_attributes))
28
29			def build_etree(self, node_list, uris=None):
30			"""
31			Create an XML etree object from a list of nodes; custom namespace uris are optional
32			Args:
33			node_list: list of Node objects for export
34			uris: list of namespace uri strings
35
36			Returns:
37			"""
38			self.logger.info('Building XML etree')
39
40			# add all nodes in the list to the XML etree
41			for node in node_list:
42			self.node_to_etree(node)
43
44			# add all required aliases to the XML etree; must be done after nodes are added
45			self._add_alias_els()
46
47			if uris:
48			# add all namespace uris to the XML etree; must be done after aliases are added
49			self._add_namespace_uri_els(uris)
50
51			def write_xml(self, xmlpath, pretty=True):
52			"""
53			Write the XML etree in the exporter object to a file
54			Args:
55			xmlpath: string representing the path/file name
56
57			Returns:
58			"""
59			# try to write the XML etree to a file
60			self.logger.info('Exporting XML file to %s', xmlpath)
61			#from IPython import embed
62			#embed()
63			if pretty:
64			self.etree.write(xmlpath + "-not-pretty.xml", short_empty_elements=False)
65			rough_string = Et.tostring(self.etree.getroot(), 'utf-8')
66			reparsed = minidom.parseString(rough_string)
67			pretty_string = reparsed.toprettyxml(indent=" ")
68			with open(xmlpath, "wt") as f:
69			f.write(pretty_string)
70			else:
71			self.etree.write(xmlpath, short_empty_elements=False)
72
73			def dump_etree(self):
74			"""
75			Dump etree to console for debugging
76			Returns:
77			"""
78			self.logger.info('Dumping XML etree to console')
79			Et.dump(self.etree)
80
81			def node_to_etree(self, node):
82			"""
83			Add the necessary XML sub elements to the etree for exporting the node
84			Args:
85			node: Node object which will be added to XML etree
86
87			Returns:
88			"""
89			node_class = node.get_node_class()
90			print("Exporting: ", node)
91
92			if node_class is ua.NodeClass.Object:
93			self.add_etree_object(node)
94			elif node_class is ua.NodeClass.ObjectType:
95			self.add_etree_object_type(node)
96			elif node_class is ua.NodeClass.Variable:
97			self.add_etree_variable(node)
98			elif node_class is ua.NodeClass.VariableType:
99			self.add_etree_variable_type(node)
100			elif node_class is ua.NodeClass.ReferenceType:
101			self.add_etree_reference(node)
102			elif node_class is ua.NodeClass.DataType:
103			self.add_etree_datatype(node)
104			elif node_class is ua.NodeClass.Method:
105			self.add_etree_method(node)
106			else:
107			self.logger.info("Exporting node class not implemented: %s ", node_class)
108
109			def _add_node_common(self, nodetype, node):
110			browsename = node.get_browse_name().to_string()
111			nodeid = node.nodeid.to_string()
112			parent = node.get_parent()
113			displayname = node.get_display_name().Text.decode(encoding='UTF8')
114			desc = node.get_description().Text
115			if desc is None:
116			desc = ""
117			print("NODE COMMON", node, desc)
118			node_el = Et.SubElement(self.etree.getroot(),
119			nodetype,
120			BrowseName=browsename,
121			NodeId=nodeid)
122			if parent is not None:
123			node_el.attrib["ParentNodeId"] = parent.nodeid.to_string()
124			if desc not in (None, ""):
125			node_el.attrib["Description"] = desc
126			disp_el = Et.SubElement(node_el, 'DisplayName', )
127			disp_el.text = displayname
128			return node_el
129
130			def add_etree_object(self, obj):
131			"""
132			Add a UA object element to the XML etree
133			"""
134			obj_el = self._add_node_common("UAObject", obj)
135			self._add_ref_els(obj_el, obj)
136
137			def add_etree_object_type(self, node):
138			"""
139			Add a UA object type element to the XML etree
140			"""
141			obj_el = self._add_node_common("UAObjectType", node)
142			abstract = node.get_attribute(ua.AttributeIds.IsAbstract).Value.Value
143			obj_el.attrib["IsAbstract"] = abstract
144			self._add_ref_els(obj_el, node)
145
146			def add_variable_common(self, node, el):
147			dtype = node.get_data_type()
148			if dtype.Identifier in o_ids.ObjectIdNames:
149			datatype = o_ids.ObjectIdNames[dtype.Identifier]
150			self.aliases[datatype] = dtype.to_string()
151			else:
152			datatype = dtype.to_string()
153			rank = node.get_value_rank()
154			value = str(node.get_value())
155			print("VAR COMMON", node, rank, value, datatype)
156
157			el.attrib["DataType"] = datatype
158			el.attrib["ValueRank"] = str(rank)
159			val_el = Et.SubElement(el, 'Value')
160			valx_el = Et.SubElement(val_el, 'uax:' + datatype)
161			valx_el.text = value
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			var_el.attrib["IsAbstract"] = abstract
192
193			self._add_ref_els(var_el, node)
194
195			def add_etree_method(self, obj):
196			obj_el = self._add_node_common("UAMethod", obj)
197			self._add_ref_els(obj_el, obj)
198
199			def add_etree_reference(self, obj):
200			obj_el = self._add_node_common("UAReference", obj)
201			self._add_ref_els(obj_el, obj)
202
203			def add_etree_datatype(self, obj):
204			"""
205			Add a UA data type element to the XML etree
206			"""
207			obj_el = self._add_node_common("UADataType", obj)
208			self._add_ref_els(obj_el, obj)
209
210			def _add_namespace_uri_els(self, uris):
211			nuris_el = Et.Element('NamespaceUris')
212
213			for uri in uris:
214			uri_el = Et.SubElement(nuris_el, 'Uri')
215			uri_el.text = 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_forward = str(ref.IsForward).lower()
238			ref_nodeid = ref.NodeId.to_string()
239			ref_el = Et.SubElement(refs_el, 'Reference', IsForward=ref_forward, ReferenceType=ref_name)
240			ref_el.text = ref_nodeid
241
242			# add any references that gets used to aliases dict; this gets handled later
243			self.aliases[ref_name] = ref_nodeid
244

FreeOpcUa / python-opcua

Push — master ( 33fbe2...77cc72 )

XmlExporter.node_to_etree() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like