XMLParser._get_node_id() - Code Metrics - Inspection of "Feature: Use namespaces in xml import" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#252)

unknown

created 2016-07-27 05:29 UTC

XMLParser._get_node_id() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3.1406

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	3
c	2
b	0
f	0
dl	0
loc	13
ccs	9
cts	12
cp	0.75
crap	3.1406
rs	9.4285

"""
parse xml file from opcua-spec
"""
import logging
import re
import sys

import xml.etree.ElementTree as ET


class NodeData(object):

    def __init__(self):
        self.nodetype = None
        self.nodeid = None
        self.browsename = None
        self.displayname = None
        self.symname = None  # FIXME: this param is never used, why?
        self.parent = None
        self.parentlink = None
        self.desc = ""
        self.typedef = None
        self.refs = []
        self.nodeclass = None
        self.eventnotifier = 0

        # variable
        self.datatype = None
        self.rank = -1  # check default value
        self.value = None
        self.valuetype = None
        self.dimensions = None
        self.accesslevel = None
        self.useraccesslevel = None
        self.minsample = None

        # referencetype
        self.inversename = ""
        self.abstract = "false"
        self.symmetric = "false"

        # datatype
        self.definition = []


class RefStruct(object):

    def __init__(self):
        self.reftype = None
        self.forward = True
        self.target = None


