Store only the direct parent of a feature (#25)

KIT-TVA · Sep 13, 2024 · 30d9cb1 · 30d9cb1
1 parent 29f9d98
commit 30d9cb1
Show file tree

Hide file tree

Showing 14 changed files with 275 additions and 298 deletions.
diff --git a/cfmtoolbox/models.py b/cfmtoolbox/models.py
@@ -35,7 +35,7 @@ class Feature:
     instance_cardinality: Cardinality
     group_type_cardinality: Cardinality
     group_instance_cardinality: Cardinality
-    parents: list["Feature"]
+    parent: "Feature | None"
     children: list["Feature"]
 
     def __str__(self) -> str:
@@ -44,10 +44,6 @@ def __str__(self) -> str:
     def is_required(self) -> bool:
         return self.instance_cardinality.intervals[0].lower != 0
 
-    def add_parent(self, parent: "Feature"):
-        if parent not in self.parents:
-            self.parents.append(parent)
-
     def add_child(self, child: "Feature"):
         if child not in self.children:
             self.children.append(child)

diff --git a/cfmtoolbox/plugins/debugging.py b/cfmtoolbox/plugins/debugging.py
@@ -14,7 +14,7 @@ def stringify_cfm(cfm: CFM | None) -> str:
 
     for feature in cfm.features:
         formatted_cfm += f"{feature}: instance [{feature.instance_cardinality}], group type [{feature.group_type_cardinality}], group instance [{feature.group_instance_cardinality}]\n"
-        formatted_cfm += stringify_list("parents", feature.parents)
+        formatted_cfm += f"- parent: {feature.parent}\n"
         formatted_cfm += stringify_list("children", feature.children) + "\n"
 
     formatted_cfm += stringify_list("Require constraints", cfm.require_constraints)

diff --git a/cfmtoolbox/plugins/featureide_import.py b/cfmtoolbox/plugins/featureide_import.py
@@ -73,7 +73,7 @@ def parse_feature(feature: Element) -> Feature:
         instance_cardinality=feature_cardinality,
         group_instance_cardinality=group_cardinality,
         group_type_cardinality=group_cardinality,
-        parents=[],
+        parent=None,
         children=[],
     )
 
@@ -84,7 +84,7 @@ def traverse_xml(element: Element | None, cfm: CFM) -> list[Feature]:
 
         for child in element:
             feature = parse_feature(child)
-            feature.add_parent(parent)
+            feature.parent = parent
             parent.add_child(feature)
             cfm.add_feature(feature)
             traverse_xml(child, cfm)

diff --git a/cfmtoolbox/plugins/json_import.py b/cfmtoolbox/plugins/json_import.py
@@ -38,7 +38,7 @@ def parse_cfm(serialized_cfm: JSON) -> CFM:
 
 
 def parse_root(serialized_root: JSON) -> list[Feature]:
-    root = parse_feature(serialized_root, parents=[])
+    root = parse_feature(serialized_root, parent=None)
 
     features = [root]
 
@@ -48,7 +48,7 @@ def parse_root(serialized_root: JSON) -> list[Feature]:
     return features
 
 
-def parse_feature(serialized_feature: JSON, /, parents: list[Feature]) -> Feature:
+def parse_feature(serialized_feature: JSON, /, parent: Feature | None) -> Feature:
     if not isinstance(serialized_feature, dict):
         raise TypeError(f"Feature must be an object: {serialized_feature}")
 
@@ -77,12 +77,12 @@ def parse_feature(serialized_feature: JSON, /, parents: list[Feature]) -> Featur
         instance_cardinality=instance_cardinality,
         group_type_cardinality=group_type_cardinality,
         group_instance_cardinality=group_instance_cardinality,
-        parents=parents,
+        parent=parent,
         children=[],
     )
 
     feature.children = [
-        parse_feature(serialized_child, parents=[feature])
+        parse_feature(serialized_child, parent=feature)
         for serialized_child in serialized_feature["children"]
     ]
 

diff --git a/cfmtoolbox/plugins/uvl_import.py b/cfmtoolbox/plugins/uvl_import.py
@@ -136,7 +136,7 @@ def exitFeature(self, ctx: UVLPythonParser.FeatureContext):
                 instance_cardinality,
                 group_type_cardinality,
                 group_instance_cardinality,
-                [],
+                None,
                 [],
             )
             self.feature_map[name] = feature
@@ -158,7 +158,7 @@ def exitFeature(self, ctx: UVLPythonParser.FeatureContext):
                     instance_cardinality,
                     Cardinality([Interval(0, new_groups)]),
                     Cardinality([]),
-                    [],
+                    None,
                     [],
                 )
                 min_cardinality = 0
@@ -200,7 +200,7 @@ def exitFeature(self, ctx: UVLPythonParser.FeatureContext):
                         Cardinality([Interval(0, None)]),
                         group_type_cardinality,
                         group_instance_cardinality,
