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

Completed

Push — master ( 777e81...136b6f )

by Olivier

created 2016-10-21 14:46 UTC

XMLParser.get_node_datas() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0175

Importance

Changes

Metric	Value
cc	3
dl	0
loc	9
ccs	7
cts	8
cp	0.875
crap	3.0175
rs	9.6666
c	0
b	0
f	0

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

import xml.etree.ElementTree as ET


def _to_bool(val):
    if val in ("True", "true", "on", "On", "1"):
        return True
    else:
        return False


def ua_type_to_python(val, uatype):
    if uatype.startswith("Int") or uatype.startswith("UInt"):
        return int(val)
    elif uatype.lower().startswith("bool"):
        return _to_bool(val)
    elif uatype in ("Double", "Float"):
        return float(val)
    elif uatype in ("String"):
        return val
    elif uatype in ("Bytes", "Bytes", "ByteString", "ByteArray"):
        if sys.version_info.major > 2:
            return bytes(val, 'utf8')
        else:
            return val
    else:
        raise Exception("uatype nopt handled", uatype, " for val ", val)


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 = []

    def __str__(self):
        return "NodeData(nodeid:{})".format(self.nodeid)
    __repr__ = __str__


class RefStruct(object):

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


class ExtObj(object):

    def __init__(self):
        self.typeid = None
        self.objname = None
        self.bodytype = None
        self.body = {}


