ripple-down-rules 0.6.27__py3-none-any.whl → 0.6.28__py3-none-any.whl

ripple_down_rules/__init__.py

@@ -1,5 +1,5 @@
-__version__ = "0.6.27"
+__version__ = "0.6.28"
 
 import logging
 logger = logging.Logger("rdr")
-logger.setLevel(logging.INFO)
+logger.setLevel(logging.INFO)

ripple_down_rules/datastructures/enums.py

@@ -7,6 +7,19 @@ from typing_extensions import List, Dict, Any, Type
 from ripple_down_rules.utils import SubclassJSONSerializer
 
 
+class ExitStatus(Enum):
+    """
+    Describes the status at exit of the user interface.
+    """
+    CLOSE = auto()
+    """
+    The user wants to stop the program.
+    """
+    SUCCESS = auto()
+    """
+    The user completed the task successfully.
+    """
+
 class InteractionMode(Enum):
     """
     The interaction mode of the RDR.

ripple_down_rules/experts.py

@@ -213,14 +213,12 @@ class Human(Expert):
     The Human Expert class, an expert that asks the human to provide differentiating features and conclusions.
     """
 
-    def __init__(self, viewer: Optional[RDRCaseViewer] = None, **kwargs):
+    def __init__(self, **kwargs):
         """
         Initialize the Human expert.
-
-        :param viewer: The RDRCaseViewer instance to use for prompting the user.
         """
         super().__init__(**kwargs)
-        self.user_prompt = UserPrompt(viewer)
+        self.user_prompt = UserPrompt()
 
     def ask_for_conditions(self, case_query: CaseQuery,
                            last_evaluated_rule: Optional[Rule] = None) \

ripple_down_rules/rdr.py

@@ -83,23 +83,18 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
     Whether the output of the classification of this rdr allows only one possible conclusion or not.
     """
 
-    def __init__(self, start_rule: Optional[Rule] = None, viewer: Optional[RDRCaseViewer] = None,
+    def __init__(self, start_rule: Optional[Rule] = None,
                  save_dir: Optional[str] = None, model_name: Optional[str] = None):
         """
         :param start_rule: The starting rule for the classifier.
