Merge pull request #12 from clauspruefer/v1.0

V1.0

Author: clauspruefer

.github/workflows/pylint.yaml

@@ -23,4 +23,4 @@ jobs:
         pip install pylint
     - name: Analysing the code with pylint
       run: |
-        pylint --disable=W0622,R1710,R0902,W0612,C0103,C0114,C0115,C0116,C0209,R0801,R0903,R0205,R1737,R0913,W1202,W0246,W0223,W0221,W0104,W0102,W0613,E0401,E0611,E1101 $(git ls-files 'src/microparser.py')
+        pylint --disable=C0103,C0114,C0209,E0401,E1101,W0212,W0612,W1202,R0902 $(git ls-files 'src/')

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## Version 1.0
+
+- Add Virtual Environment install instructions
+- Add pylint linting / CI
+- Correct source according to pylint
+- Adapt test code
+
 ## Version 1.0rc1
 
 - Correct README.md (package name and version)

README.md

@@ -22,11 +22,20 @@ Or download the current Release Zip / Tarball @ [Release 1.0rc1](https://github.
 > Since Python 3.3 (PEP 405) Virtual Environments are proposed.
 
 ```bash
-# install into virtual environment
+# setup virtual-env
 python3 -m venv .xml-microparser
+
+# activate virtual-env
 source .xml-microparser/bin/activate
+
+# upgrade pip
 python3 -m pip install --upgrade pip
+
+# install xmlmicroparser module
 pip3 install xmlmicroparser
+
+# install dependencies
+pip3 install pytest pytest-pep8
 ```
 
 ## 2.1. Dependencies

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xmlmicroparser"
-version = "1.0rc1"
+version = "1.0"
 authors = [
   { name="Claus Prüfer", email="pruefer@webcodex.de" },
 ]

src/microparser.py

@@ -106,16 +106,17 @@ def build_serializer(self):
         """
         self._add_child_elements_recursive(self.get_root_element())
 
-    def get_element_by_id(self, id):
+    def get_element_by_id(self, element_id):
         """ Get element by internal numerical id.
 
-        :param int id: internal numerical element id
+        :param int element_id: internal numerical element id
         :return: found element
         :rtype: Element or None
         """
         for element in self._elements:
-            if element.get_id() == id:
+            if element.get_id() == element_id:
                 return element
+        return None
 
     def get_element_by_name(self, name):
         """ Get element by xml element id.
@@ -127,6 +128,7 @@ def get_element_by_name(self, name):
         for element in self._elements:
             if element.get_name() == name:
                 return element
+        return None
 
     def get_elements(self):
         """ Return processed elements list.
@@ -144,15 +146,15 @@ def get_root_element(self):
         """
         return self._elements[0]
 
-    def get_child_elements_by_id(self, id):
+    def get_child_elements_by_id(self, element_id):
         """ Return elements children searched by element numerical id.
 
-        :param int id: element internal numerical id
+        :param int element_id: element internal numerical id
         :yield: found item
         :rtype: elements (list of objects) or None
         """
         for item in self._elements:
-            if item.get_parent_id() == id:
+            if item.get_parent_id() == element_id:
                 yield item
 
     def get_child_element(self, name):
@@ -179,8 +181,8 @@ def process_json(self):
                 if element.get_child_element_count() == 0:
                     process_ids.append(element.get_id())
 
-            for id in process_ids:
-                root_element.get_element_by_element_id(id).json_transform()
+            for element_id in process_ids:
+                root_element.get_element_by_element_id(element_id).json_transform()
 
         root_element.set_json_attributes()
 
@@ -253,10 +255,10 @@ def _current_item_id_gen(self):
 
         :rtype: Iterator[int]
         """
-        id = 0
+        element_id = 0
         while True:
-            id += 1
-            yield id
+            element_id += 1
+            yield element_id
 
     def _parse_line(self, line):
         """ Parse single xml data line.
@@ -275,7 +277,7 @@ def _parse_line(self, line):
 
             args = {
                 'name': element_id,
-                'id': self._current_item_id.__next__(),
+                'element_id': self._current_item_id.__next__(),
                 'line_nr': line_nr,
                 'parent_id': self._get_last_unclosed_element_id()
             }
@@ -387,6 +389,7 @@ def get_element_by_element_id(self, element_id):
         for element in self.iterate():
             if element.get_id() == element_id:
                 return element
+        return None
 
     def get_element_by_element_name(self, element_name):
         """ Get element by element numerical id.
@@ -397,6 +400,7 @@ def get_element_by_element_name(self, element_name):
         for element in self.iterate():
             if element.get_name() == element_name:
                 return element
+        return None
 
 
 class Element(Serializer):
@@ -407,10 +411,10 @@ class Element(Serializer):
     part of this class.
     """
 
-    def __init__(self, *, name, id, line_nr, parent_id):
+    def __init__(self, *, name, element_id, line_nr, parent_id):
         """
         :param str name: xml element name (id)
-        :param int id: xml element internal processing id
+        :param int element_id: xml element internal processing id
         :param int line_nr: line number of found xml opening tag in payload data
         :param int parent_id: parent element numerical id
         :ivar str _name: xml element id
@@ -423,14 +427,14 @@ def __init__(self, *, name, id, line_nr, parent_id):
         """
 
         assert isinstance(name, str), 'name must be string type'
-        assert isinstance(id, int), 'id must be int type'
+        assert isinstance(element_id, int), 'id must be int type'
         assert isinstance(line_nr, int), 'id must be int type'
 
         if parent_id is not None:
             assert isinstance(parent_id, int), 'parent_id must be int type'
 
         self._name = name
-        self._id = id
+        self._id = element_id
         self._parent_id = parent_id
         self._parent_element = None
         self._attributes = {}
@@ -547,6 +551,7 @@ def get_attribute_by_name(self, name):
         """
         if name in self._attributes:
             return self._attributes[name]
+        return None
 
     def get_attributes(self):
         """ Get attributes.

test/integration/test_parser.py

@@ -5,7 +5,7 @@
 
 
 def check_element(element, properties):
-    assert element._id == properties['id']
+    assert element._id == properties['element_id']
     assert element._name == properties['name']
     assert element._attributes == properties['attributes']
     assert element._parent_id == properties['parent_id']
@@ -32,7 +32,7 @@ def test_basic_parsing(self, caplog):
         elements = p.get_elements()
 
         props1 = {
-            'id': 1,
+            'element_id': 1,
             'name': 'outertag',
             'attributes': {'test1': 'string1', 'test2': 'string2'},
             'parent_id': None,
@@ -44,7 +44,7 @@ def test_basic_parsing(self, caplog):
         check_element(elements[0], props1)
 
         props2 = {
-            'id': 2,
+            'element_id': 2,
             'name': 'innertag1',
             'attributes': {},
             'parent_id': 1,
@@ -56,7 +56,7 @@ def test_basic_parsing(self, caplog):
         check_element(elements[1], props2)
 
         props3 = {
-            'id': 3,
+            'element_id': 3,
             'name': 'innertag2',
             'attributes': {},
             'parent_id': 2,

test/unit/test_element.py

@@ -12,14 +12,14 @@ def test_attribute_add_valid_types(self, caplog):
 
         e = microparser.Element(
             name = 'element1',
-            id = 1,
+            element_id = 1,
             line_nr = 1,
             parent_id = None
         )
 
         e = microparser.Element(
             name = 'element2',
-            id = 100,
+            element_id = 100,
             line_nr = 10,
             parent_id = 10
         )
@@ -31,39 +31,39 @@ def test_attribute_add_invalid_types(self, caplog):
         with pytest.raises(AssertionError):
             e = microparser.Element(
                 name = 1,
-                id = 1,
+                element_id = 1,
                 line_nr = 1,
                 parent_id = None
             )
 
         with pytest.raises(AssertionError):
             e = microparser.Element(
                 name = 'element',
-                id = 'name',
+                element_id = 'name',
                 line_nr = 1,
                 parent_id = None
             )
 
         with pytest.raises(AssertionError):
             e = microparser.Element(
                 name = 'element',
-                id = 1,
+                element_id = 1,
                 line_nr = {},
                 parent_id = None
             )
 
         with pytest.raises(AssertionError):
             e = microparser.Element(
                 name = None,
-                id = 1,
+                element_id = 1,
                 line_nr = 1,
                 parent_id = 10
             )
 
         with pytest.raises(AssertionError):
             e = microparser.Element(
                 name = 'element',
-                id = 1,
+                element_id = 1,
                 line_nr = 1,
                 parent_id = 'test'
             )
@@ -77,7 +77,7 @@ def test_get_element_by_id(self, caplog):
         p._elements.append(
             microparser.Element(
                 name = 'element1',
-                id = 101,
+                element_id = 101,
                 line_nr = 100,
                 parent_id = None
             )
@@ -86,7 +86,7 @@ def test_get_element_by_id(self, caplog):
         p._elements.append(
             microparser.Element(
                 name = 'element2',
-                id = 210,
+                element_id = 210,
                 line_nr = 101,
                 parent_id = 101
             )
@@ -95,7 +95,7 @@ def test_get_element_by_id(self, caplog):
         p._elements.append(
             microparser.Element(
                 name = 'element3',
-                id = 28,
+                element_id = 28,
                 line_nr = 200,
                 parent_id = 101
             )