fix #15 prevent from parsing inherited constructors (#16)

* fix #15 prevent from parsing inherited constructors

* account for nested classes

Author: lucsorel

README.md

@@ -179,6 +179,7 @@ poetry run python -m pytest -v --cov=py2puml --cov-branch --cov-report term-miss
 
 # Changelog
 
+* `0.5.1`: prevent from parsing inherited constructors
 * `0.5.0`: handle instance attributes in class constructors, add code coverage of unit tests
 * `0.4.0`: add a simple CLI
 * `0.3.1`: inspect sub-folders recursively

py2puml/cli.py

@@ -9,7 +9,7 @@
 def run():
     argparser = ArgumentParser(description='Generate PlantUML class diagrams to document your Python application.')
 
-    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.5.0')
+    argparser.add_argument('-v', '--version', action='version', version='py2puml 0.5.1')
     argparser.add_argument('path', metavar='path', type=str, help='the path of the domain')
     argparser.add_argument('module', metavar='module', type=str, help='the module of the domain', default=None)
 

py2puml/parsing/parseclassconstructor.py

@@ -17,7 +17,17 @@ def parse_class_constructor(
     root_module_name: str
 ) -> Tuple[List[UmlAttribute], Dict[str, UmlRelation]]:
     constructor = getattr(class_type, '__init__', None)
-    if constructor is None or not hasattr(constructor, '__code__'):
+    # conditions to meet in order to parse the AST of a constructor 
+    if (
+        # the constructor must be defined
+        constructor is None
+    ) or (
+        # the constructor's source code must be available
+        not hasattr(constructor, '__code__')
+    ) or (
+        # the constructor must belong to the parsed class (not its parent's one)
+        not constructor.__qualname__.endswith(f'{class_type.__name__}.__init__')
+    ):
         return [], {}
 
     constructor_source: str = dedent(getsource(constructor.__code__))

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "py2puml"
-version = "0.5.0"
+version = "0.5.1"
 description = "Generate PlantUML class diagrams to document your Python application."
 keywords = ["class diagram", "PlantUML", "documentation", "inspection", "AST"]
 readme = "README.md"

tests/modules/withinheritedconstructor/metricorigin.py

@@ -0,0 +1,4 @@
+from .point import Origin
+
+class MetricOrigin(Origin):
+    unit: str = 'm'

tests/modules/withinheritedconstructor/point.py

@@ -0,0 +1,8 @@
+
+class Point:
+    def __init__(self, x: float=0, y: float=0):
+        self.x = x
+        self.y = y
+
+class Origin(Point):
+    is_origin: bool = True

tests/py2puml/inspection/test_inspectclass.py

@@ -27,8 +27,8 @@ def test_inspect_module_should_find_static_and_instance_attributes():
     coordinates_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withconstructor.Coordinates']
     assert len(coordinates_umlitem.attributes) == 2, '2 attributes of Coordinates must be inspected'
     x_attribute, y_attribute = coordinates_umlitem.attributes
-    assert_attribute(x_attribute, 'x', 'float', False)
-    assert_attribute(y_attribute, 'y', 'float', False)
+    assert_attribute(x_attribute, 'x', 'float', expected_staticity=False)
+    assert_attribute(y_attribute, 'y', 'float', expected_staticity=False)
 
     # Point UmlClass
     point_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withconstructor.Point']
@@ -57,7 +57,7 @@ def test_inspect_module_should_find_static_and_instance_attributes():
             if attribute.name == attribute_name
         ), None)
         assert point_attribute is not None, f'attribute {attribute_name} must be detected'
-        assert_attribute(point_attribute, attribute_name, atrribute_type, attribute_staticity)
+        assert_attribute(point_attribute, attribute_name, atrribute_type, expected_staticity=attribute_staticity)
 
     # Coordinates is a component of Point
     assert len(domain_relations) == 1, '1 composition'
@@ -67,3 +67,39 @@ def test_inspect_module_should_find_static_and_instance_attributes():
         'tests.modules.withconstructor.Coordinates',
         RelType.COMPOSITION
     )