class XMLParser(object):

    def __init__(self, xmlpath, server):
        self.server = server  # POC
        self.logger = logging.getLogger(__name__)
        self._retag = re.compile(r"(\{.*\})(.*)")
        self.path = xmlpath
        self.aliases = {}

        self.tree = ET.parse(xmlpath)
        self.root = self.tree.getroot()
        self.it = None

        self.namespaces = {}
        self._re_nodeid = re.compile(r"^ns=(?P<ns>\d+[^;]*);i=(?P<i>\d+)")

    def __iter__(self):
        self.it = iter(self.root)
        return self

    def __next__(self):
        while True:
            if sys.version_info[0] < 3:
                child = self.it.next()
            else:
                child = self.it.__next__()
            name = self._retag.match(child.tag).groups()[1]
            if name == "Aliases":
                for el in child:
                    self.aliases[el.attrib["Alias"]] = el.text
            elif name == 'NamespaceUris':
                for ns_index, ns_element in enumerate(child):
                    ns_uri = ns_element.text
                    ns_server_index = self.server.register_namespace(ns_uri)
                    self.namespaces[ns_index + 1] = (ns_server_index, ns_uri)
            else:
                node = self._parse_node(name, child)
                return node

    def next(self):  # support for python2
        return self.__next__()

    def _get_node_id(self, value):
        """
        Get the node id of the object and convert it to the node id
        depending on the server namespace.
        """
        node_id = value
        r_match = self._re_nodeid.search(value)
        if r_match:
            node_ns, node_id = r_match.groups()
            ns_server = self.namespaces.get(int(node_ns), None)
            if ns_server:
                node_id = "ns={};i={}".format(ns_server[0], node_id)
        return node_id

    def _parse_node(self, name, child):
        obj = NodeData()
        obj.nodetype = name
        for key, val in child.attrib.items():
            self._set_attr(key, val, obj)
        obj.displayname = obj.browsename  # give a default value to display name
        for el in child:
            self._parse_tag(el, obj)
        return obj

    def _set_attr(self, key, val, obj):
        if key == "NodeId":
            obj.nodeid = self._get_node_id(val)
        elif key == "BrowseName":
            obj.browsename = val
        elif key == "SymbolicName":
            obj.symname = val
        elif key == "ParentNodeId":
            obj.parent = self._get_node_id(val)
        elif key == "DataType":
            obj.datatype = val
        elif key == "IsAbstract":
            obj.abstract = val
        elif key == "EventNotifier":
            obj.eventnotifier = 1 if val == "1" else 0
        elif key == "ValueRank":
            obj.rank = int(val)
        elif key == "ArrayDimensions":
            obj.dimensions = [int(i) for i in val.split(",")]
        elif key == "MinimumSamplingInterval":
            obj.minsample = int(val)
        elif key == "AccessLevel":
            obj.accesslevel = int(val)
        elif key == "UserAccessLevel":
            obj.useraccesslevel = int(val)
        elif key == "Symmetric":
            obj.symmetric = True if val == "true" else False
        else:
            self.logger.info("Attribute not implemented: %s:%s", key, val)

    def _parse_tag(self, el, obj):
        tag = self._retag.match(el.tag).groups()[1]

        if tag == "DisplayName":
            obj.displayname = el.text
        elif tag == "Description":
            obj.desc = el.text
        elif tag == "References":
            self._parse_refs(el, obj)
        elif tag == "Value":
            self._parse_value(el, obj)
        elif tag == "InverseName":
            obj.inversename = el.text
        elif tag == "Definition":
            for field in el:
                obj.definition.append(field)
        else:
            self.logger.info("Not implemented tag: %s", el)

    def _parse_value(self, el, obj):
        for val in el:
            ntag = self._retag.match(val.tag).groups()[1]
            obj.valuetype = ntag
            if ntag in ("Int8", "UInt8", "Int16", "UInt16", "Int32", "UInt32", "Int64", "UInt64"):
                obj.value = int(val.text)
            elif ntag in ("Float", "Double"):
                obj.value = float(val.text)
            elif ntag in ("Boolean"):
                if val.text in ("True", "true", "1", "on", "On"):
                    obj.value = bool(1)
                else:
                    obj.value = bool(0)
            elif ntag in ("ByteString", "String"):
                mytext = val.text
                if mytext is None:  # support importing null strings
                    mytext = ""
                mytext = mytext.replace('\n', '').replace('\r', '')
                # obj.value.append('b"{}"'.format(mytext))
                obj.value = mytext
            elif ntag == "ListOfExtensionObject":
                obj.value, obj.valuetype = self._parse_list_of_extension_object(el)
            elif ntag == "ListOfLocalizedText":
                obj.value = self._parse_list_of_localized_text(el)
            else:
                self.logger.info("Value type not implemented: %s", ntag)

    def _get_text(self, el):
        txt = ""
        for text in el.itertext():
            txt += text
        return txt

    def _parse_list_of_localized_text(self, el):
        value = []
        for localized_text_list in el:
            for localized_text in localized_text_list:
                ntag = self._retag.match(localized_text.tag).groups()[1]
                for child in localized_text:
                    ntag = self._retag.match(child.tag).groups()[1]
                    if ntag == 'Text':
                        value.append(self._get_text(child))
        return value

    def _parse_list_of_extension_object(self, el):
        '''
        Parse a uax:ListOfExtensionObject Value
        
        Return an array with a value of each uax:ExtensionObject/*/* (each element is convert to a netry in a dict.
               also the valuetype is returned. The valuetype is  uax:ExtensionObject/*/tag()
        '''
        value = []
        valuetype = None
        for extension_object_list in el:
            for extension_object in extension_object_list:
                extension_object.find('Body')
                for extension_object_part in extension_object:
                    ntag = self._retag.match(extension_object_part.tag).groups()[1]
                    if ntag == 'Body':
                        data = {}
                        ntag = self._retag.match(extension_object_part.find('*').tag).groups()[1]
                        valuetype = ntag
                        for body_item in extension_object_part.findall('*/*'):
                            ntag = self._retag.match(body_item.tag).groups()[1]

                            child = body_item.find('*')
                            if child is not None:
                                data[ntag] = self._get_text(child)
                            else:
                                data[ntag] = self._get_text(body_item)
                        value.append(data)
        return value, valuetype

    def _parse_refs(self, el, obj):
        for ref in el:
            if ref.attrib["ReferenceType"] == "HasTypeDefinition":
                obj.typedef = self._get_node_id(ref.text)
            elif "IsForward" in ref.attrib and ref.attrib["IsForward"] == "false":
                # if obj.parent:
                    # sys.stderr.write("Parent is already set with: "+ obj.parent + " " + ref.text + "\n")
                obj.parent = self._get_node_id(ref.text)
                obj.parentlink = ref.attrib["ReferenceType"]
            else:
                struct = RefStruct()
                if "IsForward" in ref.attrib:
                    struct.forward = ref.attrib["IsForward"]
                struct.target = self._get_node_id(ref.text)
                struct.reftype = ref.attrib["ReferenceType"]
                obj.refs.append(struct)