-        :param viewer: The viewer gui to use for the classifier. If None, no viewer is used.
         :param save_dir: The directory to save the classifier to.
         """
         self.model_name: Optional[str] = model_name
         self.save_dir = save_dir
         self.start_rule = start_rule
         self.fig: Optional[Figure] = None
-        self.viewer: Optional[RDRCaseViewer] = viewer
-        if viewer is None and RDRCaseViewer is not None:
-            if len(RDRCaseViewer.instances) > 0:
-                self.viewer = RDRCaseViewer.instances[0]
-                logger.error("No viewer was provided, but there is already an existing viewer. "
-                             "Using the existing viewer.")
+        self.viewer: Optional[RDRCaseViewer] = RDRCaseViewer.instances[0]\
+            if RDRCaseViewer and any(RDRCaseViewer.instances) else None
         self.input_node: Optional[Rule] = None
 
     @property
@@ -107,10 +102,10 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
         return self._viewer
 
     @viewer.setter
-    def viewer(self, value):
-        self._viewer = value
-        if value is not None:
-            value.set_save_function(self.save)
+    def viewer(self, viewer):
+        self._viewer = viewer
+        if viewer:
+            viewer.set_save_function(self.save)
 
     def render_evaluated_rule_tree(self, filename: str, show_full_tree: bool = False) -> None:
         if show_full_tree:
@@ -335,8 +330,7 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
         self.case_name = case_query.case_name if self.case_name is None else self.case_name
         case_query.scenario = scenario if case_query.scenario is None else case_query.scenario
 
-        expert = expert or Human(viewer=self.viewer,
-                                 answers_save_path=self.save_dir + '/expert_answers'
+        expert = expert or Human(answers_save_path=self.save_dir + '/expert_answers'
                                  if self.save_dir else None)
         if case_query.target is None:
             case_query_cp = copy(case_query)

ripple_down_rules/rdr_decorators.py

@@ -96,8 +96,7 @@ class RDRDecorator:
                 if len(self.parsed_output_type) == 0:
                     self.parsed_output_type = self.parse_output_type(func, self.output_type, *args)
                 if self.expert is None:
-                    self.expert = Human(viewer=self.viewer,
-                                        answers_save_path=self.rdr_models_dir + f'/{self.model_name}/expert_answers')
+                    self.expert = Human(answers_save_path=self.rdr_models_dir + f'/{self.model_name}/expert_answers')
                 case_query = self.create_case_query_from_method(func, func_output,
                                                                 self.parsed_output_type,
                                                                 self.mutual_exclusive,

ripple_down_rules/user_interface/gui.py

@@ -21,7 +21,7 @@ except ImportError as e:
 from typing_extensions import Optional, Any, List, Dict, Callable
 
 from ..datastructures.dataclasses import CaseQuery
-from ..datastructures.enums import PromptFor
+from ..datastructures.enums import PromptFor, ExitStatus
 from .template_file_creator import TemplateFileCreator
 from ..utils import is_iterable, contains_return_statement, encapsulate_code_lines_into_a_function
 from .object_diagram import generate_object_graph
@@ -283,11 +283,13 @@ class RDRCaseViewer(QMainWindow):
     attributes_widget: Optional[QWidget] = None
     save_function: Optional[Callable[str, str], None] = None
     instances: List[RDRCaseViewer] = []
+    exit_status: ExitStatus = ExitStatus.CLOSE
 
     def __init__(self, parent=None,
                  save_dir: Optional[str] = None,
                  save_model_name: Optional[str] = None):
         super().__init__(parent)
+        self.exit_status = ExitStatus.CLOSE
         self.instances.clear()
         self.instances.append(self)
         self.save_dir = save_dir
@@ -328,7 +330,7 @@ class RDRCaseViewer(QMainWindow):
 
         # Add both to main layout
         main_layout.addWidget(self.attributes_widget, stretch=1)
-        main_layout.addWidget(middle_widget, stretch=1)
+        main_layout.addWidget(middle_widget, stretch=2)
         main_layout.addWidget(self.obj_diagram_viewer, stretch=2)
 
     def set_save_function(self, save_function: Callable[[str, str], None]) -> None:
@@ -474,6 +476,7 @@ class RDRCaseViewer(QMainWindow):
         return button_widget
 
     def _accept(self):
+        self.exit_status = ExitStatus.SUCCESS
         # close the window
         self.close()
 

ripple_down_rules/user_interface/prompt.py

@@ -4,7 +4,7 @@ from _ast import AST
 
 try:
     from PyQt6.QtWidgets import QApplication
-    from .gui import RDRCaseViewer
+    from .gui import RDRCaseViewer, style
 except ImportError:
     QApplication = None
     RDRCaseViewer = None
@@ -17,7 +17,7 @@ from typing_extensions import Optional, Tuple
 
 from ..datastructures.callable_expression import CallableExpression, parse_string_to_expression
 from ..datastructures.dataclasses import CaseQuery
-from ..datastructures.enums import PromptFor
+from ..datastructures.enums import PromptFor, ExitStatus
 from .ipython_custom_shell import IPythonShell
 from ..utils import make_list
 from threading import RLock
@@ -29,15 +29,12 @@ class UserPrompt:
     """
     shell_lock: RLock = RLock()  # To ensure that only one thread can access the shell at a time
 
-    def __init__(self, viewer: Optional[RDRCaseViewer] = None):
+    def __init__(self):
         """
         Initialize the UserPrompt class.
-
-        :param viewer: The RDRCaseViewer instance to use for prompting the user.
         """
