XMLParser._parse_node() - Code Metrics - Inspection of "Add default value option to xml importer" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#337)

unknown

created 2016-10-18 20:40 UTC

XMLParser._parse_node() F

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	15.1349

Importance

Changes

Metric	Value
cc	9
dl	0
loc	30
ccs	15
cts	26
cp	0.5769
crap	15.1349
rs	3
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


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 ExtObj(object):

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


class XMLParser(object):

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

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

        self.it = iter(nodes)
        return self

    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

        # set default Value based on type; avoids nodes with Value=None being converted to type Null by server
        if self.enable_default_values:
            if obj.datatype is not None:
                if obj.datatype in ("Int8", "UInt8", "Int16", "UInt16", "Int32", "UInt32", "Int64", "UInt64"):
                    obj.valuetype = obj.datatype
                    obj.value = 0
                elif obj.datatype in ("Float", "Double"):
                    obj.valuetype = obj.datatype
                    obj.value = 0.0
                elif obj.datatype in ("Boolean"):
                    obj.valuetype = obj.datatype
                    obj.value = False
                elif obj.datatype in ("ByteString", "String"):
                    obj.valuetype = obj.datatype
                    obj.value = ""

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

FreeOpcUa / python-opcua

Pull Request — master (#337)

XMLParser._parse_node() F

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like