ripple-down-rules 0.4.3__tar.gz → 0.4.4__tar.gz

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.4.3
+Version: 0.4.4
 Summary: Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.
 Author-email: Abdelrhman Bassiouny <abassiou@uni-bremen.de>
 License:                     GNU GENERAL PUBLIC LICENSE

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ripple_down_rules"
-version = "0.4.3"
+version = "0.4.4"
 description = "Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning."
 readme = "README.md"
 authors = [{ name = "Abdelrhman Bassiouny", email = "abassiou@uni-bremen.de" }]

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/src/ripple_down_rules/experts.py

@@ -103,7 +103,7 @@ class Human(Expert):
     def ask_for_conditions(self, case_query: CaseQuery,
                            last_evaluated_rule: Optional[Rule] = None) \
             -> CallableExpression:
-        if not self.use_loaded_answers:
+        if not self.use_loaded_answers and self.user_prompt.viewer is None:
             show_current_and_corner_cases(case_query.case, {case_query.attribute_name: case_query.target_value},
                                           last_evaluated_rule=last_evaluated_rule)
         return self._get_conditions(case_query)
@@ -148,7 +148,8 @@ class Human(Expert):
                                                 scope=case_query.scope,
                                                  mutually_exclusive=case_query.mutually_exclusive)
         else:
-            show_current_and_corner_cases(case_query.case)
+            if self.user_prompt.viewer is None:
+                show_current_and_corner_cases(case_query.case)
             expert_input, expression = self.user_prompt.prompt_user_for_expression(case_query, PromptFor.Conclusion)
             self.all_expert_answers.append(expert_input)
         case_query.target = expression

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/src/ripple_down_rules/rdr.py

@@ -22,7 +22,7 @@ from .rules import Rule, SingleClassRule, MultiClassTopRule, MultiClassStopRule
 from .user_interface.gui import RDRCaseViewer
 from .utils import draw_tree, make_set, copy_case, \
     SubclassJSONSerializer, make_list, get_type_from_string, \
-    is_conflicting, update_case, get_imports_from_scope, extract_function_source
+    is_conflicting, update_case, get_imports_from_scope, extract_function_source, extract_imports
 
 
 class RippleDownRules(SubclassJSONSerializer, ABC):
@@ -41,6 +41,10 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
     """
     The name of the generated python file.
     """
+    name: Optional[str] = None
+    """
+    The name of the classifier.
+    """
 
     def __init__(self, start_rule: Optional[Rule] = None, viewer: Optional[RDRCaseViewer] = None):
         """
@@ -138,6 +142,7 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
         """
         if case_query is None:
             raise ValueError("The case query cannot be None.")
+        self.name = case_query.attribute_name if self.name is None else self.name
         if case_query.target is None:
             case_query_cp = copy(case_query)
             self.classify(case_query_cp.case, modify_case=True)
@@ -237,11 +242,15 @@ class RDRWithCodeWriter(RippleDownRules, ABC):
         all_func_names = condition_func_names + conclusion_func_names
         filepath = f"{package_dir}/{self.generated_python_defs_file_name}.py"
         functions_source = extract_function_source(filepath, all_func_names, include_signature=False)
+        # get the scope from the imports in the file
+        scope = extract_imports(filepath)
         for rule in [self.start_rule] + list(self.start_rule.descendants):
             if rule.conditions is not None:
                 rule.conditions.user_input = functions_source[f"conditions_{rule.uid}"]
+                rule.conditions.scope = scope
             if rule.conclusion is not None:
                 rule.conclusion.user_input = functions_source[f"conclusion_{rule.uid}"]
