XmlImporter.import_xml() - Code Metrics - Inspection of "added TestStandardAddressSpace" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#509)

unknown

created 2017-11-07 22:27 UTC

XmlImporter.import_xml() B

↳ Parent: XmlImporter

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	4.0466

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
cc	4
c	4
b	0
f	0
dl	0
loc	29
ccs	18
cts	21
cp	0.8571
crap	4.0466
rs	8.5806

"""
add nodes defined in XML to address space
format is the one from opc-ua specification
"""
import logging
import uuid
from copy import copy

import opcua
from opcua import ua
from opcua.common import xmlparser
from opcua.ua.uaerrors import UaError

import sys

if sys.version_info.major > 2:
    unicode = str

class XmlImporter(object):

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

    def _map_namespaces(self, namespaces_uris):
        """
        creates a mapping between the namespaces in the xml file and in the server.
        if not present the namespace is registered.
        """
        namespaces = {}
        for ns_index, ns_uri in enumerate(namespaces_uris):
            ns_server_index = self.server.register_namespace(ns_uri)
            namespaces[ns_index + 1] = ns_server_index
        return namespaces

    def _map_aliases(self, aliases):
        """
        maps the import aliases to the correct namespaces
        """
        aliases_mapped = {}
        for alias, node_id in aliases.items():
            aliases_mapped[alias] = self._migrate_ns(self.to_nodeid(node_id))
        return aliases_mapped

    def import_xml(self, xmlpath):
        """
        import xml and return added nodes
        """
        self.logger.info("Importing XML file %s", xmlpath)
        self.parser = xmlparser.XMLParser(xmlpath)

        self.namespaces = self._map_namespaces(self.parser.get_used_namespaces())
        self.aliases = self._map_aliases(self.parser.get_aliases())
        self.refs = []

        dnodes = self.parser.get_node_datas()
        dnodes = self.make_objects(dnodes)
        nodes_parsed = self._sort_nodes_by_parentid(dnodes)

        nodes = []
        for nodedata in nodes_parsed:  # self.parser:
            try:
                node = self._add_node_data(nodedata)
            except Exception:
                self.logger.warning("failure adding node %s", nodedata)
                raise
            nodes.append(node)

        self.refs, remaining_refs = [], self.refs
        self._add_references(remaining_refs)
        assert len(self.refs) == 0, self.refs

        return nodes

    def _add_node_data(self, nodedata):
        if nodedata.nodetype == 'UAObject':
            node = self.add_object(nodedata)
        elif nodedata.nodetype == 'UAObjectType':
            node = self.add_object_type(nodedata)
        elif nodedata.nodetype == 'UAVariable':
            node = self.add_variable(nodedata)
        elif nodedata.nodetype == 'UAVariableType':
            node = self.add_variable_type(nodedata)
        elif nodedata.nodetype == 'UAReferenceType':
            node = self.add_reference_type(nodedata)
        elif nodedata.nodetype == 'UADataType':
            node = self.add_datatype(nodedata)
        elif nodedata.nodetype == 'UAMethod':
            node = self.add_method(nodedata)
        else:
            self.logger.warning("Not implemented node type: %s ", nodedata.nodetype)
        return node

    def _add_node(self, node):
        if isinstance(self.server, opcua.server.server.Server):
            return self.server.iserver.isession.add_nodes([node])
        else:
            return self.server.uaclient.add_nodes([node])

    def _add_references(self, refs):
        if isinstance(self.server, opcua.server.server.Server):
            res = self.server.iserver.isession.add_references(refs)
        else:
            res = self.server.uaclient.add_references(refs)

        for sc, ref in zip(res, refs):
            if not sc.is_good():
                self.refs.append(ref)

    def make_objects(self, node_datas):
        new_nodes = []
        for ndata in node_datas:
            ndata.nodeid = ua.NodeId.from_string(ndata.nodeid)
            ndata.browsename = ua.QualifiedName.from_string(ndata.browsename)
            if ndata.parent:
                ndata.parent = ua.NodeId.from_string(ndata.parent)
            if ndata.parentlink:
                ndata.parentlink = self.to_nodeid(ndata.parentlink)
            if ndata.typedef:
                ndata.typedef = self.to_nodeid(ndata.typedef)
            new_nodes.append(ndata)
        return new_nodes

    def _migrate_ns(self, nodeid):
        """
        Check if the index of nodeid or browsename  given in the xml model file
        must be converted to a already existing namespace id based on the files
        namespace uri

        :returns: NodeId (str)
        """
        if nodeid.NamespaceIndex in self.namespaces:
            nodeid = copy(nodeid)
            nodeid.NamespaceIndex = self.namespaces[nodeid.NamespaceIndex]
        return nodeid

    def _get_node(self, obj):
        node = ua.AddNodesItem()
        node.RequestedNewNodeId = self._migrate_ns(obj.nodeid)
        node.BrowseName = self._migrate_ns(obj.browsename)
        self.logger.info("Importing xml node (%s, %s) as (%s %s)", obj.browsename, obj.nodeid, node.BrowseName, node.RequestedNewNodeId)
        node.NodeClass = getattr(ua.NodeClass, obj.nodetype[2:])
        if obj.parent:
            node.ParentNodeId = self._migrate_ns(obj.parent)
        if obj.parentlink:
            node.ReferenceTypeId = self._migrate_ns(obj.parentlink)
        if obj.typedef:
            node.TypeDefinition = self._migrate_ns(obj.typedef)
        return node

    def to_nodeid(self, nodeid):
        if isinstance(nodeid, ua.NodeId):
            return nodeid
        elif not nodeid:
            return ua.NodeId(ua.ObjectIds.String)
        elif "=" in nodeid:
            return ua.NodeId.from_string(nodeid)
        elif hasattr(ua.ObjectIds, nodeid):
            return ua.NodeId(getattr(ua.ObjectIds, nodeid))
        else:
            if nodeid in self.aliases:
                return self.aliases[nodeid]
            else:
                return ua.NodeId(getattr(ua.ObjectIds, nodeid))

    def add_object(self, obj):
        node = self._get_node(obj)
        attrs = ua.ObjectAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        attrs.EventNotifier = obj.eventnotifier
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def add_object_type(self, obj):
        node = self._get_node(obj)
        attrs = ua.ObjectTypeAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        attrs.IsAbstract = obj.abstract
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def add_variable(self, obj):
        node = self._get_node(obj)
        attrs = ua.VariableAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        attrs.DataType = self.to_nodeid(obj.datatype)
        if obj.value is not None:
            attrs.Value = self._add_variable_value(obj,)
        if obj.rank:
            attrs.ValueRank = obj.rank
        if obj.accesslevel:
            attrs.AccessLevel = obj.accesslevel
        if obj.useraccesslevel:
            attrs.UserAccessLevel = obj.useraccesslevel
        if obj.minsample:
            attrs.MinimumSamplingInterval = obj.minsample
        if obj.dimensions:
            attrs.ArrayDimensions = obj.dimensions
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def _get_ext_class(self, name):
        if hasattr(ua, name):
            return  getattr(ua, name)
        elif name in self.aliases.keys():
            nodeid = self.aliases[name]
            class_type = ua.uatypes.get_extensionobject_class_type(nodeid)
            if class_type:
                return class_type
            else:
                raise Exception("Error no extension class registered ", name, nodeid)
        else:
            raise Exception("Error no alias found for extension class", name)

    def _make_ext_obj(self, obj):
        ext = self._get_ext_class(obj.objname)()
        for name, val in obj.body:
            if not isinstance(val, list):
                raise Exception("Error val should be a list, this is a python-opcua bug", name, type(val), val)
            else:
                for attname, v in val:
                    self._set_attr(ext, attname, v)
        return ext

    def _get_val_type(self, obj, attname):
        for name, uatype in obj.ua_types:
            if name == attname:
                return uatype
        raise UaError("Attribute '{}' defined in xml is not found in object '{}'".format(attname, ext))

    def _set_attr(self, obj, attname, val):
        # tow possible values:
        # either we get value directly
        # or a dict if it s an object or a list
        if isinstance(val, (str, unicode)):
            pval = xmlparser.ua_type_to_python(val, self._get_val_type(obj, attname))
            setattr(obj, attname, pval)
        else:
            # so we have either an object or a list...
            obj2 = getattr(obj, attname)
            if isinstance(obj2, ua.NodeId):  # NodeId representation does not follow common rules!!
                for attname2, v2 in val:
                    if attname2 == "Identifier":
                        if hasattr(ua.ObjectIds, v2):
                            obj2 = ua.NodeId(getattr(ua.ObjectIds, v2))
                        else:
                            obj2 = ua.NodeId.from_string(v2)
                        setattr(obj, attname, obj2)
                        break
            elif not hasattr(obj2, "ua_types"):
                # we probably have a list
                my_list = []
                for vtype, v2 in val:
                    my_list.append(xmlparser.ua_type_to_python(v2, vtype))
                setattr(obj, attname, my_list)
            else:
                for attname2, v2 in val:
                    self._set_attr(obj2, attname2, v2)
                setattr(obj, attname, obj2)

    def _add_variable_value(self, obj):
        """
        Returns the value for a Variable based on the objects value type.
        """
        self.logger.debug("Setting value with type %s and value %s", obj.valuetype, obj.value)
        if obj.valuetype == 'ListOfExtensionObject':
            values = []
            for ext in obj.value:
                extobj = self._make_ext_obj(ext)
                values.append(extobj)
            return ua.Variant(values, ua.VariantType.ExtensionObject)
        elif obj.valuetype == 'ListOfGuid':
            return ua.Variant([
                uuid.UUID(guid) for guid in obj.value
            ], getattr(ua.VariantType, obj.valuetype[6:]))
        elif obj.valuetype.startswith("ListOf"):
            vtype = obj.valuetype[6:]
            if hasattr(ua.ua_binary.Primitives, vtype):
                return ua.Variant(obj.value, getattr(ua.VariantType, vtype))
            else:
                return ua.Variant([getattr(ua, vtype)(v) for v in obj.value])
        elif obj.valuetype == 'ExtensionObject':
            extobj = self._make_ext_obj(obj.value)
            return ua.Variant(extobj, getattr(ua.VariantType, obj.valuetype))
        elif obj.valuetype == 'Guid':
            return ua.Variant(uuid.UUID(obj.value), getattr(ua.VariantType, obj.valuetype))
        elif obj.valuetype == 'LocalizedText':
            ltext = ua.LocalizedText()
            for name, val in obj.value:
                if name == "Text":
                    ltext.Text = val
                else:
                    self.logger.warning("While parsing localizedText value, unkown element: %s with val: %s", name, val)
            return ua.Variant(ltext, ua.VariantType.LocalizedText)
        elif obj.valuetype == 'NodeId':
            return ua.Variant(ua.NodeId.from_string(obj.value))
        else:
            return ua.Variant(obj.value, getattr(ua.VariantType, obj.valuetype))

    def add_variable_type(self, obj):
        node = self._get_node(obj)
        attrs = ua.VariableTypeAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        attrs.DataType = self.to_nodeid(obj.datatype)
        if obj.value and len(obj.value) == 1:
            attrs.Value = obj.value[0]
        if obj.rank:
            attrs.ValueRank = obj.rank
        if obj.abstract:
            attrs.IsAbstract = obj.abstract
        if obj.dimensions:
            attrs.ArrayDimensions = obj.dimensions
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def add_method(self, obj):

        node = self._get_node(obj)
        attrs = ua.MethodAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        if obj.accesslevel:
            attrs.AccessLevel = obj.accesslevel
        if obj.useraccesslevel:
            attrs.UserAccessLevel = obj.useraccesslevel
        if obj.minsample:
            attrs.MinimumSamplingInterval = obj.minsample
        if obj.dimensions:
            attrs.ArrayDimensions = obj.dimensions
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def add_reference_type(self, obj):

        node = self._get_node(obj)
        attrs = ua.ReferenceTypeAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        if obj. inversename:
            attrs.InverseName = ua.LocalizedText(obj.inversename)
        if obj.abstract:
            attrs.IsAbstract = obj.abstract
        if obj.symmetric:
            attrs.Symmetric = obj.symmetric
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def add_datatype(self, obj):
        node = self._get_node(obj)
        attrs = ua.DataTypeAttributes()
        if obj.desc:
            attrs.Description = ua.LocalizedText(obj.desc)
        attrs.DisplayName = ua.LocalizedText(obj.displayname)
        if obj.abstract:
            attrs.IsAbstract = obj.abstract
        node.NodeAttributes = attrs
        res = self._add_node(node)
        self._add_refs(obj)
        res[0].StatusCode.check()
        return res[0].AddedNodeId

    def _add_refs(self, obj):
        if not obj.refs:
            return
        refs = []
        for data in obj.refs:
            ref = ua.AddReferencesItem()
            ref.IsForward = True
            ref.ReferenceTypeId = self.to_nodeid(data.reftype)
            ref.SourceNodeId = self._migrate_ns(obj.nodeid)
            ref.TargetNodeClass = ua.NodeClass.DataType
            ref.TargetNodeId = self._migrate_ns(self.to_nodeid(data.target))
            refs.append(ref)
        self._add_references(refs)

    def _sort_nodes_by_parentid(self, ndatas):
        """
        Sort the list of nodes according their parent node in order to respect
        the dependency between nodes.

        :param nodes: list of NodeDataObjects
        :returns: list of sorted nodes
        """
        _ndatas = list(ndatas)
        # list of node ids that are already sorted / inserted
        sorted_nodes_ids = []
        # list of sorted nodes (i.e. XML Elements)
        sorted_ndatas = []
        all_node_ids = [data.nodeid for data in ndatas]
        # list of namespace indexes that are relevant for this import
        # we can only respect ordering nodes for namespaces indexes that
        # are defined in the xml file itself. Thus we assume that all other
        # references namespaces are already known to the server and should
        # not create any dependency problems (like "NodeNotFound")
        while len(_ndatas) > 0:
            pop_nodes = []
            for ndata in _ndatas:
                # Insert nodes that
                #   (1) have no parent / parent_ns is None (e.g. namespace 0)
                #   (2) ns is not in list of relevant namespaces
                if ndata.nodeid.NamespaceIndex not in self.namespaces or \
                        ndata.parent is None or \
                        ndata.parent not in all_node_ids:
                    sorted_ndatas.append(ndata)
                    sorted_nodes_ids.append(ndata.nodeid)
                    pop_nodes.append(ndata)
                else:
                    # Check if the nodes parent is already in the list of
                    # inserted nodes
                    if ndata.parent in sorted_nodes_ids:
                        sorted_ndatas.append(ndata)
                        sorted_nodes_ids.append(ndata.nodeid)
                        pop_nodes.append(ndata)
            # Remove inserted nodes from the list
            for ndata in pop_nodes:
                _ndatas.pop(_ndatas.index(ndata))
        return sorted_ndatas