-        self.viewer = viewer
-        self.print_func = print if viewer is None else viewer.print
-
+        self.viewer = RDRCaseViewer.instances[0] if RDRCaseViewer and any(RDRCaseViewer.instances) else None
+        self.print_func = self.viewer.print if self.viewer else print
 
     def prompt_user_for_expression(self, case_query: CaseQuery, prompt_for: PromptFor, prompt_str: Optional[str] = None) \
             -> Tuple[Optional[str], Optional[CallableExpression]]:
@@ -99,19 +96,20 @@ class UserPrompt:
         :return: The user input, and the executable expression that was parsed from the user input.
         """
         self.print_func("Entered shell")
-        prompt_str = f"{Fore.WHITE}{prompt_str}" if prompt_str is not None else ''
+        initial_prompt_str = f"{prompt_str}\n" if prompt_str is not None else ''
         if prompt_for == PromptFor.Conclusion:
-            prompt_str += f"\n{Fore.MAGENTA}Give possible value(s) for:"
+            prompt_for_str = f"Give possible value(s) for:"
         else:
-            prompt_str += f"\n{Fore.MAGENTA}Give conditions on when can the rule be evaluated for:"
+            prompt_for_str = f"Give conditions for:"
         case_query.scope.update({'case': case_query.case})
         shell = None
         if self.viewer is None:
+            prompt_str = f"{Fore.WHITE}{initial_prompt_str}{Fore.MAGENTA}{prompt_for_str}"
             prompt_str = self.construct_prompt_str_for_shell(case_query, prompt_for, prompt_str)
             shell = IPythonShell(header=prompt_str, prompt_for=prompt_for, case_query=case_query,
                                     code_to_modify=code_to_modify)
         else:
-
+            prompt_str = initial_prompt_str + prompt_for_str
             self.viewer.update_for_case_query(case_query, prompt_str,
                                                 prompt_for=prompt_for, code_to_modify=code_to_modify)
         user_input, expression_tree = self.prompt_user_input_and_parse_to_expression(shell=shell)
@@ -176,6 +174,8 @@ class UserPrompt:
         """
         if self.viewer is None:
             shell = IPythonShell() if shell is None else shell
+            if not hasattr(shell.shell, "auto_match"):
+                shell.shell.auto_match = True  # or True, depending on your preference
             shell.run()
             user_input = shell.user_input
         else:
@@ -184,5 +184,7 @@ class UserPrompt:
                 raise RuntimeError("QApplication instance is None. Please run the application first.")
             self.viewer.show()
             app.exec()
+            if self.viewer.exit_status == ExitStatus.CLOSE:
+                exit(0)
             user_input = self.viewer.user_input
         return user_input

{ripple_down_rules-0.6.27.dist-info → ripple_down_rules-0.6.28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.6.27
+Version: 0.6.28
 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.6.27.dist-info → ripple_down_rules-0.6.28.dist-info}/RECORD

@@ -1,8 +1,8 @@
-ripple_down_rules/__init__.py,sha256=TaxvqRWwXyeD_ETYnf_G3Z5VlbdhClbNpLIff72WwGg,100
-ripple_down_rules/experts.py,sha256=MYK1-vuvU1Stp82YZa8TcwOzvriIiYb0WrPFpWUNnXc,13005
+ripple_down_rules/__init__.py,sha256=XvJJjrncdmKjrvKVVILZq7uuTOYiohoP3iLBN_oKp_M,99
+ripple_down_rules/experts.py,sha256=bQfDB7RZE_CANVkpBMb9bi8ZWFwk5p7hn1AzjpaO5ow,12877
 ripple_down_rules/helpers.py,sha256=X1psHOqrb4_xYN4ssQNB8S9aRKKsqgihAyWJurN0dqk,5499
