XmlExporter._get_member_order() - Code Metrics - Inspection of "[XmlExporter] possibility to provide an order for..." - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 71c8c6...645104 )

by Olivier

created 2016-12-08 08:02 UTC

XmlExporter._get_member_order() B

↳ Parent: XmlExporter

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	5.2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
c	1
b	0
f	0
dl	0
loc	11
ccs	4
cts	5
cp	0.8
crap	5.2
rs	8.5454

"""
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 copy import copy

from opcua import ua
from opcua.ua import object_ids as o_ids
from opcua.common.ua_utils import get_base_data_type


class XmlExporter(object):

    ''' If it is required that for _extobj_to_etree members to the value should be written in a certain
        order it can be added to the dictionary below.    
    '''
    extobj_ordered_elements = {
        ua.NodeId(ua.ObjectIds.Argument) : ['Name',
                                            'DataType',
                                            'ValueRank',
                                            'ArrayDimensions',
                                            'Description']
        }

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

        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
        Namespaces used by nodes are always exported for consistency.
        Args:
            node_list: list of Node objects for export
            uris: list of namespace uri strings

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

        self._add_namespaces(node_list, uris)

        # 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()

    def _add_namespaces(self, nodes, uris):
        idxs = self._get_ns_idxs_of_nodes(nodes)

        ns_array = self.server.get_namespace_array()

        # now add index of provided uris if necessary
        if uris:
            self._add_idxs_from_uris(idxs, uris, ns_array)

        # now create a dict of idx_in_address_space to idx_in_exported_file
        self._addr_idx_to_xml_idx = self._make_idx_dict(idxs, ns_array)
        ns_to_export = [ns_array[i] for i in sorted(list(self._addr_idx_to_xml_idx.keys())) if i != 0]

        # write namespaces to xml
        self._add_namespace_uri_els(ns_to_export)

    def _make_idx_dict(self, idxs, ns_array):
        idxs.sort()
        addr_idx_to_xml_idx = {0: 0}
        for xml_idx, addr_idx in enumerate(idxs):
            if addr_idx >= len(ns_array):
                break
            addr_idx_to_xml_idx[addr_idx] = xml_idx + 1
        return addr_idx_to_xml_idx

    def _get_ns_idxs_of_nodes(self, nodes):
        """
        get a list of all indexes used or references by nodes
        """
        idxs = []
        for node in nodes:
            node_idxs = [node.nodeid.NamespaceIndex]
            node_idxs.append(node.get_browse_name().NamespaceIndex)
            node_idxs.extend(ref.NodeId.NamespaceIndex for ref in node.get_references())
            node_idxs = list(set(node_idxs))  # remove duplicates
            for i in node_idxs:
                if i != 0 and i not in idxs:
                    idxs.append(i)
        return idxs

    def _add_idxs_from_uris(self, idxs, uris, ns_array):
        for uri in uris:
            if uri in ns_array:
                i = ns_array.index(uri)
                if i not in idxs:
                    idxs.append(i)


    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.indent(self.etree.getroot())
            self.etree.write(xmlpath,
                             encoding='utf-8',
                             xml_declaration=True
                            )
        else:
            self.etree.write(xmlpath,
                             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()

        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_type(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 _node_to_string(self, nodeid):
        if not isinstance(nodeid, ua.NodeId):
            nodeid = nodeid.nodeid

        if nodeid.NamespaceIndex in self._addr_idx_to_xml_idx:
            nodeid = copy(nodeid)
            nodeid.NamespaceIndex = self._addr_idx_to_xml_idx[nodeid.NamespaceIndex]
        return nodeid.to_string()

    def _bname_to_string(self, bname):
        if bname.NamespaceIndex in self._addr_idx_to_xml_idx:
            bname = copy(bname)
            bname.NamespaceIndex = self._addr_idx_to_xml_idx[bname.NamespaceIndex]
        return bname.to_string()

    def _add_node_common(self, nodetype, node):
        browsename = node.get_browse_name()
        nodeid = node.nodeid
        parent = node.get_parent()
        displayname = node.get_display_name().Text.decode('utf-8')
        desc = node.get_description().Text
        node_el = Et.SubElement(self.etree.getroot(), nodetype)
        node_el.attrib["NodeId"] = self._node_to_string(nodeid)
        node_el.attrib["BrowseName"] = self._bname_to_string(browsename)
        if parent is not None:
            node_class = node.get_node_class()
            if node_class in (ua.NodeClass.Object, ua.NodeClass.Variable, ua.NodeClass.Method):
                node_el.attrib["ParentNodeId"] = self._node_to_string(parent)
        self._add_sub_el(node_el, 'DisplayName', displayname)
        if desc not in (None, ""):
            self._add_sub_el(node_el, 'Description', desc.decode('utf-8'))
        # FIXME: add WriteMask and UserWriteMask
        return node_el

    def add_etree_object(self, node):
        """
        Add a UA object element to the XML etree
        """
        obj_el = self._add_node_common("UAObject", node)
        var = node.get_attribute(ua.AttributeIds.EventNotifier)
        if var.Value.Value != 0:
            obj_el.attrib["EventNotifier"] = str(var.Value.Value)
        self._add_ref_els(obj_el, node)

    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.NamespaceIndex == 0 and dtype.Identifier in o_ids.ObjectIdNames:
            dtype_name = o_ids.ObjectIdNames[dtype.Identifier]
            self.aliases[dtype] = dtype_name
        else:
            dtype_name = dtype.to_string()
        rank = node.get_value_rank()
        if rank != -1:
            el.attrib["ValueRank"] = str(rank)
        dim = node.get_attribute(ua.AttributeIds.ArrayDimensions)
        if dim.Value.Value:
            el.attrib["ArrayDimensions"] = ",".join([str(i) for i in dim.Value.Value])
        el.attrib["DataType"] = dtype_name
        self.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_ref_els(var_el, 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
        # Not sure where default is defined....
        if accesslevel not in (0, ua.AccessLevel.CurrentRead.mask):
            var_el.attrib["AccessLevel"] = str(accesslevel)
        if useraccesslevel not in (0, ua.AccessLevel.CurrentRead.mask):
            var_el.attrib["UserAccessLevel"] = str(useraccesslevel)

        var = node.get_attribute(ua.AttributeIds.MinimumSamplingInterval)
        if var.Value.Value:
            var_el.attrib["MinimumSamplingInterval"] = str(var.Value.Value)
        var = node.get_attribute(ua.AttributeIds.Historizing)
        if var.Value.Value:
            var_el.attrib["Historizing"] = 'true'

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

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

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

        self._add_ref_els(var_el, node)

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

        var = node.get_attribute(ua.AttributeIds.Executable)
        if var.Value.Value is False:
            obj_el.attrib["Executable"] = "false"
        var = node.get_attribute(ua.AttributeIds.UserExecutable)
        if var.Value.Value is False:
            obj_el.attrib["UserExecutable"] = "false"
        self._add_ref_els(obj_el, node)

    def add_etree_reference_type(self, obj):
        obj_el = self._add_node_common("UAReferenceType", obj)
        var = obj.get_attribute(ua.AttributeIds.InverseName)
        if var is not None and var.Value.Value is not None:
            self._add_sub_el(obj_el, 'InverseName', var.Value.Value.Text.decode('utf-8'))
        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')

        ordered_keys = list(self.aliases.keys())
        ordered_keys.sort()
        for nodeid in ordered_keys:
            name = self.aliases[nodeid]
            ref_el = Et.SubElement(aliases_el, 'Alias', Alias=name)
            ref_el.text = nodeid.to_string()

        # insert behind the namespace element
        self.etree.getroot().insert(1, 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')
            ref_el.attrib['ReferenceType'] = ref_name
            if not ref.IsForward:
                ref_el.attrib['IsForward'] = 'false'
            ref_el.text = self._node_to_string(ref.NodeId)

            self.aliases[ref.ReferenceTypeId] = ref_name


    def member_to_etree(self, el, name, dtype, val):
        member_el = Et.SubElement(el, "uax:" + name)
        if isinstance(val, (list, tuple)):
            for v in val:
                self._value_to_etree(member_el, ua.ObjectIdNames[dtype.Identifier], dtype, v)
        else:
            self._val_to_etree(member_el, dtype, val)


    def _val_to_etree(self, el, dtype, val):
        if val is None:
            val = ""
        if dtype == ua.NodeId(ua.ObjectIds.NodeId):
            id_el = Et.SubElement(el, "uax:Identifier")
            id_el.text = val.to_string()
        elif dtype == ua.NodeId(ua.ObjectIds.Guid):
            id_el = Et.SubElement(el, "uax:String")
            id_el.text = str(val)
        elif dtype == ua.NodeId(ua.ObjectIds.Boolean):
            el.text = 'true' if val else 'false'
        elif not hasattr(val, "ua_types"):
            if isinstance(val, bytes):
                el.text = val.decode("utf-8")
            else:
                el.text = str(val)
        else:
            for name, vtype in val.ua_types.items():
                self.member_to_etree(el, name, ua.NodeId(getattr(ua.ObjectIds, vtype)), getattr(val, name))


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


    def _value_to_etree(self, el, type_name, dtype, val):
        if val is None:
            return

        if isinstance(val, (list, tuple)):
            if dtype.NamespaceIndex == 0 and dtype.Identifier <= 21:
                elname = "uax:ListOf" + type_name
            else:  # this is an extentionObject:
                elname = "uax:ListOfExtensionObject"

            list_el = Et.SubElement(el, elname)
            for nval in val:
                self._value_to_etree(list_el, type_name, dtype, nval)
        else:
            dtype_base = get_base_data_type(self.server.get_node(dtype))
            dtype_base = dtype_base.nodeid

            if dtype_base == ua.NodeId(ua.ObjectIds.Enumeration):
                dtype_base = ua.NodeId(ua.ObjectIds.Int32)
                type_name = ua.ObjectIdNames[dtype_base.Identifier]

            if dtype_base.NamespaceIndex == 0 and dtype_base.Identifier <= 21:
                type_name = ua.ObjectIdNames[dtype_base.Identifier]
                val_el = Et.SubElement(el, "uax:" + type_name)
                self._val_to_etree(val_el, dtype_base, val)
            else:
                self._extobj_to_etree(el, type_name, dtype, val)


    def _extobj_to_etree(self, val_el, 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 = dtype.to_string()
        body_el = Et.SubElement(obj_el, "uax:Body")
        struct_el = Et.SubElement(body_el, "uax:" + name)
        for name in self._get_member_order(dtype, val):
            self.member_to_etree(struct_el, name, ua.NodeId(getattr(ua.ObjectIds, val.ua_types[name])), getattr(val, name))

    def _get_member_order(self, dtype, val):
        '''
        If an dtype has an entry in XmlExporter.extobj_ordered_elements return the export order of the elements 
        else return the unordered members.
        '''
        if dtype not in XmlExporter.extobj_ordered_elements.keys():
            return val.ua_types.keys()
        else:
            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 ]

        return member_keys

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

FreeOpcUa / python-opcua

Push — master ( 71c8c6...645104 )

XmlExporter._get_member_order() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like