+
+def test_inspect_module_parse_class_constructor_should_not_process_inherited_constructor():
+    domain_items_by_fqn: Dict[str, UmlItem] = {}
+    domain_relations: List[UmlRelation] = []
+    # inspects the two sub-modules
+    inspect_module(
+        import_module('tests.modules.withinheritedconstructor.point'),
+        'tests.modules.withinheritedconstructor.point',
+        domain_items_by_fqn, domain_relations
+    )
+    inspect_module(
+        import_module('tests.modules.withinheritedconstructor.metricorigin'),
+        'tests.modules.withinheritedconstructor.metricorigin',
+        domain_items_by_fqn, domain_relations
+    )
+
+    assert len(domain_items_by_fqn) == 3, 'three classes must be inspected'
+
+    # Point UmlClass
+    point_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withinheritedconstructor.point.Point']
+    assert len(point_umlitem.attributes) == 2, '2 attributes of Point must be inspected'
+    x_attribute, y_attribute = point_umlitem.attributes
+    assert_attribute(x_attribute, 'x', 'float', expected_staticity=False)
+    assert_attribute(y_attribute, 'y', 'float', expected_staticity=False)
+
+    # Origin UmlClass
+    origin_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withinheritedconstructor.point.Origin']
+    assert len(origin_umlitem.attributes) == 1, '1 attribute of Origin must be inspected'
+    is_origin_attribute = origin_umlitem.attributes[0]
+    assert_attribute(is_origin_attribute, 'is_origin', 'bool', expected_staticity=True)
+
+    # MetricOrigin UmlClass
+    metric_origin_umlitem: UmlClass = domain_items_by_fqn['tests.modules.withinheritedconstructor.metricorigin.MetricOrigin']
+    assert len(metric_origin_umlitem.attributes) == 1, '1 attribute of MetricOrigin must be inspected'
+    unit_attribute = metric_origin_umlitem.attributes[0]
+    assert_attribute(unit_attribute, 'unit', 'str', expected_staticity=True)

tests/py2puml/inspection/test_inspectdataclass.py

@@ -28,13 +28,14 @@ def test_inspect_domain_definition_single_class_without_composition():
     assert umlclass.name == 'Contact'
     attributes = umlclass.attributes
     assert len(attributes) == 4, 'class has 4 attributes'
-    assert_attribute(attributes[0], 'full_name', 'str', False)
-    assert_attribute(attributes[1], 'age', 'int', False)
-    assert_attribute(attributes[2], 'weight', 'float', False)
-    assert_attribute(attributes[3], 'can_twist_tongue', 'bool', False)
+    assert_attribute(attributes[0], 'full_name', 'str', expected_staticity=False)
+    assert_attribute(attributes[1], 'age', 'int', expected_staticity=False)
+    assert_attribute(attributes[2], 'weight', 'float', expected_staticity=False)
+    assert_attribute(attributes[3], 'can_twist_tongue', 'bool', expected_staticity=False)
 
     assert len(domain_relations) == 0, 'no component must be detected in this class'
 
+
 def test_inspect_domain_definition_single_class_with_composition():
     domain_items_by_fqn: Dict[str, UmlItem] = {}
     domain_relations: List[UmlRelation] = []
@@ -61,6 +62,9 @@ def test_parse_inheritance_within_module():
     child_glowing_fish: UmlClass = umlitems_by_fqn[0]
     assert child_glowing_fish.name == 'GlowingFish'
     assert child_glowing_fish.fqn == 'tests.modules.withinheritancewithinmodule.GlowingFish'
+    assert len(child_glowing_fish.attributes) == 2
+    assert_attribute(child_glowing_fish.attributes[0], 'glow_for_hunting', 'bool', expected_staticity=False)
+    assert_attribute(child_glowing_fish.attributes[1], 'glow_for_mating', 'bool', expected_staticity=False)
 
     assert len(domain_relations) == 2, '2 inheritance relations must be inspected'
     parent_fish, parent_light = domain_relations

tests/py2puml/test__init__.py

@@ -2,7 +2,7 @@
 
 # Ensures the library version is modified in the pyproject.toml file when upgrading it (pull request)
 def test_version():
-    assert __version__ == '0.5.0'
+    assert __version__ == '0.5.1'
 
 # Description also output in the CLI
 def test_description():