1			"""
2			add nodes defined in XML to address space
3			format is the one from opc-ua specification
4			"""
5	1		import logging
6	1		import uuid
7	1		from copy import copy
8
9	1		import opcua
10	1		from opcua import ua
11	1		from opcua.common import xmlparser
12	1		from opcua.ua.uaerrors import UaError
13
14	1		import sys
15
16	1		if sys.version_info.major > 2:
17			unicode = str
18
19	1		class XmlImporter(object):
20
21	1		def __init__(self, server):
22	1		self.logger = logging.getLogger(__name__)
23	1		self.parser = None
24	1		self.server = server
25	1		self.namespaces = {}
26	1		self.aliases = {}
27	1		self.refs = None
28
29	1		def _map_namespaces(self, namespaces_uris):
30			"""
31			creates a mapping between the namespaces in the xml file and in the server.
32			if not present the namespace is registered.
33			"""
34	1		namespaces = {}
35	1		for ns_index, ns_uri in enumerate(namespaces_uris):
36	1		ns_server_index = self.server.register_namespace(ns_uri)
37	1		namespaces[ns_index + 1] = ns_server_index
38	1		return namespaces
39
40	1		def _map_aliases(self, aliases):
41			"""
42			maps the import aliases to the correct namespaces
43			"""
44	1		aliases_mapped = {}
45	1		for alias, node_id in aliases.items():
46	1		aliases_mapped[alias] = self._migrate_ns(self.to_nodeid(node_id))
47	1		return aliases_mapped
48
49	1		def import_xml(self, xmlpath):
50			"""
51			import xml and return added nodes
52			"""
53	1		self.logger.info("Importing XML file %s", xmlpath)
54	1		self.parser = xmlparser.XMLParser(xmlpath)
55
56	1		self.namespaces = self._map_namespaces(self.parser.get_used_namespaces())
57	1		self.aliases = self._map_aliases(self.parser.get_aliases())
58	1		self.refs = []
59
60	1		dnodes = self.parser.get_node_datas()
61	1		dnodes = self.make_objects(dnodes)
62	1		nodes_parsed = self._sort_nodes_by_parentid(dnodes)
63
64	1		nodes = []
65	1		for nodedata in nodes_parsed: # self.parser:
66	1		try:
67	1		node = self._add_node_data(nodedata)
68			except Exception:
69			self.logger.warning("failure adding node %s", nodedata)
70			raise
71	1		nodes.append(node)
72
73	1		self.refs, remaining_refs = [], self.refs
74	1		self._add_references(remaining_refs)
75	1		assert len(self.refs) == 0, self.refs
76
77	1		return nodes
78
79	1		def _add_node_data(self, nodedata):
80	1		if nodedata.nodetype == 'UAObject':
81	1		node = self.add_object(nodedata)
82	1		elif nodedata.nodetype == 'UAObjectType':
83	1		node = self.add_object_type(nodedata)
84	1		elif nodedata.nodetype == 'UAVariable':
85	1		node = self.add_variable(nodedata)
86	1		elif nodedata.nodetype == 'UAVariableType':
87			node = self.add_variable_type(nodedata)
88	1		elif nodedata.nodetype == 'UAReferenceType':
89			node = self.add_reference_type(nodedata)
90	1		elif nodedata.nodetype == 'UADataType':
91	1		node = self.add_datatype(nodedata)
92	1		elif nodedata.nodetype == 'UAMethod':
93	1		node = self.add_method(nodedata)
94			else:
95			self.logger.warning("Not implemented node type: %s ", nodedata.nodetype)
96	1		return node
97
98	1		def _add_node(self, node):
99	1		if isinstance(self.server, opcua.server.server.Server):
100	1		return self.server.iserver.isession.add_nodes([node])
101			else:
102	1		return self.server.uaclient.add_nodes([node])
103
104	1		def _add_references(self, refs):
105	1		if isinstance(self.server, opcua.server.server.Server):
106	1		res = self.server.iserver.isession.add_references(refs)
107			else:
108	1		res = self.server.uaclient.add_references(refs)
109
110	1		for sc, ref in zip(res, refs):
111	1		if not sc.is_good():
112	1		self.refs.append(ref)
113
114	1		def make_objects(self, node_datas):
115	1		new_nodes = []
116	1		for ndata in node_datas:
117	1		ndata.nodeid = ua.NodeId.from_string(ndata.nodeid)
118	1		ndata.browsename = ua.QualifiedName.from_string(ndata.browsename)
119	1		if ndata.parent:
120	1		ndata.parent = ua.NodeId.from_string(ndata.parent)
121	1		if ndata.parentlink:
122	1		ndata.parentlink = self.to_nodeid(ndata.parentlink)
123	1		if ndata.typedef:
124	1		ndata.typedef = self.to_nodeid(ndata.typedef)
125	1		new_nodes.append(ndata)
126	1		return new_nodes
127
128	1		def _migrate_ns(self, nodeid):
129			"""
130			Check if the index of nodeid or browsename given in the xml model file
131			must be converted to a already existing namespace id based on the files
132			namespace uri
133
134			:returns: NodeId (str)
135			"""
136	1		if nodeid.NamespaceIndex in self.namespaces:
137	1		nodeid = copy(nodeid)
138	1		nodeid.NamespaceIndex = self.namespaces[nodeid.NamespaceIndex]
139	1		return nodeid
140
141	1		def _get_node(self, obj):
142	1		node = ua.AddNodesItem()
143	1		node.RequestedNewNodeId = self._migrate_ns(obj.nodeid)
144	1		node.BrowseName = self._migrate_ns(obj.browsename)
145	1		self.logger.info("Importing xml node (%s, %s) as (%s %s)", obj.browsename, obj.nodeid, node.BrowseName, node.RequestedNewNodeId)
146	1		node.NodeClass = getattr(ua.NodeClass, obj.nodetype[2:])
147	1		if obj.parent:
148	1		node.ParentNodeId = self._migrate_ns(obj.parent)
149	1		if obj.parentlink:
150	1		node.ReferenceTypeId = self._migrate_ns(obj.parentlink)
151	1		if obj.typedef:
152	1		node.TypeDefinition = self._migrate_ns(obj.typedef)
153	1		return node
154
155	1		def to_nodeid(self, nodeid):
156	1		if isinstance(nodeid, ua.NodeId):
157			return nodeid
158	1		elif not nodeid:
159			return ua.NodeId(ua.ObjectIds.String)
160	1		elif "=" in nodeid:
161	1		return ua.NodeId.from_string(nodeid)
162	1		elif hasattr(ua.ObjectIds, nodeid):
163	1		return ua.NodeId(getattr(ua.ObjectIds, nodeid))
164			else:
165	1		if nodeid in self.aliases:
166	1		return self.aliases[nodeid]
167			else:
168			return ua.NodeId(getattr(ua.ObjectIds, nodeid))
169
170	1		def add_object(self, obj):
171	1		node = self._get_node(obj)
172	1		attrs = ua.ObjectAttributes()
173	1		if obj.desc:
174	1		attrs.Description = ua.LocalizedText(obj.desc)
175	1		attrs.DisplayName = ua.LocalizedText(obj.displayname)
176	1		attrs.EventNotifier = obj.eventnotifier
177	1		node.NodeAttributes = attrs
178	1		res = self._add_node(node)
179	1		self._add_refs(obj)
180	1		res[0].StatusCode.check()
181	1		return res[0].AddedNodeId
182
183	1		def add_object_type(self, obj):
184	1		node = self._get_node(obj)
185	1		attrs = ua.ObjectTypeAttributes()
186	1		if obj.desc:
187			attrs.Description = ua.LocalizedText(obj.desc)
188	1		attrs.DisplayName = ua.LocalizedText(obj.displayname)
189	1		attrs.IsAbstract = obj.abstract
190	1		node.NodeAttributes = attrs
191	1		res = self._add_node(node)
192	1		self._add_refs(obj)
193	1		res[0].StatusCode.check()
194	1		return res[0].AddedNodeId
195
196	1		def add_variable(self, obj):
197	1		node = self._get_node(obj)
198	1		attrs = ua.VariableAttributes()
199	1		if obj.desc:
200	1		attrs.Description = ua.LocalizedText(obj.desc)
201	1		attrs.DisplayName = ua.LocalizedText(obj.displayname)
202	1		attrs.DataType = self.to_nodeid(obj.datatype)
203	1		if obj.value is not None:
204	1		attrs.Value = self._add_variable_value(obj,)
205	1		if obj.rank:
206	1		attrs.ValueRank = obj.rank
207	1		if obj.accesslevel:
208			attrs.AccessLevel = obj.accesslevel
209	1		if obj.useraccesslevel:
210			attrs.UserAccessLevel = obj.useraccesslevel
211	1		if obj.minsample:
212			attrs.MinimumSamplingInterval = obj.minsample
213	1		if obj.dimensions:
214	1		attrs.ArrayDimensions = obj.dimensions
215	1		node.NodeAttributes = attrs
216	1		res = self._add_node(node)
217	1		self._add_refs(obj)
218	1		res[0].StatusCode.check()
219	1		return res[0].AddedNodeId
220
221	1		def _get_ext_class(self, name):
222	1		if hasattr(ua, name):
223	1		return getattr(ua, name)
224			elif name in self.aliases.keys():
225			nodeid = self.aliases[name]
226			class_type = ua.uatypes.get_extensionobject_class_type(nodeid)
227			if class_type:
228			return class_type
229			else:
230			raise Exception("Error no extension class registered ", name, nodeid)
231			else:
232			raise Exception("Error no alias found for extension class", name)
233
234	1		def _make_ext_obj(self, obj):
235	1		ext = self._get_ext_class(obj.objname)()
236	1		for name, val in obj.body:
237	1		if not isinstance(val, list):
238			raise Exception("Error val should be a list, this is a python-opcua bug", name, type(val), val)
239			else:
240	1		for attname, v in val:
241	1		self._set_attr(ext, attname, v)
242	1		return ext
243
244	1		def _get_val_type(self, obj, attname):
245	1		for name, uatype in obj.ua_types:
246	1		if name == attname:
247	1		return uatype
248			raise UaError("Attribute '{}' defined in xml is not found in object '{}'".format(attname, ext))
249
250	1		def _set_attr(self, obj, attname, val):
251			# tow possible values:
252			# either we get value directly
253			# or a dict if it s an object or a list
254	1		if isinstance(val, (str, unicode)):
255	1		pval = xmlparser.ua_type_to_python(val, self._get_val_type(obj, attname))
256	1		setattr(obj, attname, pval)
257			else:
258			# so we have either an object or a list...
259	1		obj2 = getattr(obj, attname)
260	1		if isinstance(obj2, ua.NodeId): # NodeId representation does not follow common rules!!
261	1		for attname2, v2 in val:
262	1		if attname2 == "Identifier":
263	1		if hasattr(ua.ObjectIds, v2):
264			obj2 = ua.NodeId(getattr(ua.ObjectIds, v2))
265			else:
266	1		obj2 = ua.NodeId.from_string(v2)
267	1		setattr(obj, attname, obj2)
268	1		break
269	1		elif not hasattr(obj2, "ua_types"):
270			# we probably have a list
271	1		my_list = []
272	1		for vtype, v2 in val:
273	1		my_list.append(xmlparser.ua_type_to_python(v2, vtype))
274	1		setattr(obj, attname, my_list)
275			else:
276	1		for attname2, v2 in val:
277	1		self._set_attr(obj2, attname2, v2)
278	1		setattr(obj, attname, obj2)
279
280	1		def _add_variable_value(self, obj):
281			"""
282			Returns the value for a Variable based on the objects value type.
283			"""
284	1		self.logger.debug("Setting value with type %s and value %s", obj.valuetype, obj.value)
285	1		if obj.valuetype == 'ListOfExtensionObject':
286	1		values = []
287	1		for ext in obj.value:
288	1		extobj = self._make_ext_obj(ext)
289	1		values.append(extobj)
290	1		return ua.Variant(values, ua.VariantType.ExtensionObject)
291	1		elif obj.valuetype == 'ListOfGuid':
292	1		return ua.Variant([
293			uuid.UUID(guid) for guid in obj.value
294			], getattr(ua.VariantType, obj.valuetype[6:]))
295	1		elif obj.valuetype.startswith("ListOf"):
296	1		vtype = obj.valuetype[6:]
297	1		if hasattr(ua.ua_binary.Primitives, vtype):
298	1		return ua.Variant(obj.value, getattr(ua.VariantType, vtype))
299			else:
300	1		return ua.Variant([getattr(ua, vtype)(v) for v in obj.value])
301	1		elif obj.valuetype == 'ExtensionObject':
302	1		extobj = self._make_ext_obj(obj.value)
303	1		return ua.Variant(extobj, getattr(ua.VariantType, obj.valuetype))
304	1		elif obj.valuetype == 'Guid':
305	1		return ua.Variant(uuid.UUID(obj.value), getattr(ua.VariantType, obj.valuetype))
306	1		elif obj.valuetype == 'LocalizedText':
307	1		ltext = ua.LocalizedText()
308	1		for name, val in obj.value:
309	1		if name == "Text":
310	1		ltext.Text = val
311			else:
312	1		self.logger.warning("While parsing localizedText value, unkown element: %s with val: %s", name, val)
313	1		return ua.Variant(ltext, ua.VariantType.LocalizedText)
314	1		elif obj.valuetype == 'NodeId':
315	1		return ua.Variant(ua.NodeId.from_string(obj.value))
316			else:
317	1		return ua.Variant(obj.value, getattr(ua.VariantType, obj.valuetype))
318
319	1		def add_variable_type(self, obj):
320			node = self._get_node(obj)
321			attrs = ua.VariableTypeAttributes()
322			if obj.desc:
323			attrs.Description = ua.LocalizedText(obj.desc)
324			attrs.DisplayName = ua.LocalizedText(obj.displayname)
325			attrs.DataType = self.to_nodeid(obj.datatype)
326			if obj.value and len(obj.value) == 1:
327			attrs.Value = obj.value[0]
328			if obj.rank:
329			attrs.ValueRank = obj.rank
330			if obj.abstract:
331			attrs.IsAbstract = obj.abstract
332			if obj.dimensions:
333			attrs.ArrayDimensions = obj.dimensions
334			node.NodeAttributes = attrs
335			res = self._add_node(node)
336			self._add_refs(obj)
337			res[0].StatusCode.check()
338			return res[0].AddedNodeId
339
340	1	View Code Duplication	def add_method(self, obj):
			0 ignored issues – show Duplication introduced 2016-10-21 14:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
