XmlExporter.add_etree_method() - Code Metrics - Inspection of "also export namespace of referenced nodes" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#327)

by Olivier

created 2016-10-13 07:13 UTC

XmlExporter.add_etree_method() A

↳ Parent: XmlExporter

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
cc	3
dl	0
loc	10
rs	9.4285
c	4
b	1
f	1

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


class XmlExporter(object):

    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 allways 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) 
        print("DICT", self._addr_idx_to_xml_idx)
        ns_to_export = [ns_array[i] for i in self._addr_idx_to_xml_idx.keys() if i != 0]
        print("NS_TO_EXPORT", ns_to_export)

        # 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
        print(" ADDR_TO_ XML", self._addr_idx_to_xml_idx)
        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:
            if node.nodeid.NamespaceIndex != 0 and node.nodeid.NamespaceIndex not in idxs:
                idxs.append(node.nodeid.NamespaceIndex)
            # also add idx of referenced nodes
            for ref in node.get_references():
                if ref.NodeId.NamespaceIndex != 0 and ref.NodeId.NamespaceIndex not in idxs:
                    idxs.append(ref.NodeId.NamespaceIndex)
        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:
            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()
        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_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
        print("NODE COMMON", node)
        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.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()
        if rank != -1:
            el.attrib["ValueRank"] = str(rank)
        #var = node.get_attribute(ua.AttributeIds.ArrayDimensions())
        #self._addobj_el.attrib["ArrayDimensions"] = str(var.Value.Value)
        el.attrib["DataType"] = dtype_name
        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
        # 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'
        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("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')

        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')
            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_name] = ref.ReferenceTypeId.to_string()


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


def _val_to_etree(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 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():
            member_to_etree(el, name, ua.NodeId(getattr(ua.ObjectIds, vtype)), getattr(val, name))


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


def _value_to_etree(el, type_name, dtype, val):
    if not val:
        return
    if isinstance(val, (list, tuple)):
        if dtype.Identifier > 21:  # this is an extentionObject:
            elname = "uax:ListOfExtensionObject"
        else:
            elname = "uax:ListOf" + type_name
        list_el = Et.SubElement(el, elname)
        for nval in val:
            _value_to_etree(list_el, type_name, dtype, nval)
    else:
        if dtype.Identifier > 21:  # this is an extentionObject:
            _extobj_to_etree(el, type_name, dtype, val)
        else:
            val_el = Et.SubElement(el, "uax:" + type_name)
            _val_to_etree(val_el, dtype, val)
           

def _extobj_to_etree(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, vtype in val.ua_types.items():
        member_to_etree(struct_el, name, ua.NodeId(getattr(ua.ObjectIds, vtype)), getattr(val, name))


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

FreeOpcUa / python-opcua

Pull Request — master (#327)

XmlExporter.add_etree_method() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like