-                        [],
+                        None,
                         features,
                     )
                     parent_feature.children.append(feature)
@@ -214,7 +214,7 @@ def exitFeature(self, ctx: UVLPythonParser.FeatureContext):
                         )
                     )
                     for child in features:
-                        child.parents = [feature]
+                        child.parent = feature
                         if len(child.instance_cardinality.intervals) > 0:
                             min_cardinality += child.instance_cardinality.intervals[
                                 0
@@ -225,7 +225,7 @@ def exitFeature(self, ctx: UVLPythonParser.FeatureContext):
                             else:
                                 max_cardinality = None
                 for child in parent_feature.children:
-                    child.parents = [parent_feature]
+                    child.parent = parent_feature
                 parent_feature.group_instance_cardinality = Cardinality(
                     [
                         Interval(
@@ -275,11 +275,11 @@ def exitFeature(self, ctx: UVLPythonParser.FeatureContext):
                     instance_cardinality,
                     group_type_cardinality,
                     group_instance_cardinality,
-                    [],
+                    None,
                     features,
                 )
                 for child in feature.children:
-                    child.parents = [feature]
+                    child.parent = feature
                 self.feature_map[name] = feature
                 self.features.append(feature)
                 self.cfm.features.append(feature)

diff --git a/tests/plugins/test_big_m.py b/tests/plugins/test_big_m.py
@@ -40,30 +40,30 @@ def test_replace_infinite_upper_bound_with_global_upper_bound():
         Cardinality([Interval(1, 1)]),
         Cardinality([Interval(1, 3)]),
         Cardinality([Interval(1, None)]),
-        [],
+        None,
         [
             Feature(
                 "Tomato",
                 Cardinality([Interval(0, None)]),
                 Cardinality([]),
                 Cardinality([]),
-                [],
+                None,
                 [],
             ),
             Feature(
                 "Lettuce",
                 Cardinality([Interval(0, None)]),
                 Cardinality([]),
                 Cardinality([]),
-                [],
+                None,
                 [],
             ),
             Feature(
                 "Onion",
                 Cardinality([Interval(0, 3)]),
                 Cardinality([]),
                 Cardinality([]),
-                [],
+                None,
                 [],
             ),
         ],

diff --git a/tests/plugins/test_debugging.py b/tests/plugins/test_debugging.py
@@ -19,47 +19,47 @@ def test_debug(capsys):
     expected_output = dedent("""\
     CFM:
     Sandwich: instance [1..1], group type [1..3], group instance [1..3]
-    - parents: 
+    - parent: None
     - children: Bread, CheeseMix, Veggies
 
     Bread: instance [1..1], group type [1..1], group instance [1..1]
-    - parents: Sandwich
+    - parent: Sandwich
     - children: Sourdough, Wheat
 
     Sourdough: instance [0..1], group type [], group instance []
-    - parents: Bread
+    - parent: Bread
     - children: 
 
     Wheat: instance [0..1], group type [], group instance []
-    - parents: Bread
+    - parent: Bread
     - children: 
 
     CheeseMix: instance [0..1], group type [1..3], group instance [1..3]
-    - parents: Sandwich
+    - parent: Sandwich
     - children: Cheddar, Swiss, Gouda
 
     Cheddar: instance [0..1], group type [], group instance []
-    - parents: CheeseMix
+    - parent: CheeseMix
     - children: 
 
     Swiss: instance [0..1], group type [], group instance []
-    - parents: CheeseMix
+    - parent: CheeseMix
     - children: 
 
     Gouda: instance [0..1], group type [], group instance []
-    - parents: CheeseMix
+    - parent: CheeseMix
     - children: 
 
     Veggies: instance [0..1], group type [1..2], group instance [1..2]
-    - parents: Sandwich
+    - parent: Sandwich
     - children: Lettuce, Tomato
 
     Lettuce: instance [0..1], group type [], group instance []
-    - parents: Veggies
+    - parent: Veggies
     - children: 
 
     Tomato: instance [0..1], group type [], group instance []
-    - parents: Veggies
+    - parent: Veggies
     - children: 
 
     - Require constraints: Sourdough => Cheddar, Tomato => Gouda, Swiss => Lettuce
@@ -91,7 +91,7 @@ def test_stringify_cfm():
     cfm_str = dedent("""\
     CFM:
     Sandwich: instance [1..0], group type [1..3], group instance [2..2]
-    - parents: 
+    - parent: None
     - children: 
 
     - Require constraints: Sandwich => Sandwich
@@ -103,7 +103,7 @@ def test_stringify_cfm():
         Cardinality([Interval(1, 0)]),
         Cardinality([Interval(1, 3)]),
         Cardinality([Interval(2, 2)]),
-        [],
+        None,
         [],
     )