Test Failed
Pull Request — master (#490)
by Olivier
02:59
created

XmlExporter._val_to_etree()   F

Complexity

Conditions 11

Size

Total Lines 24

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 20
CRAP Score 11

Importance

Changes 2
Bugs 1 Features 0
Metric Value
cc 11
c 2
b 1
f 0
dl 0
loc 24
ccs 20
cts 20
cp 1
crap 11
rs 3.3409

How to fix   Complexity   

Complexity

Complex classes like XmlExporter._val_to_etree() often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

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 1
import logging
6 1
from collections import OrderedDict
7 1
import xml.etree.ElementTree as Et
8 1
from copy import copy
9
import base64
10 1
11 1
from opcua import ua
12 1
from opcua.ua import object_ids as o_ids
13
from opcua.common.ua_utils import get_base_data_type
14
15 1
16
class XmlExporter(object):
17
18
    ''' If it is required that for _extobj_to_etree members to the value should be written in a certain
19
        order it can be added to the dictionary below.    
20 1
    '''
21
    extobj_ordered_elements = {
22
        ua.NodeId(ua.ObjectIds.Argument) : ['Name',
23
                                            'DataType',
24
                                            'ValueRank',
25
                                            'ArrayDimensions',
26
                                            'Description']
27
        }
28 1
29 1
    def __init__(self, server):
30 1
        self.logger = logging.getLogger(__name__)
31 1
        self.server = server
32 1
        self.aliases = {}
33
        self._addr_idx_to_xml_idx = {}
34 1
35 1
        node_set_attributes = OrderedDict()
36 1
        node_set_attributes['xmlns:xsi'] = 'http://www.w3.org/2001/XMLSchema-instance'
37 1
        node_set_attributes['xmlns:uax'] = 'http://opcfoundation.org/UA/2008/02/Types.xsd'
38 1
        node_set_attributes['xmlns:xsd'] = 'http://www.w3.org/2001/XMLSchema'
39
        node_set_attributes['xmlns'] = 'http://opcfoundation.org/UA/2011/03/UANodeSet.xsd'
40 1
41
        self.etree = Et.ElementTree(Et.Element('UANodeSet', node_set_attributes))
42 1
43
    def build_etree(self, node_list, uris=None):
44
        """
45
        Create an XML etree object from a list of nodes; custom namespace uris are optional
46
        Namespaces used by nodes are always exported for consistency.
47
        Args:
48
            node_list: list of Node objects for export
49
            uris: list of namespace uri strings
50
51
        Returns:
52 1
        """
53
        self.logger.info('Building XML etree')
54 1
55
        self._add_namespaces(node_list, uris)
56
57 1
        # add all nodes in the list to the XML etree
58 1
        for node in node_list:
59
            self.node_to_etree(node)
60
61 1
        # add aliases to the XML etree
62
        self._add_alias_els()
63 1
64 1
    def _add_namespaces(self, nodes, uris):
65
        idxs = self._get_ns_idxs_of_nodes(nodes)
66 1
67
        ns_array = self.server.get_namespace_array()
68
69 1
        # now add index of provided uris if necessary
70
        if uris:
71
            self._add_idxs_from_uris(idxs, uris, ns_array)
72
73 1
        # now create a dict of idx_in_address_space to idx_in_exported_file
74 1
        self._addr_idx_to_xml_idx = self._make_idx_dict(idxs, ns_array)
75
        ns_to_export = [ns_array[i] for i in sorted(list(self._addr_idx_to_xml_idx.keys())) if i != 0]
76
77 1
        # write namespaces to xml
78
        self._add_namespace_uri_els(ns_to_export)
79 1
80 1
    def _make_idx_dict(self, idxs, ns_array):
81 1
        idxs.sort()
82 1
        addr_idx_to_xml_idx = {0: 0}
83 1
        for xml_idx, addr_idx in enumerate(idxs):
84 1
            if addr_idx >= len(ns_array):
85 1
                break
86 1
            addr_idx_to_xml_idx[addr_idx] = xml_idx + 1
87
        return addr_idx_to_xml_idx
88 1
89
    def _get_ns_idxs_of_nodes(self, nodes):
90
        """
91
        get a list of all indexes used or references by nodes
92 1
        """
93 1
        idxs = []
94 1
        for node in nodes:
95 1
            node_idxs = [node.nodeid.NamespaceIndex]
96 1
            node_idxs.append(node.get_browse_name().NamespaceIndex)
97 1
            node_idxs.extend(ref.NodeId.NamespaceIndex for ref in node.get_references())
98 1
            node_idxs = list(set(node_idxs))  # remove duplicates
99 1
            for i in node_idxs:
100 1
                if i != 0 and i not in idxs:
101 1
                    idxs.append(i)
102
        return idxs
103 1
104
    def _add_idxs_from_uris(self, idxs, uris, ns_array):
105
        for uri in uris:
106
            if uri in ns_array:
107
                i = ns_array.index(uri)
108
                if i not in idxs:
109
                    idxs.append(i)
110
111 1
112
    def write_xml(self, xmlpath, pretty=True):
113
        """
114
        Write the XML etree in the exporter object to a file
115
        Args:
116
            xmlpath: string representing the path/file name
117
118
        Returns:
119
        """
120 1
        # try to write the XML etree to a file
121
        self.logger.info('Exporting XML file to %s', xmlpath)
122
        # from IPython import embed
123 1
        # embed()
124 1
        if pretty:
125 1
            self.indent(self.etree.getroot())
126
            self.etree.write(xmlpath,
127
                             encoding='utf-8',
128
                             xml_declaration=True
129
                            )
130
        else:
131
            self.etree.write(xmlpath,
132
                             encoding='utf-8',
133
                             xml_declaration=True
134
                            )
135 1
136
    def dump_etree(self):
137
        """
138
        Dump etree to console for debugging
139
        Returns:
140
        """
141
        self.logger.info('Dumping XML etree to console')
142
        Et.dump(self.etree)
143 1
144
    def node_to_etree(self, node):
145
        """
146
        Add the necessary XML sub elements to the etree for exporting the node
147
        Args:
148
            node: Node object which will be added to XML etree
149
150
        Returns:
151 1
        """
152
        node_class = node.get_node_class()
153 1
154 1
        if node_class is ua.NodeClass.Object:
155 1
            self.add_etree_object(node)
156
        elif node_class is ua.NodeClass.ObjectType:
157 1
            self.add_etree_object_type(node)
158 1
        elif node_class is ua.NodeClass.Variable:
159 1
            self.add_etree_variable(node)
160
        elif node_class is ua.NodeClass.VariableType:
161 1
            self.add_etree_variable_type(node)
162
        elif node_class is ua.NodeClass.ReferenceType:
163 1
            self.add_etree_reference_type(node)
164
        elif node_class is ua.NodeClass.DataType:
165 1
            self.add_etree_datatype(node)
166 1
        elif node_class is ua.NodeClass.Method:
167
            self.add_etree_method(node)
168
        else:
169
            self.logger.info("Exporting node class not implemented: %s ", node_class)
170 1
171 1
    def _add_sub_el(self, el, name, text):
172 1
        child_el = Et.SubElement(el, name)
173 1
        child_el.text = text
174
        return child_el
175 1
176 1
    def _node_to_string(self, nodeid):
177 1
        if not isinstance(nodeid, ua.NodeId):
178
            nodeid = nodeid.nodeid
179 1
180 1
        if nodeid.NamespaceIndex in self._addr_idx_to_xml_idx:
181 1
            nodeid = copy(nodeid)
182 1
            nodeid.NamespaceIndex = self._addr_idx_to_xml_idx[nodeid.NamespaceIndex]
183
        return nodeid.to_string()
184 1
185 1
    def _bname_to_string(self, bname):
186 1
        if bname.NamespaceIndex in self._addr_idx_to_xml_idx:
187 1
            bname = copy(bname)
188 1
            bname.NamespaceIndex = self._addr_idx_to_xml_idx[bname.NamespaceIndex]
189
        return bname.to_string()
190 1
191 1
    def _add_node_common(self, nodetype, node):
192 1
        browsename = node.get_browse_name()
193 1
        nodeid = node.nodeid
194 1
        parent = node.get_parent()
195 1
        displayname = node.get_display_name().Text
196 1
        desc = node.get_description().Text
197 1
        node_el = Et.SubElement(self.etree.getroot(), nodetype)
198 1
        node_el.attrib["NodeId"] = self._node_to_string(nodeid)
199 1
        node_el.attrib["BrowseName"] = self._bname_to_string(browsename)
200 1
        if parent is not None:
201 1
            node_class = node.get_node_class()
202 1
            if node_class in (ua.NodeClass.Object, ua.NodeClass.Variable, ua.NodeClass.Method):
203 1
                node_el.attrib["ParentNodeId"] = self._node_to_string(parent)
204 1
        self._add_sub_el(node_el, 'DisplayName', displayname)
205 1
        if desc not in (None, ""):
206
            self._add_sub_el(node_el, 'Description', desc)
207 1
        # FIXME: add WriteMask and UserWriteMask
208
        return node_el
209 1
210
    def add_etree_object(self, node):
211
        """
212
        Add a UA object element to the XML etree
213 1
        """
214 1
        obj_el = self._add_node_common("UAObject", node)
215 1
        var = node.get_attribute(ua.AttributeIds.EventNotifier)
216
        if var.Value.Value != 0:
217 1
            obj_el.attrib["EventNotifier"] = str(var.Value.Value)
218
        self._add_ref_els(obj_el, node)
219 1
220
    def add_etree_object_type(self, node):
221
        """
222
        Add a UA object type element to the XML etree
223
        """
224
        obj_el = self._add_node_common("UAObjectType", node)
225
        abstract = node.get_attribute(ua.AttributeIds.IsAbstract).Value.Value
226
        if abstract:
227
            obj_el.attrib["IsAbstract"] = 'true'
228
        self._add_ref_els(obj_el, node)
229 1
230 1
    def add_variable_common(self, node, el):
231 1
        dtype = node.get_data_type()
232 1
        if dtype.NamespaceIndex == 0 and dtype.Identifier in o_ids.ObjectIdNames:
233 1
            dtype_name = o_ids.ObjectIdNames[dtype.Identifier]
234
            self.aliases[dtype] = dtype_name
235 1
        else:
236 1
            dtype_name = dtype.to_string()
237 1
        rank = node.get_value_rank()
238 1
        if rank != -1:
239 1
            el.attrib["ValueRank"] = str(int(rank))
240 1
        dim = node.get_attribute(ua.AttributeIds.ArrayDimensions)
241 1
        if dim.Value.Value:
242 1
            el.attrib["ArrayDimensions"] = ",".join([str(i) for i in dim.Value.Value])
243 1
        el.attrib["DataType"] = dtype_name
244
        self.value_to_etree(el, dtype_name, dtype, node)
245 1
246
    def add_etree_variable(self, node):
247
        """
248
        Add a UA variable element to the XML etree
249 1
        """
250 1
        var_el = self._add_node_common("UAVariable", node)
251 1
        self._add_ref_els(var_el, node)
252
        self.add_variable_common(node, var_el)
253 1
254 1
        accesslevel = node.get_attribute(ua.AttributeIds.AccessLevel).Value.Value
255
        useraccesslevel = node.get_attribute(ua.AttributeIds.UserAccessLevel).Value.Value
256
257
        # We only write these values if they are different from defaults
258 1
        # Not sure where default is defined....
259
        if accesslevel not in (0, ua.AccessLevel.CurrentRead.mask):
260 1
            var_el.attrib["AccessLevel"] = str(accesslevel)
261
        if useraccesslevel not in (0, ua.AccessLevel.CurrentRead.mask):
262
            var_el.attrib["UserAccessLevel"] = str(useraccesslevel)
263 1
264 1
        var = node.get_attribute(ua.AttributeIds.MinimumSamplingInterval)
265
        if var.Value.Value:
266 1
            var_el.attrib["MinimumSamplingInterval"] = str(var.Value.Value)
267 1
        var = node.get_attribute(ua.AttributeIds.Historizing)
268
        if var.Value.Value:
269
            var_el.attrib["Historizing"] = 'true'
270 1
271
    def add_etree_variable_type(self, node):
272
        """
273
        Add a UA variable type element to the XML etree
274
        """
275
276
        var_el = self._add_node_common("UAVariableType", node)
277
        self.add_variable_common(node, var_el)
278
279
        abstract = node.get_attribute(ua.AttributeIds.IsAbstract)
280
        if abstract.Value.Value:
281
            var_el.attrib["IsAbstract"] = "true"
282
283
        self._add_ref_els(var_el, node)
284 1
285 1
    def add_etree_method(self, node):
286
        obj_el = self._add_node_common("UAMethod", node)
287 1
288 1
        var = node.get_attribute(ua.AttributeIds.Executable)
289
        if var.Value.Value is False:
290 1
            obj_el.attrib["Executable"] = "false"
291 1
        var = node.get_attribute(ua.AttributeIds.UserExecutable)
292
        if var.Value.Value is False:
293 1
            obj_el.attrib["UserExecutable"] = "false"
294
        self._add_ref_els(obj_el, node)
295 1
296
    def add_etree_reference_type(self, obj):
297
        obj_el = self._add_node_common("UAReferenceType", obj)
298
        self._add_ref_els(obj_el, obj)
299
        var = obj.get_attribute(ua.AttributeIds.InverseName)
300
        if var is not None and var.Value.Value is not None and var.Value.Value.Text is not None:
301
            self._add_sub_el(obj_el, 'InverseName', var.Value.Value.Text)
302 1
303
    def add_etree_datatype(self, obj):
304
        """
305
        Add a UA data type element to the XML etree
306
        """
307
        obj_el = self._add_node_common("UADataType", obj)
308
        self._add_ref_els(obj_el, obj)
309 1
310 1
    def _add_namespace_uri_els(self, uris):
311
        nuris_el = Et.Element('NamespaceUris')
312 1
313 1
        for uri in uris:
314
            self._add_sub_el(nuris_el, 'Uri', uri)
315 1
316
        self.etree.getroot().insert(0, nuris_el)
317 1
318 1
    def _add_alias_els(self):
319
        aliases_el = Et.Element('Aliases')
320 1
321 1
        ordered_keys = list(self.aliases.keys())
322 1
        ordered_keys.sort()
323 1
        for nodeid in ordered_keys:
324 1
            name = self.aliases[nodeid]
325 1
            ref_el = Et.SubElement(aliases_el, 'Alias', Alias=name)
326
            ref_el.text = nodeid.to_string()
327
328 1
        # insert behind the namespace element
329
        self.etree.getroot().insert(1, aliases_el)
330 1
331 1
    def _add_ref_els(self, parent_el, obj):
332 1
        refs = obj.get_references()
333
        refs_el = Et.SubElement(parent_el, 'References')
334 1
335 1
        for ref in refs:
336 1
            if ref.ReferenceTypeId.Identifier in o_ids.ObjectIdNames:
337
                ref_name = o_ids.ObjectIdNames[ref.ReferenceTypeId.Identifier]
338
            else:
339 1
                ref_name = ref.ReferenceTypeId.to_string()
340 1
            ref_el = Et.SubElement(refs_el, 'Reference')
341 1
            ref_el.attrib['ReferenceType'] = ref_name
342 1
            if not ref.IsForward:
343 1
                ref_el.attrib['IsForward'] = 'false'
344
            ref_el.text = self._node_to_string(ref.NodeId)
345 1
346
            self.aliases[ref.ReferenceTypeId] = ref_name
347
348 1
349 1
    def member_to_etree(self, el, name, dtype, val):
350 1
        member_el = Et.SubElement(el, "uax:" + name)
351 1
        if isinstance(val, (list, tuple)):
352 1
            for v in val:
353
                self._value_to_etree(member_el, ua.ObjectIdNames[dtype.Identifier], dtype, v)
354 1
        else:
355
            self._val_to_etree(member_el, dtype, val)
356
357 1
358 1
    def _val_to_etree(self, el, dtype, val):
359 1
        if dtype == ua.NodeId(ua.ObjectIds.NodeId):
360 1
            id_el = Et.SubElement(el, "uax:Identifier")
361 1
            id_el.text = val.to_string()
362 1
        elif dtype == ua.NodeId(ua.ObjectIds.Guid):
363 1
            id_el = Et.SubElement(el, "uax:String")
364 1
            id_el.text = str(val)
365 1
        elif dtype == ua.NodeId(ua.ObjectIds.Boolean):
366 1
            el.text = 'true' if val else 'false'
367 1
        elif dtype == ua.NodeId(ua.ObjectIds.ByteString):
368 1
            if val is None:
369 1
                val = b""
370 1
            data = base64.b64encode(val)
371
            el.text = data.decode("utf-8")
372 1
        elif not hasattr(val, "ua_types"):
373
            if isinstance(val, bytes):
374 1
                # FIXME: should we also encode this (localized text I guess) using base64??
375 1
                el.text = val.decode("utf-8")
376
            else:
377
                if val is not None:
378 1
                    el.text = str(val)
379 1
        else:
380 1
            for name, vtype in val.ua_types.items():
381 1
                self.member_to_etree(el, name, ua.NodeId(getattr(ua.ObjectIds, vtype)), getattr(val, name))
382 1
383
384
    def value_to_etree(self, el, dtype_name, dtype, node):
385 1
        var = node.get_data_value().Value
386 1
        if var.Value is not None:
387
            val_el = Et.SubElement(el, 'Value')
388
            self._value_to_etree(val_el, dtype_name, dtype, var.Value)
389 1
390 1
391 1
    def _value_to_etree(self, el, type_name, dtype, val):
392
        if val is None:
393 1
            return
394
395 1
        if isinstance(val, (list, tuple)):
396 1
            if dtype.NamespaceIndex == 0 and dtype.Identifier <= 21:
397 1
                elname = "uax:ListOf" + type_name
398
            else:  # this is an extentionObject:
399 1
                elname = "uax:ListOfExtensionObject"
400 1
401
            list_el = Et.SubElement(el, elname)
402 1
            for nval in val:
403 1
                self._value_to_etree(list_el, type_name, dtype, nval)
404 1
        else:
405
            dtype_base = get_base_data_type(self.server.get_node(dtype))
406 1
            dtype_base = dtype_base.nodeid
407 1
408 1
            if dtype_base == ua.NodeId(ua.ObjectIds.Enumeration):
409 1
                dtype_base = ua.NodeId(ua.ObjectIds.Int32)
410
                type_name = ua.ObjectIdNames[dtype_base.Identifier]
411 1
412
            if dtype_base.NamespaceIndex == 0 and dtype_base.Identifier <= 21:
413
                type_name = ua.ObjectIdNames[dtype_base.Identifier]
414 1
                val_el = Et.SubElement(el, "uax:" + type_name)
415 1
                self._val_to_etree(val_el, dtype_base, val)
416 1
            else:
417 1
                self._extobj_to_etree(el, type_name, dtype, val)
418 1
419 1
420 1
    def _extobj_to_etree(self, val_el, name, dtype, val):
421 1
        obj_el = Et.SubElement(val_el, "uax:ExtensionObject")
422 1
        type_el = Et.SubElement(obj_el, "uax:TypeId")
423
        id_el = Et.SubElement(type_el, "uax:Identifier")
424 1
        id_el.text = dtype.to_string()
425
        body_el = Et.SubElement(obj_el, "uax:Body")
426
        struct_el = Et.SubElement(body_el, "uax:" + name)
427
        for name in self._get_member_order(dtype, val):
428
            self.member_to_etree(struct_el, name, ua.NodeId(getattr(ua.ObjectIds, val.ua_types[name])), getattr(val, name))
429 1
430
    def _get_member_order(self, dtype, val):
431
        '''
432 1
        If an dtype has an entry in XmlExporter.extobj_ordered_elements return the export order of the elements 
433
        else return the unordered members.
434 1
        '''
435
        if dtype not in XmlExporter.extobj_ordered_elements.keys():
436 1
            return val.ua_types.keys()
437
        else:
438
            member_keys = [name for name in XmlExporter.extobj_ordered_elements[dtype] if name in val.ua_types.keys() and getattr(val, name) is not None ]
439
440
        return member_keys
441
442 1
    def indent(self, elem, level=0):
443 1
        """
444 1
        copy and paste from http://effbot.org/zone/element-lib.htm#prettyprint
445 1
        it basically walks your tree and adds spaces and newlines so the tree is
446 1
        printed in a nice way
447 1
        """
448 1
        i = "\n" + level * "  "
449 1
        if len(elem):
450 1
            if not elem.text or not elem.text.strip():
451 1
                elem.text = i + "  "
452
            if not elem.tail or not elem.tail.strip():
453 1
                elem.tail = i
454 1
            for elem in elem:
455
                self.indent(elem, level + 1)
456
            if not elem.tail or not elem.tail.strip():
457
                elem.tail = i
458
        else:
459
            if level and (not elem.tail or not elem.tail.strip()):
460
                elem.tail = i
461