+                rule.conclusion.scope = scope
 
     @abstractmethod
     def write_rules_as_source_code_to_file(self, rule: Rule, file, parent_indent: str = "",
@@ -275,6 +284,7 @@ class RDRWithCodeWriter(RippleDownRules, ABC):
             imports += f"from .{self.generated_python_defs_file_name} import *\n"
             imports += f"from ripple_down_rules.rdr import {self.__class__.__name__}\n"
             f.write(imports + "\n\n")
+            f.write(f"attribute_name = '{self.attribute_name}'\n")
             f.write(f"conclusion_type = ({', '.join([ct.__name__ for ct in self.conclusion_type])},)\n")
             f.write(f"type_ = {self.__class__.__name__}\n")
             f.write(f"\n\n{func_def}")
@@ -384,6 +394,31 @@ class RDRWithCodeWriter(RippleDownRules, ABC):
         """
         return self.start_rule.conclusion_name
 
+    def _to_json(self) -> Dict[str, Any]:
+        return {"start_rule": self.start_rule.to_json(),  "generated_python_file_name": self.generated_python_file_name,
+                "name": self.name}
+
+    @classmethod
+    def _from_json(cls, data: Dict[str, Any]) -> Self:
+        """
+        Create an instance of the class from a json
+        """
+        start_rule = cls.start_rule_type().from_json(data["start_rule"])
+        new_rdr = cls(start_rule)
+        if "generated_python_file_name" in data:
+            new_rdr.generated_python_file_name = data["generated_python_file_name"]
+        if "name" in data:
+            new_rdr.name = data["name"]
+        return new_rdr
+
+    @staticmethod
+    @abstractmethod
+    def start_rule_type() -> Type[Rule]:
+        """
+        :return: The type of the starting rule of the RDR classifier.
+        """
+        pass
+
 
 class SingleClassRDR(RDRWithCodeWriter):
 
@@ -478,16 +513,12 @@ class SingleClassRDR(RDRWithCodeWriter):
             return (type(self.default_conclusion),)
         return super().conclusion_type
 
-    def _to_json(self) -> Dict[str, Any]:
-        return {"start_rule": self.start_rule.to_json()}
-
-    @classmethod
-    def _from_json(cls, data: Dict[str, Any]) -> Self:
+    @staticmethod
+    def start_rule_type() -> Type[Rule]:
         """
-        Create an instance of the class from a json
+        :return: The type of the starting rule of the RDR classifier.
         """
-        start_rule = SingleClassRule.from_json(data["start_rule"])
-        return cls(start_rule)
+        return SingleClassRule
 
 
 class MultiClassRDR(RDRWithCodeWriter):
@@ -693,16 +724,12 @@ class MultiClassRDR(RDRWithCodeWriter):
         """
         self.start_rule.alternative = MultiClassTopRule(conditions, conclusion, corner_case=corner_case)
 
-    def _to_json(self) -> Dict[str, Any]:
-        return {"start_rule": self.start_rule.to_json()}
-
-    @classmethod
-    def _from_json(cls, data: Dict[str, Any]) -> Self:
+    @staticmethod
+    def start_rule_type() -> Type[Rule]:
         """
-        Create an instance of the class from a json
+        :return: The type of the starting rule of the RDR classifier.
         """
-        start_rule = SingleClassRule.from_json(data["start_rule"])
-        return cls(start_rule)
+        return MultiClassTopRule
 
 
 class GeneralRDR(RippleDownRules):
@@ -733,15 +760,15 @@ class GeneralRDR(RippleDownRules):
         super(GeneralRDR, self).__init__(**kwargs)
         self.all_figs: List[plt.Figure] = [sr.fig for sr in self.start_rules_dict.values()]
 
-    def add_rdr(self, rdr: Union[SingleClassRDR, MultiClassRDR], attribute_name: Optional[str] = None):
+    def add_rdr(self, rdr: Union[SingleClassRDR, MultiClassRDR], case_query: Optional[CaseQuery] = None):
         """
         Add a ripple down rules classifier to the map of classifiers.
 
         :param rdr: The ripple down rules classifier to add.
-        :param attribute_name: The name of the attribute that the classifier is classifying.
+        :param case_query: The case query to add the classifier for.
         """
-        attribute_name = attribute_name if attribute_name else rdr.attribute_name
-        self.start_rules_dict[attribute_name] = rdr
+        name = case_query.attribute_name if case_query else rdr.name
+        self.start_rules_dict[name] = rdr
 
     @property
     def start_rule(self) -> Optional[Union[SingleClassRule, MultiClassTopRule]]:
@@ -825,7 +852,6 @@ class GeneralRDR(RippleDownRules):
         :param expert: The expert to ask for differentiating features as new rule conditions.
         :return: The categories that the case belongs to.
         """
-
         case_query_cp = copy(case_query)
         self.classify(case_query_cp.case, modify_case=True)
         case_query_cp.update_target_value()
@@ -843,7 +869,7 @@ class GeneralRDR(RippleDownRules):
         """
         if case_query.attribute_name not in self.start_rules_dict:
             new_rdr = self.initialize_new_rdr_for_attribute(case_query)
-            self.add_rdr(new_rdr, case_query.attribute_name)
+            self.add_rdr(new_rdr, case_query)
 
     @staticmethod
     def initialize_new_rdr_for_attribute(case_query: CaseQuery):
@@ -854,7 +880,9 @@ class GeneralRDR(RippleDownRules):
             else MultiClassRDR()
 
     def _to_json(self) -> Dict[str, Any]:
-        return {"start_rules": {t: rdr.to_json() for t, rdr in self.start_rules_dict.items()}}
+        return {"start_rules": {name: rdr.to_json() for name, rdr in self.start_rules_dict.items()}
+                , "generated_python_file_name": self.generated_python_file_name,
+                "name": self.name}
 
     @classmethod
     def _from_json(cls, data: Dict[str, Any]) -> GeneralRDR:
@@ -864,7 +892,12 @@ class GeneralRDR(RippleDownRules):
         start_rules_dict = {}
         for k, v in data["start_rules"].items():
             start_rules_dict[k] = get_type_from_string(v['_type']).from_json(v)
-        return cls(start_rules_dict)
+        new_rdr = cls(start_rules_dict)
+        if "generated_python_file_name" in data:
+            new_rdr.generated_python_file_name = data["generated_python_file_name"]
+        if "name" in data:
+            new_rdr.name = data["name"]
+        return new_rdr
 
     def update_from_python_file(self, package_dir: str) -> None:
         """
@@ -921,7 +954,7 @@ class GeneralRDR(RippleDownRules):
         """
         :return: The default generated python file name.
         """
-        if self.start_rule is None or self.start_rule.corner_case is None:
+        if self.start_rule is None or self.start_rule.conclusion is None:
             return None
         if isinstance(self.start_rule.corner_case, Case):
             name = self.start_rule.corner_case._name

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/src/ripple_down_rules/rules.py

@@ -5,6 +5,7 @@ from abc import ABC, abstractmethod
 from uuid import uuid4
 
 from anytree import NodeMixin
+from rospy import logwarn, logdebug
 from sqlalchemy.orm import DeclarativeBase as SQLTable
 from typing_extensions import List, Optional, Self, Union, Dict, Any, Tuple
 
@@ -151,7 +152,8 @@ class Rule(NodeMixin, SubclassJSONSerializer, ABC):
         json_serialization = {"conditions": self.conditions.to_json(),
                               "conclusion": conclusion_to_json(self.conclusion),
                               "parent": self.parent.json_serialization if self.parent else None,
-                              "corner_case": SubclassJSONSerializer.to_json_static(self.corner_case),
+                              "corner_case": SubclassJSONSerializer.to_json_static(self.corner_case)
+                              if self.corner_case else None,
                               "conclusion_name": self.conclusion_name,
                               "weight": self.weight,
                               "uid": self.uid}
@@ -159,10 +161,15 @@ class Rule(NodeMixin, SubclassJSONSerializer, ABC):
 
     @classmethod
     def _from_json(cls, data: Dict[str, Any]) -> Rule:
+        try:
+            corner_case = Case.from_json(data["corner_case"])
+        except Exception as e:
+            logdebug("Failed to load corner case from json, setting it to None.")
+            corner_case = None
         loaded_rule = cls(conditions=CallableExpression.from_json(data["conditions"]),
                           conclusion=CallableExpression.from_json(data["conclusion"]),
                           parent=cls.from_json(data["parent"]),
-                          corner_case=Case.from_json(data["corner_case"]),
+                          corner_case=corner_case,
                           conclusion_name=data["conclusion_name"],
                           weight=data["weight"],
                           uid=data["uid"])

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/src/ripple_down_rules/utils.py

@@ -22,6 +22,7 @@ import requests
 from anytree import Node, RenderTree
 from anytree.exporter import DotExporter
 from matplotlib import pyplot as plt
+from rospy import logwarn
 from sqlalchemy import MetaData, inspect
 from sqlalchemy.orm import Mapped, registry, class_mapper, DeclarativeBase as SQLTable, Session
 from tabulate import tabulate
@@ -129,7 +130,7 @@ def extract_imports(file_path):
                     module = importlib.import_module(module_name)
                     scope[asname] = getattr(module, name)
                 except (ImportError, AttributeError) as e:
-                    print(f"Could not import {name} from {module_name}: {e}")
+                    logwarn(f"Could not import {module_name}: {e} while extracting imports from {file_path}")
 
     return scope
 

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/src/ripple_down_rules.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.4.3
+Version: 0.4.4
 Summary: Implements the various versions of Ripple Down Rules (RDR) for knowledge representation and reasoning.
 Author-email: Abdelrhman Bassiouny <abassiou@uni-bremen.de>
 License:                     GNU GENERAL PUBLIC LICENSE

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/src/ripple_down_rules.egg-info/SOURCES.txt

@@ -34,4 +34,5 @@ test/test_rdr_decorators.py
 test/test_rdr_world.py
 test/test_relational_rdr.py
 test/test_relational_rdr_alchemy.py
-test/test_sql_model.py
+test/test_sql_model.py
+test/test_utils.py

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/test/test_object_diagram.py

@@ -26,18 +26,18 @@ class ObjectDiagramTestCase(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
-        cls.cases, cls.targets = load_zoo_dataset(cache_file="../test_results/zoo")
+        cls.cases, cls.targets = load_zoo_dataset(cache_file=f"{os.path.dirname(__file__)}/test_results/zoo")
         cls.cq = CaseQuery(cls.cases[0], "species", (Species,), True, _target=cls.targets[0])
         cls.person = Person("Ahmed", Address("Cairo"))
 
     def test_generate_person_diagram(self):
         # Generate object diagram for the Person instance
         graph = generate_object_graph(self.person)
-        graph.render('../test_results/person_object_diagram', view=False)
-        self.assertTrue(os.path.isfile('../test_results/person_object_diagram.svg'))
+        graph.render(f'{os.path.dirname(__file__)}/test_results/person_object_diagram', view=False)
+        self.assertTrue(os.path.isfile(f'{os.path.dirname(__file__)}/test_results/person_object_diagram.svg'))
 
     def test_generate_case_query_diagram(self):
         # Generate object diagram for the CaseQuery instance
         graph = generate_object_graph(self.cq)
-        graph.render('../test_results/case_query_object_diagram', view=False)
-        self.assertTrue(os.path.isfile('../test_results/case_query_object_diagram.svg'))
+        graph.render(f'{os.path.dirname(__file__)}/test_results/case_query_object_diagram', view=False)
+        self.assertTrue(os.path.isfile(f'{os.path.dirname(__file__)}/test_results/case_query_object_diagram.svg'))

{ripple_down_rules-0.4.3 → ripple_down_rules-0.4.4}/test/test_rdr_world.py

@@ -119,7 +119,7 @@ class TestRDRWorld(TestCase):
         cls.viewer = RDRCaseViewer()
 
     def test_view_rdr(self):
-        self.get_view_rdr(use_loaded_answers=False, save_answers=False, append=False)
+        self.get_view_rdr(use_loaded_answers=True, save_answers=False, append=False)
 
     def test_save_and_load_view_rdr(self):
         view_rdr = self.get_view_rdr(use_loaded_answers=True, save_answers=False, append=False)

ripple_down_rules-0.4.4/test/test_utils.py

@@ -0,0 +1,23 @@
+import os
+from unittest import TestCase
+
+from ripple_down_rules.utils import extract_imports, make_set
+
+
+class UtilsTestCase(TestCase):
+
+    def test_extract_imports_from_file(self):
+        # Test with a file that has imports
+        file_path = "test_file.py"
+        with open(file_path, "w") as f:
+            f.write("import os\n")
+            f.write("from module import function\n")
+            f.write("from ripple_down_rules.utils import make_set\n")
+            f.write("print('Hello World')\n")
+
+        expected_scope = {"os": os, "make_set": make_set}
+        actual_imports = extract_imports(file_path)
+        self.assertEqual(expected_scope, actual_imports)
+
+        # Clean up
+        os.remove(file_path)