1		"""
2		parse xml file from opcua-spec
3		"""
4	1	import logging
5	1	import re
6	1	import sys
7
8	1	import xml.etree.ElementTree as ET
9
10
11	1	class NodeData(object):
12
13	1	def __init__(self):
14	1	self.nodetype = None
15	1	self.nodeid = None
16	1	self.browsename = None
17	1	self.displayname = None
18	1	self.symname = None # FIXME: this param is never used, why?
19	1	self.parent = None
20	1	self.parentlink = None
21	1	self.desc = ""
22	1	self.typedef = None
23	1	self.refs = []
24	1	self.nodeclass = None
25	1	self.eventnotifier = 0
26
27		# variable
28	1	self.datatype = None
29	1	self.rank = -1 # check default value
30	1	self.value = None
31	1	self.valuetype = None
32	1	self.dimensions = None
33	1	self.accesslevel = None
34	1	self.useraccesslevel = None
35	1	self.minsample = None
36
37		# referencetype
38	1	self.inversename = ""
39	1	self.abstract = "false"
40	1	self.symmetric = "false"
41
42		# datatype
43	1	self.definition = []
44
45
46	1	class RefStruct(object):
47
48	1	def __init__(self):
49		self.reftype = None
50		self.forward = True
51		self.target = None
52
53
54	1	class XMLParser(object):
55
56	1	def __init__(self, xmlpath, server):
57	1	self.server = server # POC
58	1	self.logger = logging.getLogger(__name__)
59	1	self._retag = re.compile(r"(\{.\})(.)")
60	1	self.path = xmlpath
61		self.aliases = {}
62	1
63	1	self.tree = ET.parse(xmlpath)
64	1	self.root = self.tree.getroot()
65		self.it = None
66	1
67	1	self.namespaces = {}
68	1	self._re_nodeid = re.compile(r"^ns=(?P<ns>\d+[^;]*);i=(?P<i>\d+)")
69
70	1	def __iter__(self):
71	1	self.it = iter(self.root)
72	1	return self
73
74		def __next__(self):
75	1	while True:
76	1	if sys.version_info[0] < 3:
77	1	child = self.it.next()
78		else:
79		child = self.it.__next__()
80		name = self._retag.match(child.tag).groups()[1]
81	1	if name == "Aliases":
82	1	for el in child:
83		self.aliases[el.attrib["Alias"]] = el.text
84	1	elif name == 'NamespaceUris':
85		for ns_index, ns_element in enumerate(child):
86		ns_uri = ns_element.text
87	1	ns_server_index = self.server.register_namespace(ns_uri)
88	1	self.namespaces[ns_index + 1] = (ns_server_index, ns_uri)
89	1	else:
90	1	node = self._parse_node(name, child)
91	1	return node
92	1
93	1	def next(self): # support for python2
94	1	return self.__next__()
95	1
96		def _get_node_id(self, value):
97	1	"""
98	1	Get the node id of the object and convert it to the node id
99	1	depending on the server namespace.
100	1	"""
101	1	node_id = value
102	1	r_match = self._re_nodeid.search(value)
103		if r_match:
104	1	node_ns, node_id = r_match.groups()
105		ns_server = self.namespaces.get(int(node_ns), None)
106	1	if ns_server:
107	1	node_id = "ns={};i={}".format(ns_server[0], node_id)
108		return node_id
109
110		def _parse_node(self, name, child):
111		obj = NodeData()
112		obj.nodetype = name
113		for key, val in child.attrib.items():
114		self._set_attr(key, val, obj)
115		obj.displayname = obj.browsename # give a default value to display name
116		for el in child:
117		self._parse_tag(el, obj)
118		return obj
119
120		def _set_attr(self, key, val, obj):
121		if key == "NodeId":
122		obj.nodeid = self._get_node_id(val)
123		elif key == "BrowseName":
124		obj.browsename = val
125		elif key == "SymbolicName":
126		obj.symname = val
127		elif key == "ParentNodeId":
128	1	obj.parent = self._get_node_id(val)
129	1	elif key == "DataType":
130		obj.datatype = val
131	1	elif key == "IsAbstract":
132		obj.abstract = val
133	1	elif key == "EventNotifier":
134	1	obj.eventnotifier = 1 if val == "1" else 0
135	1	elif key == "ValueRank":
136	1	obj.rank = int(val)
137	1	elif key == "ArrayDimensions":
138	1	obj.dimensions = [int(i) for i in val.split(",")]
139		elif key == "MinimumSamplingInterval":
140		obj.minsample = int(val)
141		elif key == "AccessLevel":
142		obj.accesslevel = int(val)
143		elif key == "UserAccessLevel":
144		obj.useraccesslevel = int(val)
145		elif key == "Symmetric":
146		obj.symmetric = True if val == "true" else False
147	1	else:
148	1	self.logger.info("Attribute not implemented: %s:%s", key, val)
149	1
150	1	def _parse_tag(self, el, obj):
151	1	tag = self._retag.match(el.tag).groups()[1]
152	1
153	1	if tag == "DisplayName":
154		obj.displayname = el.text
155	1	elif tag == "Description":
156		obj.desc = el.text
157		elif tag == "References":
158		self._parse_refs(el, obj)
159		elif tag == "Value":
160	1	self._parse_value(el, obj)
161	1	elif tag == "InverseName":
162	1	obj.inversename = el.text
163		elif tag == "Definition":
164	1	for field in el:
165		obj.definition.append(field)
166	1	else:
167		self.logger.info("Not implemented tag: %s", el)
168
169		def _parse_value(self, el, obj):
170		for val in el:
171		ntag = self._retag.match(val.tag).groups()[1]
172		obj.valuetype = ntag
173		if ntag in ("Int8", "UInt8", "Int16", "UInt16", "Int32", "UInt32", "Int64", "UInt64"):
174	1	obj.value = int(val.text)
175	1	elif ntag in ("Float", "Double"):
176	1	obj.value = float(val.text)
177	1	elif ntag in ("Boolean"):
178	1	if val.text in ("True", "true", "1", "on", "On"):
179		obj.value = bool(1)
180		else:
181	1	obj.value = bool(0)
182	1	elif ntag in ("ByteString", "String"):
183		mytext = val.text
184		if mytext is None: # support importing null strings
185		mytext = ""
186		mytext = mytext.replace('\n', '').replace('\r', '')
187		# obj.value.append('b"{}"'.format(mytext))
188		obj.value = mytext
189		elif ntag == "ListOfExtensionObject":
190		obj.value, obj.valuetype = self._parse_list_of_extension_object(el)
191		elif ntag == "ListOfLocalizedText":
192		obj.value = self._parse_list_of_localized_text(el)
193		else:
194		self.logger.info("Value type not implemented: %s", ntag)
195
196		def _get_text(self, el):
197		txt = ""
198		for text in el.itertext():
199		txt += text
200		return txt
201
202		def _parse_list_of_localized_text(self, el):
203		value = []
204		for localized_text_list in el:
205		for localized_text in localized_text_list:
206		ntag = self._retag.match(localized_text.tag).groups()[1]
207		for child in localized_text:
208		ntag = self._retag.match(child.tag).groups()[1]
209		if ntag == 'Text':
210		value.append(self._get_text(child))
211		return value
212
213		def _parse_list_of_extension_object(self, el):
214		'''
215		Parse a uax:ListOfExtensionObject Value
216
217		Return an array with a value of each uax:ExtensionObject// (each element is convert to a netry in a dict.
218		also the valuetype is returned. The valuetype is uax:ExtensionObject/*/tag()
219		'''
220		value = []
221		valuetype = None
222		for extension_object_list in el:
223		for extension_object in extension_object_list:
224		extension_object.find('Body')
225		for extension_object_part in extension_object:
226		ntag = self._retag.match(extension_object_part.tag).groups()[1]
227		if ntag == 'Body':
228		data = {}
229		ntag = self._retag.match(extension_object_part.find('*').tag).groups()[1]
230		valuetype = ntag
231		for body_item in extension_object_part.findall('/'):
232		ntag = self._retag.match(body_item.tag).groups()[1]
233
234		child = body_item.find('*')
235		if child is not None:
236		data[ntag] = self._get_text(child)
237		else:
238		data[ntag] = self._get_text(body_item)
239		value.append(data)
240		return value, valuetype
241
242		def _parse_refs(self, el, obj):
243		for ref in el:
244		if ref.attrib["ReferenceType"] == "HasTypeDefinition":
245		obj.typedef = self._get_node_id(ref.text)
246		elif "IsForward" in ref.attrib and ref.attrib["IsForward"] == "false":
247		# if obj.parent:
248		# sys.stderr.write("Parent is already set with: "+ obj.parent + " " + ref.text + "\n")
249		obj.parent = self._get_node_id(ref.text)
250		obj.parentlink = ref.attrib["ReferenceType"]
251		else:
252		struct = RefStruct()
253		if "IsForward" in ref.attrib:
254		struct.forward = ref.attrib["IsForward"]
255		struct.target = self._get_node_id(ref.text)
256		struct.reftype = ref.attrib["ReferenceType"]
257		obj.refs.append(struct)
258

FreeOpcUa / python-opcua

Pull Request — master (#252)

XMLParser._get_node_id() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like