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

Completed

Pull Request — master (#327)

by Olivier

created 2016-10-15 08:28 UTC

XMLParser.iter() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
dl	0
loc	10
ccs	0
cts	10
cp	0
crap	12
rs	9.4285
c	1
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 = []

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

FreeOpcUa / python-opcua

Pull Request — master (#327)

XMLParser.__iter__() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

XMLParser.iter() A