341	1		node = self._get_node(obj)
342	1		attrs = ua.MethodAttributes()
343	1		if obj.desc:
344	1		attrs.Description = ua.LocalizedText(obj.desc)
345	1		attrs.DisplayName = ua.LocalizedText(obj.displayname)
346	1		if obj.accesslevel:
347			attrs.AccessLevel = obj.accesslevel
348	1		if obj.useraccesslevel:
349			attrs.UserAccessLevel = obj.useraccesslevel
350	1		if obj.minsample:
351			attrs.MinimumSamplingInterval = obj.minsample
352	1		if obj.dimensions:
353			attrs.ArrayDimensions = obj.dimensions
354	1		node.NodeAttributes = attrs
355	1		res = self._add_node(node)
356	1		self._add_refs(obj)
357	1		res[0].StatusCode.check()
358	1		return res[0].AddedNodeId
359
360	1	View Code Duplication	def add_reference_type(self, obj):
			0 ignored issues – show Duplication introduced 2016-12-29 19:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
361			node = self._get_node(obj)
362			attrs = ua.ReferenceTypeAttributes()
363			if obj.desc:
364			attrs.Description = ua.LocalizedText(obj.desc)
365			attrs.DisplayName = ua.LocalizedText(obj.displayname)
366			if obj. inversename:
367			attrs.InverseName = ua.LocalizedText(obj.inversename)
368			if obj.abstract:
369			attrs.IsAbstract = obj.abstract
370			if obj.symmetric:
371			attrs.Symmetric = obj.symmetric
372			node.NodeAttributes = attrs
373			res = self._add_node(node)
374			self._add_refs(obj)
375			res[0].StatusCode.check()
376			return res[0].AddedNodeId
377
378	1		def add_datatype(self, obj):
379	1		node = self._get_node(obj)
380	1		attrs = ua.DataTypeAttributes()
381	1		if obj.desc:
382	1		attrs.Description = ua.LocalizedText(obj.desc)
383	1		attrs.DisplayName = ua.LocalizedText(obj.displayname)
384	1		if obj.abstract:
385			attrs.IsAbstract = obj.abstract
386	1		node.NodeAttributes = attrs
387	1		res = self._add_node(node)
388	1		self._add_refs(obj)
389	1		res[0].StatusCode.check()
390	1		return res[0].AddedNodeId
391
392	1		def _add_refs(self, obj):
393	1		if not obj.refs:
394	1		return
395	1		refs = []
396	1		for data in obj.refs:
397	1		ref = ua.AddReferencesItem()
398	1		ref.IsForward = True
399	1		ref.ReferenceTypeId = self.to_nodeid(data.reftype)
400	1		ref.SourceNodeId = self._migrate_ns(obj.nodeid)
401	1		ref.TargetNodeClass = ua.NodeClass.DataType
402	1		ref.TargetNodeId = self._migrate_ns(self.to_nodeid(data.target))
403	1		refs.append(ref)
404	1		self._add_references(refs)
405
406	1		def _sort_nodes_by_parentid(self, ndatas):
407			"""
408			Sort the list of nodes according their parent node in order to respect
409			the dependency between nodes.
410
411			:param nodes: list of NodeDataObjects
412			:returns: list of sorted nodes
413			"""
414	1		_ndatas = list(ndatas)
415			# list of node ids that are already sorted / inserted
416	1		sorted_nodes_ids = []
417			# list of sorted nodes (i.e. XML Elements)
418	1		sorted_ndatas = []
419	1		all_node_ids = [data.nodeid for data in ndatas]
420			# list of namespace indexes that are relevant for this import
421			# we can only respect ordering nodes for namespaces indexes that
422			# are defined in the xml file itself. Thus we assume that all other
423			# references namespaces are already known to the server and should
424			# not create any dependency problems (like "NodeNotFound")
425	1		while len(_ndatas) > 0:
426	1		pop_nodes = []
427	1		for ndata in _ndatas:
428			# Insert nodes that
429			# (1) have no parent / parent_ns is None (e.g. namespace 0)
430			# (2) ns is not in list of relevant namespaces
431	1		if ndata.nodeid.NamespaceIndex not in self.namespaces or \
432			ndata.parent is None or \
433			ndata.parent not in all_node_ids:
434	1		sorted_ndatas.append(ndata)
435	1		sorted_nodes_ids.append(ndata.nodeid)
436	1		pop_nodes.append(ndata)
437			else:
438			# Check if the nodes parent is already in the list of
439			# inserted nodes
440	1		if ndata.parent in sorted_nodes_ids:
441	1		sorted_ndatas.append(ndata)
442	1		sorted_nodes_ids.append(ndata.nodeid)
443	1		pop_nodes.append(ndata)
444			# Remove inserted nodes from the list
445	1		for ndata in pop_nodes:
446	1		_ndatas.pop(_ndatas.index(ndata))
447			return sorted_ndatas
448

FreeOpcUa / python-opcua

Pull Request — master (#509)

XmlImporter.import_xml() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like