-ripple_down_rules/rdr.py,sha256=PaoNwbrwnZBjXXkIVO3_sz_MsNUBjfooxBs9RT3bb64,62081
-ripple_down_rules/rdr_decorators.py,sha256=TRhbaB_ZIXN0n8Up19NI43_mMjmTm24qo8axAAOzbxM,11728
+ripple_down_rules/rdr.py,sha256=hVqfCRrru6TUnqzY7yGMjiNnxUIFjfL2U7txmGNjeGI,61661
+ripple_down_rules/rdr_decorators.py,sha256=xoBGsIJMkJYUdsrsEaPZqoAsGuXkuVZAKCoP-xD2Iv8,11668
 ripple_down_rules/rules.py,sha256=N4dEx-xyqxGZpoEYzRd9P5u97_DcDEVLY_UiNhZ4E7g,28726
 ripple_down_rules/start-code-server.sh,sha256=otClk7VmDgBOX2TS_cjws6K0UwvgAUJhoA0ugkPCLqQ,949
 ripple_down_rules/utils.py,sha256=9xW0N2cB7X4taVANtLg-kVTPS-6ajWZylKkTqw2PKw4,73825
@@ -10,15 +10,15 @@ ripple_down_rules/datastructures/__init__.py,sha256=V2aNgf5C96Y5-IGghra3n9uiefpo
 ripple_down_rules/datastructures/callable_expression.py,sha256=P3o-z54Jt4rtIczeFWiuHFTNqMzYEOm94OyOP535D6Q,13378
 ripple_down_rules/datastructures/case.py,sha256=PJ7_-AdxYic6BO5z816piFODj6nU5J6Jt1YzTFH-dds,15510
 ripple_down_rules/datastructures/dataclasses.py,sha256=kI3Kv8GiVR8igMgA_BlKN6djUYxC2mLecvyh19pqQQA,10998
-ripple_down_rules/datastructures/enums.py,sha256=R9AkhMKTDErOSZ8J6gEdh2lQ0Bjsxs22eMBtCPrXosI,5804
+ripple_down_rules/datastructures/enums.py,sha256=CvcROl8fE7A6uTbMfs2lLpyxwS_ZFtFcQlBDDKFfoHc,6059
 ripple_down_rules/user_interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ripple_down_rules/user_interface/gui.py,sha256=druufu9cVeVUajPW-RqGW3ZiEbgdgNBQD2CLhadQo18,27486
+ripple_down_rules/user_interface/gui.py,sha256=JCz6vA2kWVvRD6CupoUfMbtGz39cvUlmVnGnw_fY6OA,27635
 ripple_down_rules/user_interface/ipython_custom_shell.py,sha256=yp-F8YRWGhj1PLB33HE6vJkdYWFN5Zn2244S2DUWRTM,6576
 ripple_down_rules/user_interface/object_diagram.py,sha256=FEa2HaYR9QmTE6NsOwBvZ0jqmu3DKyg6mig2VE5ZP4Y,4956
-ripple_down_rules/user_interface/prompt.py,sha256=e5FzVfiIagwKTK3WCKsHvWaWZ4kb8FP8X-SgieTln6E,9156
+ripple_down_rules/user_interface/prompt.py,sha256=nLIAviClSmVCY80vQgTazDPs4a1AYmNQmT7sksLDJpE,9449
 ripple_down_rules/user_interface/template_file_creator.py,sha256=kwBbFLyN6Yx2NTIHPSwOoytWgbJDYhgrUOVFw_jkDQ4,13522
-ripple_down_rules-0.6.27.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-ripple_down_rules-0.6.27.dist-info/METADATA,sha256=L_eYP6eqnQnZaLw-7FHIV774Yj_Q1IcJ9HAkkwP9um4,48294
-ripple_down_rules-0.6.27.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ripple_down_rules-0.6.27.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
-ripple_down_rules-0.6.27.dist-info/RECORD,,
+ripple_down_rules-0.6.28.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+ripple_down_rules-0.6.28.dist-info/METADATA,sha256=fPfcVvFD7eEuG5FKX26HRRWPJkZatA0mfWdarnTqPa8,48294
+ripple_down_rules-0.6.28.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ripple_down_rules-0.6.28.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
+ripple_down_rules-0.6.28.dist-info/RECORD,,