class XMLParser(object):

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

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

    def get_used_namespaces(self):
        """
        Return the used namespace uris in this import file
        """
        namespaces_uris = []
        for child in self.root:
            name = self._retag.match(child.tag).groups()[1]
            if name == 'NamespaceUris':
                namespaces_uris = [ns_element.text for ns_element in child]
                break
        return namespaces_uris

    def get_aliases(self):
        """
        Return the used node aliases in this import file
        """
        aliases = {}
        for child in self.root:
            name = self._retag.match(child.tag).groups()[1]
            if name == 'Aliases':
                for el in child:
                    aliases[el.attrib["Alias"]] = el.text
                break
        return aliases

    def get_node_datas(self):
        nodes = []
        for child in self.root:
            name = self._retag.match(child.tag).groups()[1]
            if name not in ["Aliases", "NamespaceUris"]:
                node = self._parse_node(name, child)
                nodes.append(node)
        
        return nodes

    def __next__(self):
        while True:
            if sys.version_info[0] < 3:
                child = self.it.next()
            else:
                child = self.it.__next__()
            return child

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

    def _parse_node(self, name, child):
        """
        Parse a XML node and create a NodeData object.
        """
        obj = NodeData()
        obj.nodetype = name
        for key, val in child.attrib.items():
            self._set_attr(key, val, obj)
        self.logger.info("\n     Parsing node: %s %s", obj.nodeid, obj.browsename)
        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 = val
        elif key == "BrowseName":
            obj.browsename = val
        elif key == "SymbolicName":
            obj.symname = val
        elif key == "ParentNodeId":
            obj.parent = val
        elif key == "DataType":
            obj.datatype = val
        elif key == "IsAbstract":
            obj.abstract = _to_bool(val)
        elif key == "Executable":
            obj.executable = _to_bool(val)
        elif key == "EventNotifier":
            obj.eventnotifier = int(val)
        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 = _to_bool(val)
        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):
        self.logger.info("Parsing value")
        for val in el:
            self.logger.info("tag %s", val.tag)
            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"):
                obj.value = _to_bool(val.text)
            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 in ("DateTime"):
                obj.value = val.text
            elif ntag in ("Guid"):
                self._parse_value(val, obj)
                obj.valuetype = obj.datatype  # override parsed string type to guid
            elif ntag == "ListOfExtensionObject":
                obj.value = self._parse_list_of_extension_object(el)
            elif ntag == "ListOfLocalizedText":
                obj.value = self._parse_list_of_localized_text(el)
            elif ntag.startswith("ListOf"):
                obj.value = self._parse_list(el[0])
            elif ntag == "ExtensionObject":
                obj.value = self._parse_extension_object(el)
            else:
                self.logger.warning("Value type not implemented: '%s'", ntag)

    def _get_text(self, el):
        txtlist = [txt.strip() for txt in el.itertext()]
        return "".join(txtlist)

    def _parse_list(self, el):
        value = []
        for val_el in el:
            ntag = self._retag.match(val_el.tag).groups()[1]
            if ntag.startswith("ListOf"):
                val = self._parse_list(val_el)
            else:
                val = ua_type_to_python(val_el.text, ntag)
            value.append(val)
        return value

    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 list of ExtObj
        """
        value = []
        for extension_object_list in el:
            for extension_object in extension_object_list:
                ext_obj = self._parse_ext_obj(extension_object)
                value.append(ext_obj)
        return value

    def _parse_extension_object(self, el):
        for ext_obj in el:
            return self._parse_ext_obj(ext_obj)

    def _parse_ext_obj(self, el):
        ext = ExtObj()
        for extension_object_part in el:
            ntag = self._retag.match(extension_object_part.tag).groups()[1]
            if ntag == 'TypeId':
                ntag = self._retag.match(extension_object_part.find('*').tag).groups()[1]
                ext.typeid = self._get_text(extension_object_part)
            elif ntag == 'Body':
                ext.objname = self._retag.match(extension_object_part.find('*').tag).groups()[1]
                ext.body = self._parse_body(extension_object_part)
            else:
                print("Uknown ndtag", ntag)
        return ext

    def _parse_body(self, el):
        body = []
        for body_item in el:
            otag = self._retag.match(body_item.tag).groups()[1]
            childs = [i for i in body_item]
            if not childs:
                val = self._get_text(body_item)
            else:
                val = self._parse_body(body_item)
            if val:
                body.append((otag, val))
        return body

    def _parse_refs(self, el, obj):
        for ref in el:
            if ref.attrib["ReferenceType"] == "HasTypeDefinition":
                obj.typedef = ref.text
            elif "IsForward" in ref.attrib and ref.attrib["IsForward"] in ("false", "False"):
                # if obj.parent:
                    # sys.stderr.write("Parent is already set with: "+ obj.parent + " " + ref.text + "\n")
                obj.parent = ref.text
                obj.parentlink = ref.attrib["ReferenceType"]
            else:
                struct = RefStruct()
                if "IsForward" in ref.attrib:
                    struct.forward = ref.attrib["IsForward"]
                struct.target = 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	def _to_bool(val):
12		if val in ("True", "true", "on", "On", "1"):
13	1	return True
14	1	else:
15	1	return False
16	1
17	1
18	1	def ua_type_to_python(val, uatype):
19	1	if uatype.startswith("Int") or uatype.startswith("UInt"):
20	1	return int(val)
21	1	elif uatype.lower().startswith("bool"):
22	1	return _to_bool(val)
23	1	elif uatype in ("Double", "Float"):
24	1	return float(val)
25	1	elif uatype in ("String"):
26		return val
27		elif uatype in ("Bytes", "Bytes", "ByteString", "ByteArray"):
28	1	if sys.version_info.major > 2:
29	1	return bytes(val, 'utf8')
30	1	else:
31	1	return val
32	1	else:
33	1	raise Exception("uatype nopt handled", uatype, " for val ", val)
34	1
35	1
36		class NodeData(object):
37
38	1	def __init__(self):
39	1	self.nodetype = None
40	1	self.nodeid = None
41		self.browsename = None
42		self.displayname = None
43	1	self.symname = None # FIXME: this param is never used, why?
44		self.parent = None
45		self.parentlink = None
46	1	self.desc = ""
47		self.typedef = None
48	1	self.refs = []
49		self.nodeclass = None
50		self.eventnotifier = 0
51
52		# variable
53		self.datatype = None
54	1	self.rank = -1 # check default value
55		self.value = None
56	1	self.valuetype = None
57	1	self.dimensions = None
58	1	self.accesslevel = None
59	1	self.useraccesslevel = None
60	1	self.minsample = None
61
62	1	# referencetype
63	1	self.inversename = ""
64	1	self.abstract = False
65		self.symmetric = False
66	1
67	1	# datatype
68	1	self.definition = []
69
70	1	def __str__(self):
71	1	return "NodeData(nodeid:{})".format(self.nodeid)
72	1	__repr__ = __str__
73
74
75	1	class RefStruct(object):
76	1
77	1	def __init__(self):
78		self.reftype = None
79		self.forward = True
80		self.target = None
81	1
82	1
83		class ExtObj(object):
84	1
85		def __init__(self):
86		self.typeid = None
87	1	self.objname = None
88	1	self.bodytype = None
89	1	self.body = {}
90	1
91	1
92	1	class XMLParser(object):
93	1
94	1	def __init__(self, xmlpath):
95	1	self.logger = logging.getLogger(__name__)
96		self._retag = re.compile(r"(\{.\})(.)")
97	1	self.path = xmlpath
98	1
99	1	self.tree = ET.parse(xmlpath)
100	1	self.root = self.tree.getroot()
101	1	self.it = None
102	1
103		def get_used_namespaces(self):
104	1	"""
105		Return the used namespace uris in this import file
106	1	"""
107	1	namespaces_uris = []
108		for child in self.root:
109		name = self._retag.match(child.tag).groups()[1]
110		if name == 'NamespaceUris':
111		namespaces_uris = [ns_element.text for ns_element in child]
112		break
113		return namespaces_uris
114
115		def get_aliases(self):
116		"""
117		Return the used node aliases in this import file
118		"""
119		aliases = {}
120		for child in self.root:
121		name = self._retag.match(child.tag).groups()[1]
122		if name == 'Aliases':
123		for el in child:
124		aliases[el.attrib["Alias"]] = el.text
125		break
126		return aliases
127
128	1	def get_node_datas(self):
129	1	nodes = []
130		for child in self.root:
131	1	name = self._retag.match(child.tag).groups()[1]
132		if name not in ["Aliases", "NamespaceUris"]:
133	1	node = self._parse_node(name, child)
134	1	nodes.append(node)
135	1
136	1	return nodes
137	1
138	1	def __next__(self):
139		while True:
140		if sys.version_info[0] < 3:
141		child = self.it.next()
142		else:
143		child = self.it.__next__()
144		return child
145
146		def next(self): # support for python2
147	1	return self.__next__()
148	1
149	1	def _parse_node(self, name, child):
150	1	"""
151	1	Parse a XML node and create a NodeData object.
152	1	"""
153	1	obj = NodeData()
154		obj.nodetype = name
155	1	for key, val in child.attrib.items():
156		self._set_attr(key, val, obj)
157		self.logger.info("\n Parsing node: %s %s", obj.nodeid, obj.browsename)
158		obj.displayname = obj.browsename # give a default value to display name
159		for el in child:
160	1	self._parse_tag(el, obj)
161	1	return obj
162	1
163		def _set_attr(self, key, val, obj):
164	1	if key == "NodeId":
165		obj.nodeid = val
166	1	elif key == "BrowseName":
167		obj.browsename = val
168		elif key == "SymbolicName":
169		obj.symname = val
170		elif key == "ParentNodeId":
171		obj.parent = val
172		elif key == "DataType":
173		obj.datatype = val
174	1	elif key == "IsAbstract":
175	1	obj.abstract = _to_bool(val)
176	1	elif key == "Executable":
177	1	obj.executable = _to_bool(val)
178	1	elif key == "EventNotifier":
179		obj.eventnotifier = int(val)
180		elif key == "ValueRank":
181	1	obj.rank = int(val)
182	1	elif key == "ArrayDimensions":
183		obj.dimensions = [int(i) for i in val.split(",")]
184		elif key == "MinimumSamplingInterval":
185		obj.minsample = int(val)
186		elif key == "AccessLevel":
187		obj.accesslevel = int(val)
188		elif key == "UserAccessLevel":
189		obj.useraccesslevel = int(val)
190		elif key == "Symmetric":
191		obj.symmetric = _to_bool(val)
192		else:
193		self.logger.info("Attribute not implemented: %s:%s", key, val)
194
195		def _parse_tag(self, el, obj):
196		tag = self._retag.match(el.tag).groups()[1]
197
198		if tag == "DisplayName":
199		obj.displayname = el.text
200		elif tag == "Description":
201		obj.desc = el.text
202		elif tag == "References":
203		self._parse_refs(el, obj)
204		elif tag == "Value":
205		self._parse_value(el, obj)
206		elif tag == "InverseName":
207		obj.inversename = el.text
208		elif tag == "Definition":
209		for field in el:
210		obj.definition.append(field)
211		else:
212		self.logger.info("Not implemented tag: %s", el)
213
214		def _parse_value(self, el, obj):
215		self.logger.info("Parsing value")
216		for val in el:
217		self.logger.info("tag %s", val.tag)
218		ntag = self._retag.match(val.tag).groups()[1]
219		obj.valuetype = ntag
220		if ntag in ("Int8", "UInt8", "Int16", "UInt16", "Int32", "UInt32", "Int64", "UInt64"):
221		obj.value = int(val.text)
222		elif ntag in ("Float", "Double"):
223		obj.value = float(val.text)
224		elif ntag in ("Boolean"):
225		obj.value = _to_bool(val.text)
226		elif ntag in ("ByteString", "String"):
227		mytext = val.text
228		if mytext is None: # support importing null strings
229		mytext = ""
230		mytext = mytext.replace('\n', '').replace('\r', '')
231		# obj.value.append('b"{}"'.format(mytext))
232		obj.value = mytext
233		elif ntag in ("DateTime"):
234		obj.value = val.text
235		elif ntag in ("Guid"):
236		self._parse_value(val, obj)
237		obj.valuetype = obj.datatype # override parsed string type to guid
238		elif ntag == "ListOfExtensionObject":
239		obj.value = self._parse_list_of_extension_object(el)
240		elif ntag == "ListOfLocalizedText":
241		obj.value = self._parse_list_of_localized_text(el)
242		elif ntag.startswith("ListOf"):
243		obj.value = self._parse_list(el[0])
244		elif ntag == "ExtensionObject":
245		obj.value = self._parse_extension_object(el)
246		else:
247		self.logger.warning("Value type not implemented: '%s'", ntag)
248
249		def _get_text(self, el):
250		txtlist = [txt.strip() for txt in el.itertext()]
251		return "".join(txtlist)
252
253		def _parse_list(self, el):
254		value = []
255		for val_el in el:
256		ntag = self._retag.match(val_el.tag).groups()[1]
257		if ntag.startswith("ListOf"):
258		val = self._parse_list(val_el)
259		else:
260		val = ua_type_to_python(val_el.text, ntag)
261		value.append(val)
262		return value
263
264		def _parse_list_of_localized_text(self, el):
265		value = []
266		for localized_text_list in el:
267		for localized_text in localized_text_list:
268		ntag = self._retag.match(localized_text.tag).groups()[1]
269		for child in localized_text:
270		ntag = self._retag.match(child.tag).groups()[1]
271		if ntag == 'Text':
272		value.append(self._get_text(child))
273		return value
274
275		def _parse_list_of_extension_object(self, el):
276		"""
277		Parse a uax:ListOfExtensionObject Value
278		Return an list of ExtObj
279		"""
280		value = []
281		for extension_object_list in el:
282		for extension_object in extension_object_list:
283		ext_obj = self._parse_ext_obj(extension_object)
284		value.append(ext_obj)
285		return value
286
287		def _parse_extension_object(self, el):
288		for ext_obj in el:
289		return self._parse_ext_obj(ext_obj)
290
291		def _parse_ext_obj(self, el):
292		ext = ExtObj()
293		for extension_object_part in el:
294		ntag = self._retag.match(extension_object_part.tag).groups()[1]
295		if ntag == 'TypeId':
296		ntag = self._retag.match(extension_object_part.find('*').tag).groups()[1]
297		ext.typeid = self._get_text(extension_object_part)
298		elif ntag == 'Body':
299		ext.objname = self._retag.match(extension_object_part.find('*').tag).groups()[1]
300		ext.body = self._parse_body(extension_object_part)
301		else:
302		print("Uknown ndtag", ntag)
303		return ext
304
305		def _parse_body(self, el):
306		body = []
307		for body_item in el:
308		otag = self._retag.match(body_item.tag).groups()[1]
309		childs = [i for i in body_item]
310		if not childs:
311		val = self._get_text(body_item)
312		else:
313		val = self._parse_body(body_item)
314		if val:
315		body.append((otag, val))
316		return body
317
318		def _parse_refs(self, el, obj):
319		for ref in el:
320		if ref.attrib["ReferenceType"] == "HasTypeDefinition":
321		obj.typedef = ref.text
322		elif "IsForward" in ref.attrib and ref.attrib["IsForward"] in ("false", "False"):
323		# if obj.parent:
324		# sys.stderr.write("Parent is already set with: "+ obj.parent + " " + ref.text + "\n")
325		obj.parent = ref.text
326		obj.parentlink = ref.attrib["ReferenceType"]
327		else:
328		struct = RefStruct()
329		if "IsForward" in ref.attrib:
330		struct.forward = ref.attrib["IsForward"]
331		struct.target = ref.text
332		struct.reftype = ref.attrib["ReferenceType"]
333		obj.refs.append(struct)
334

FreeOpcUa / python-opcua

Push — master ( 777e81...136b6f )

XMLParser.get_node_datas() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like