XMLParser._parse_node() - Code Metrics - Inspection of "Default value on import" - FreeOpcUa/python-opcua - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#339)

unknown

created 2016-10-24 14:21 UTC

XMLParser._parse_node() F

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	19.125

Importance

Changes

Metric	Value
cc	9
dl	0
loc	30
ccs	12
cts	24
cp	0.5
crap	19.125
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


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):
    """
    XML Parser class which traverses an XML document to collect all information required for creating an address space
    """

    def __init__(self, xmlpath, enable_default_values=False):
        """
        Constructor for XML parser
        Args:
            xmlpath: path to the xml document; the document must be in OPC UA defined format
            enable_default_values: false results in xml variable nodes with no Value element being converted to Null
                                   true results in XML variable nodes to keep defined datatype with a default value
        """
        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 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

        # 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 ("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 == "LocalizedText":
                obj.value = self._parse_body(el)
            elif ntag == "NodeId":
                obj.Value = self._parse_body(el)
            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	XML Parser class which traverses an XML document to collect all information required for creating an address space
95	1	"""
96
97	1	def __init__(self, xmlpath, enable_default_values=False):
98	1	"""
99	1	Constructor for XML parser
100	1	Args:
101	1	xmlpath: path to the xml document; the document must be in OPC UA defined format
102	1	enable_default_values: false results in xml variable nodes with no Value element being converted to Null
103		true results in XML variable nodes to keep defined datatype with a default value
104	1	"""
105		self.logger = logging.getLogger(__name__)
106	1	self._retag = re.compile(r"(\{.\})(.)")
107	1	self.path = xmlpath
108		self.enable_default_values = enable_default_values
109
110		self.tree = ET.parse(xmlpath)
111		self.root = self.tree.getroot()
112		self.it = None
113
114		def get_used_namespaces(self):
115		"""
116		Return the used namespace uris in this import file
117		"""
118		namespaces_uris = []
119		for child in self.root:
120		name = self._retag.match(child.tag).groups()[1]
121		if name == 'NamespaceUris':
122		namespaces_uris = [ns_element.text for ns_element in child]
123		break
124		return namespaces_uris
125
126		def get_aliases(self):
127		"""
128	1	Return the used node aliases in this import file
129	1	"""
130		aliases = {}
131	1	for child in self.root:
132		name = self._retag.match(child.tag).groups()[1]
133	1	if name == 'Aliases':
134	1	for el in child:
135	1	aliases[el.attrib["Alias"]] = el.text
136	1	break
137	1	return aliases
138	1
139		def get_node_datas(self):
140		nodes = []
141		for child in self.root:
142		name = self._retag.match(child.tag).groups()[1]
143		if name not in ["Aliases", "NamespaceUris"]:
144		node = self._parse_node(name, child)
145		nodes.append(node)
146
147	1	return nodes
148	1
149	1	def __next__(self):
150	1	while True:
151	1	if sys.version_info[0] < 3:
152	1	child = self.it.next()
153	1	else:
154		child = self.it.__next__()
155	1	return child
156
157		def next(self): # support for python2
158		return self.__next__()
159
160	1	def _parse_node(self, name, child):
161	1	"""
162	1	Parse a XML node and create a NodeData object.
163		"""
164	1	obj = NodeData()
165		obj.nodetype = name
166	1	for key, val in child.attrib.items():
167		self._set_attr(key, val, obj)
168		self.logger.info("\n Parsing node: %s %s", obj.nodeid, obj.browsename)
169		obj.displayname = obj.browsename # give a default value to display name
170
171		# set default Value based on type; avoids nodes with Value=None being converted to type Null by server
172		if self.enable_default_values:
173		if obj.datatype is not None:
174	1	if obj.datatype in ("Int8", "UInt8", "Int16", "UInt16", "Int32", "UInt32", "Int64", "UInt64"):
175	1	obj.valuetype = obj.datatype
176	1	obj.value = 0
177	1	elif obj.datatype in ("Float", "Double"):
178	1	obj.valuetype = obj.datatype
179		obj.value = 0.0
180		elif obj.datatype in ("Boolean"):
181	1	obj.valuetype = obj.datatype
182	1	obj.value = False
183		elif obj.datatype in ("ByteString", "String"):
184		obj.valuetype = obj.datatype
185		obj.value = ""
186
187		for el in child:
188		self._parse_tag(el, obj)
189		return obj
190
191		def _set_attr(self, key, val, obj):
192		if key == "NodeId":
193		obj.nodeid = val
194		elif key == "BrowseName":
195		obj.browsename = val
196		elif key == "SymbolicName":
197		obj.symname = val
198		elif key == "ParentNodeId":
199		obj.parent = val
200		elif key == "DataType":
201		obj.datatype = val
202		elif key == "IsAbstract":
203		obj.abstract = _to_bool(val)
204		elif key == "Executable":
205		obj.executable = _to_bool(val)
206		elif key == "EventNotifier":
207		obj.eventnotifier = int(val)
208		elif key == "ValueRank":
209		obj.rank = int(val)
210		elif key == "ArrayDimensions":
211		obj.dimensions = [int(i) for i in val.split(",")]
212		elif key == "MinimumSamplingInterval":
213		obj.minsample = int(val)
214		elif key == "AccessLevel":
215		obj.accesslevel = int(val)
216		elif key == "UserAccessLevel":
217		obj.useraccesslevel = int(val)
218		elif key == "Symmetric":
219		obj.symmetric = _to_bool(val)
220		else:
221		self.logger.info("Attribute not implemented: %s:%s", key, val)
222
223		def _parse_tag(self, el, obj):
224		tag = self._retag.match(el.tag).groups()[1]
225
226		if tag == "DisplayName":
227		obj.displayname = el.text
228		elif tag == "Description":
229		obj.desc = el.text
230		elif tag == "References":
231		self._parse_refs(el, obj)
232		elif tag == "Value":
233		self._parse_value(el, obj)
234		elif tag == "InverseName":
235		obj.inversename = el.text
236		elif tag == "Definition":
237		for field in el:
238		obj.definition.append(field)
239		else:
240		self.logger.info("Not implemented tag: %s", el)
241
242		def _parse_value(self, el, obj):
243		self.logger.info("Parsing value")
244		for val in el:
245		self.logger.info("tag %s", val.tag)
246		ntag = self._retag.match(val.tag).groups()[1]
247		obj.valuetype = ntag
248		if ntag in ("Int8", "UInt8", "Int16", "UInt16", "Int32", "UInt32", "Int64", "UInt64"):
249		obj.value = int(val.text)
250		elif ntag in ("Float", "Double"):
251		obj.value = float(val.text)
252		elif ntag in ("Boolean"):
253		obj.value = _to_bool(val.text)
254		elif ntag in ("ByteString", "String"):
255		mytext = val.text
256		if mytext is None: # support importing null strings
257		mytext = ""
258		mytext = mytext.replace('\n', '').replace('\r', '')
259		# obj.value.append('b"{}"'.format(mytext))
260		obj.value = mytext
261		elif ntag in ("DateTime"):
262		obj.value = val.text
263		elif ntag in ("Guid"):
264		self._parse_value(val, obj)
265		obj.valuetype = obj.datatype # override parsed string type to guid
266		elif ntag == "LocalizedText":
267		obj.value = self._parse_body(el)
268		elif ntag == "NodeId":
269		obj.Value = self._parse_body(el)
270		elif ntag == "ListOfExtensionObject":
271		obj.value = self._parse_list_of_extension_object(el)
272		elif ntag == "ListOfLocalizedText":
273		obj.value = self._parse_list_of_localized_text(el)
274		elif ntag.startswith("ListOf"):
275		obj.value = self._parse_list(el[0])
276		elif ntag == "ExtensionObject":
277		obj.value = self._parse_extension_object(el)
278		else:
279		self.logger.warning("Value type not implemented: '%s'", ntag)
280
281		def _get_text(self, el):
282		txtlist = [txt.strip() for txt in el.itertext()]
283		return "".join(txtlist)
284
285		def _parse_list(self, el):
286		value = []
287		for val_el in el:
288		ntag = self._retag.match(val_el.tag).groups()[1]
289		if ntag.startswith("ListOf"):
290		val = self._parse_list(val_el)
291		else:
292		val = ua_type_to_python(val_el.text, ntag)
293		value.append(val)
294		return value
295
296		def _parse_list_of_localized_text(self, el):
297		value = []
298		for localized_text_list in el:
299		for localized_text in localized_text_list:
300		ntag = self._retag.match(localized_text.tag).groups()[1]
301		for child in localized_text:
302		ntag = self._retag.match(child.tag).groups()[1]
303		if ntag == 'Text':
304		value.append(self._get_text(child))
305		return value
306
307		def _parse_list_of_extension_object(self, el):
308		"""
309		Parse a uax:ListOfExtensionObject Value
310		Return an list of ExtObj
311		"""
312		value = []
313		for extension_object_list in el:
314		for extension_object in extension_object_list:
315		ext_obj = self._parse_ext_obj(extension_object)
316		value.append(ext_obj)
317		return value
318
319		def _parse_extension_object(self, el):
320		for ext_obj in el:
321		return self._parse_ext_obj(ext_obj)
322
323		def _parse_ext_obj(self, el):
324		ext = ExtObj()
325		for extension_object_part in el:
326		ntag = self._retag.match(extension_object_part.tag).groups()[1]
327		if ntag == 'TypeId':
328		ntag = self._retag.match(extension_object_part.find('*').tag).groups()[1]
329		ext.typeid = self._get_text(extension_object_part)
330		elif ntag == 'Body':
331		ext.objname = self._retag.match(extension_object_part.find('*').tag).groups()[1]
332		ext.body = self._parse_body(extension_object_part)
333		else:
334		print("Uknown ndtag", ntag)
335		return ext
336
337		def _parse_body(self, el):
338		body = []
339		for body_item in el:
340		otag = self._retag.match(body_item.tag).groups()[1]
341		childs = [i for i in body_item]
342		if not childs:
343		val = self._get_text(body_item)
344		else:
345		val = self._parse_body(body_item)
346		if val:
347		body.append((otag, val))
348		return body
349
350		def _parse_refs(self, el, obj):
351		for ref in el:
352		if ref.attrib["ReferenceType"] == "HasTypeDefinition":
353		obj.typedef = ref.text
354		elif "IsForward" in ref.attrib and ref.attrib["IsForward"] in ("false", "False"):
355		# if obj.parent:
356		# sys.stderr.write("Parent is already set with: "+ obj.parent + " " + ref.text + "\n")
357		obj.parent = ref.text
358		obj.parentlink = ref.attrib["ReferenceType"]
359		else:
360		struct = RefStruct()
361		if "IsForward" in ref.attrib:
362		struct.forward = ref.attrib["IsForward"]
363		struct.target = ref.text
364		struct.reftype = ref.attrib["ReferenceType"]
365		obj.refs.append(struct)
366

FreeOpcUa / python-opcua

Pull Request — master (#339)

XMLParser._parse_node() F

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like