ripple-down-rules 0.4.82__py3-none-any.whl → 0.4.84__py3-none-any.whl

ripple_down_rules/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.4.84"

ripple_down_rules/experts.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+import logging
 from abc import ABC, abstractmethod
 
 from typing_extensions import Optional, TYPE_CHECKING, List
@@ -9,7 +10,10 @@ from .datastructures.callable_expression import CallableExpression
 from .datastructures.enums import PromptFor
 from .datastructures.dataclasses import CaseQuery
 from .datastructures.case import show_current_and_corner_cases
-from .user_interface.gui import RDRCaseViewer
+try:
+    from .user_interface.gui import RDRCaseViewer
+except ImportError as e:
+    RDRCaseViewer = None
 from .user_interface.prompt import UserPrompt
 
 if TYPE_CHECKING:

ripple_down_rules/rdr.py

@@ -2,13 +2,22 @@ from __future__ import annotations
 
 import copyreg
 import importlib
+import logging
 import sys
 from abc import ABC, abstractmethod
 from copy import copy
 from io import TextIOWrapper
 from types import ModuleType
 
-from matplotlib import pyplot as plt
+try:
+    from matplotlib import pyplot as plt
+    Figure = plt.Figure
+except ImportError as e:
+    logging.debug(f"{e}: matplotlib is not installed")
+    matplotlib = None
+    Figure = None
+    plt = None
+
 from sqlalchemy.orm import DeclarativeBase as SQLTable
 from typing_extensions import List, Optional, Dict, Type, Union, Any, Self, Tuple, Callable, Set
 
@@ -19,7 +28,10 @@ from .datastructures.enums import MCRDRMode
 from .experts import Expert, Human
 from .helpers import is_matching
 from .rules import Rule, SingleClassRule, MultiClassTopRule, MultiClassStopRule
-from .user_interface.gui import RDRCaseViewer
+try:
+    from .user_interface.gui import RDRCaseViewer
+except ImportError as e:
+    RDRCaseViewer = None
 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, extract_imports, get_full_class_name
@@ -29,7 +41,7 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
     """
     The abstract base class for the ripple down rules classifiers.
     """
-    fig: Optional[plt.Figure] = None
+    fig: Optional[Figure] = None
     """
     The figure to draw the tree on.
     """
@@ -55,7 +67,7 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
         :param start_rule: The starting rule for the classifier.
         """
         self.start_rule = start_rule
-        self.fig: Optional[plt.Figure] = None
+        self.fig: Optional[Figure] = None
         self.viewer: Optional[RDRCaseViewer] = viewer
         if self.viewer is not None:
             self.viewer.set_save_function(self.save)
@@ -86,6 +98,8 @@ class RippleDownRules(SubclassJSONSerializer, ABC):
         """
         targets = []
         if animate_tree:
+            if plt is None:
+                raise ImportError("matplotlib is not installed, cannot animate the tree.")
             plt.ion()
         i = 0
         stop_iterating = False
@@ -755,7 +769,7 @@ class GeneralRDR(RippleDownRules):
         self.start_rules_dict: Dict[str, Union[SingleClassRDR, MultiClassRDR]] \
             = category_rdr_map if category_rdr_map else {}
         super(GeneralRDR, self).__init__(**kwargs)
-        self.all_figs: List[plt.Figure] = [sr.fig for sr in self.start_rules_dict.values()]
+        self.all_figs: List[Figure] = [sr.fig for sr in self.start_rules_dict.values()]
 
     def add_rdr(self, rdr: Union[SingleClassRDR, MultiClassRDR], case_query: Optional[CaseQuery] = None):
         """

ripple_down_rules/start-code-server.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+set -e
+if [ -z "$RDR_EDITOR_PORT" ]; then
+    echo "RDR_EDITOR_PORT is not set. Using default port 8080."
+    RDR_EDITOR_PORT=8080
+fi
+ADDR="0.0.0.0:$RDR_EDITOR_PORT"
+# DATA_DIR="/root/.local/share/code-server"
+echo "🚀 Starting code-server on $ADDR"
+# Activate your Python virtual environment if exists else ignore
+if [ -z "$RDR_VENV_PATH" ]; then
+    echo "No virtual environment found. Skipping activation."
+else
+  source "$RDR_VENV_PATH/bin/activate"
+  # Set the default Python interpreter for VS Code
+  export DEFAULT_PYTHON_PATH=$(which python)
+fi
+
+# Start code-server.
+echo "🚀 Starting code-server on $ADDR"
+if [ -z "$CODE_SERVER_USER_DATA_DIR" ]; then
+    echo "No user data directory found. Using default"
+    code-server --bind-addr $ADDR --auth none "$@"
+else
+    echo "Using user data directory: $CODE_SERVER_USER_DATA_DIR"
+    code-server --bind-addr $ADDR --user-data-dir $CODE_SERVER_USER_DATA_DIR --auth none "$@"
+fi

ripple_down_rules/user_interface/gui.py

@@ -1,23 +1,29 @@
 from  __future__ import annotations
 
 import inspect
-from copy import copy
+import logging
 from types import MethodType
 
-from PyQt6.QtCore import Qt
-from PyQt6.QtGui import QPixmap, QPainter, QPalette
-from PyQt6.QtWidgets import (
-    QWidget, QVBoxLayout, QLabel, QScrollArea,
-    QSizePolicy, QToolButton, QHBoxLayout, QPushButton, QMainWindow, QGraphicsView, QGraphicsScene, QGraphicsPixmapItem
-)
-from qtconsole.inprocess import QtInProcessKernelManager
-from qtconsole.rich_jupyter_widget import RichJupyterWidget
+try:
+    from PyQt6.QtCore import Qt
+    from PyQt6.QtGui import QPixmap, QPainter, QPalette
+    from PyQt6.QtWidgets import (
+        QWidget, QVBoxLayout, QLabel, QScrollArea,
+        QSizePolicy, QToolButton, QHBoxLayout, QPushButton, QMainWindow, QGraphicsView, QGraphicsScene, QGraphicsPixmapItem
+    )
+    from qtconsole.inprocess import QtInProcessKernelManager
+    from qtconsole.rich_jupyter_widget import RichJupyterWidget
+except ImportError as e:
+    logging.debug("RDRCaseViewer is not available. GUI features will not work. "
+                  "Make sure you have PyQt6 installed if you want to use the GUI features.")
+    raise ImportError("PyQt6 is required for the GUI features. Please install it using 'pip install PyQt6'") from e
+
 from typing_extensions import Optional, Any, List, Dict, Callable
 
 from ..datastructures.dataclasses import CaseQuery
 from ..datastructures.enums import PromptFor
 from .template_file_creator import TemplateFileCreator
-from ..utils import is_iterable, contains_return_statement, encapsulate_user_input
+from ..utils import is_iterable, contains_return_statement, encapsulate_code_lines_into_a_function
 from .object_diagram import generate_object_graph
 
 
@@ -561,28 +567,6 @@ class RDRCaseViewer(QMainWindow):
         layout.addWidget(item_label)
 
 
-def encapsulate_code_lines_into_a_function(code_lines: List[str], function_name: str, function_signature: str,
-                                           func_doc: str, case_query: CaseQuery) -> str:
-    """
-    Encapsulate the given code lines into a function with the specified name, signature, and docstring.
-
-    :param code_lines: The lines of code to include in the user input.
-    :param function_name: The name of the function to include in the user input.
-    :param function_signature: The function signature to include in the user input.
-    :param func_doc: The function docstring to include in the user input.
-    :param case_query: The case query object.
-    """
-    code = '\n'.join(code_lines)
-    code = encapsulate_user_input(code, function_signature, func_doc)
-    if case_query.is_function:
-        args = "**case"
-    else:
-        args = "case"
-    if f"return {function_name}({args})" not in code:
-        code = code.strip() + f"\nreturn {function_name}({args})"
-    return code
-
-
 class IPythonConsole(RichJupyterWidget):
     def __init__(self, namespace=None, parent=None):
         super(IPythonConsole, self).__init__(parent)

ripple_down_rules/user_interface/ipython_custom_shell.py

@@ -8,9 +8,8 @@ from traitlets.config import Config
 
 from ..datastructures.dataclasses import CaseQuery
 from ..datastructures.enums import PromptFor
-from .gui import encapsulate_code_lines_into_a_function
 from .template_file_creator import TemplateFileCreator
-from ..utils import contains_return_statement, extract_dependencies
+from ..utils import contains_return_statement, extract_dependencies, encapsulate_code_lines_into_a_function
 
 
 @magics_class

ripple_down_rules/user_interface/object_diagram.py

@@ -1,4 +1,10 @@
-import graphviz
+import logging
+
+try:
+    import graphviz
+except ImportError:
+    graphviz = None
+    logging.debug("Graphviz is not installed")
 
 
 def is_simple(obj):

ripple_down_rules/user_interface/prompt.py

@@ -2,7 +2,13 @@ import ast
 import logging
 from _ast import AST
 
-from PyQt6.QtWidgets import QApplication
+try:
+    from PyQt6.QtWidgets import QApplication
+    from .gui import RDRCaseViewer
+except ImportError:
+    QApplication = None
+    RDRCaseViewer = None
+
 from colorama import Fore, Style
 from pygments import highlight
 from pygments.formatters.terminal import TerminalFormatter
@@ -11,8 +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, InteractionMode
-from .gui import RDRCaseViewer
+from ..datastructures.enums import PromptFor
 from .ipython_custom_shell import IPythonShell
 from ..utils import make_list
 
@@ -90,7 +95,7 @@ class UserPrompt:
                 prompt_str = f"Give conditions on when can the rule be evaluated for:"
         case_query.scope.update({'case': case_query.case})
         shell = None
-        if QApplication.instance() is None:
+        if self.viewer is None:
             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)

ripple_down_rules/utils.py

@@ -16,13 +16,27 @@ from dataclasses import is_dataclass, fields
 from enum import Enum
 from textwrap import dedent
 from types import NoneType
+from typing import List
+
+try:
+    import matplotlib
+    from matplotlib import pyplot as plt
+    Figure = plt.Figure
+except ImportError as e:
+    matplotlib = None
+    plt = None
+    Figure = None
+    logging.debug(f"{e}: matplotlib is not installed")
+
+try:
+    import networkx as nx
+except ImportError as e:
+    nx = None
+    logging.debug(f"{e}: networkx is not installed")
 
-import matplotlib
-import networkx as nx
 import requests
 from anytree import Node, RenderTree
 from anytree.exporter import DotExporter
-from matplotlib import pyplot as plt
 from sqlalchemy import MetaData, inspect
 from sqlalchemy.orm import Mapped, registry, class_mapper, DeclarativeBase as SQLTable, Session
 from tabulate import tabulate
@@ -1350,7 +1364,7 @@ def render_tree(root: Node, use_dot_exporter: bool = False,
         de.to_picture(f"{filename}{'.png'}")
 
 
-def draw_tree(root: Node, fig: plt.Figure):
+def draw_tree(root: Node, fig: Figure):
     """
     Draw the tree using matplotlib and networkx.
     """
@@ -1374,3 +1388,25 @@ def draw_tree(root: Node, fig: plt.Figure):
     nx.draw_networkx_edge_labels(graph, pos, edge_labels=nx.get_edge_attributes(graph, 'weight'),
                                  ax=fig.gca(), rotate=False, clip_on=False)
     plt.pause(0.1)
+
+
+def encapsulate_code_lines_into_a_function(code_lines: List[str], function_name: str, function_signature: str,
+                                           func_doc: str, case_query: CaseQuery) -> str:
+    """
+    Encapsulate the given code lines into a function with the specified name, signature, and docstring.
+
+    :param code_lines: The lines of code to include in the user input.
+    :param function_name: The name of the function to include in the user input.
+    :param function_signature: The function signature to include in the user input.
+    :param func_doc: The function docstring to include in the user input.
+    :param case_query: The case query object.
+    """
+    code = '\n'.join(code_lines)
+    code = encapsulate_user_input(code, function_signature, func_doc)
+    if case_query.is_function:
+        args = "**case"
+    else:
+        args = "case"
+    if f"return {function_name}({args})" not in code:
+        code = code.strip() + f"\nreturn {function_name}({args})"
+    return code

{ripple_down_rules-0.4.82.dist-info → ripple_down_rules-0.4.84.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ripple_down_rules
-Version: 0.4.82
+Version: 0.4.84
 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
@@ -682,21 +682,30 @@ Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: anytree>=2.8.0
-Requires-Dist: pandas>=2.0.3
-Requires-Dist: networkx>=3.1
 Requires-Dist: ordered_set>=4
 Requires-Dist: pygraphviz>=1.7
-Requires-Dist: ucimlrepo>=0.0.7
 Requires-Dist: typing-extensions>=4.12.2
-Requires-Dist: matplotlib>=3.7.5
-Requires-Dist: sqlalchemy
-Requires-Dist: pyqt6
-Requires-Dist: qtconsole
 Requires-Dist: graphviz
 Requires-Dist: tabulate
 Requires-Dist: ipython
 Requires-Dist: requests
 Requires-Dist: colorama
+Requires-Dist: pygments
+Provides-Extra: gui
+Requires-Dist: pyqt6; extra == "gui"
+Requires-Dist: qtconsole; extra == "gui"
+Provides-Extra: visualization
+Requires-Dist: matplotlib; extra == "visualization"
+Requires-Dist: networkx; extra == "visualization"
+Provides-Extra: dev
+Requires-Dist: pyqt6; extra == "dev"
+Requires-Dist: qtconsole; extra == "dev"
+Requires-Dist: matplotlib; extra == "dev"
+Requires-Dist: networkx; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: sqlalchemy; extra == "dev"
+Requires-Dist: ucimlrepo>=0.0.7; extra == "dev"
+Requires-Dist: pdbpp; extra == "dev"
 Dynamic: license-file
 
 # Ripple Down Rules (RDR)

{ripple_down_rules-0.4.82.dist-info → ripple_down_rules-0.4.84.dist-info}/RECORD

@@ -1,25 +1,26 @@
-ripple_down_rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ripple_down_rules/__init__.py,sha256=zRwAqNXnDyzZDar8uxB-BdzoKCO_yX1Bm6oT55ROH4I,22
 ripple_down_rules/datasets.py,sha256=fJbZ7V-UUYTu5XVVpFinTbuzN3YePCnUB01L3AyZVM8,6837
-ripple_down_rules/experts.py,sha256=dEZKv58sdicDByj0T0bu0q6coIBMce6o4t9gJICQy1k,6556
+ripple_down_rules/experts.py,sha256=RWDR-xxbeFIrUQiMYLEDr_PLQFdpPZ-hOXo4dpeiUpI,6630
 ripple_down_rules/failures.py,sha256=E6ajDUsw3Blom8eVLbA7d_Qnov2conhtZ0UmpQ9ZtSE,302
 ripple_down_rules/helpers.py,sha256=TvTJU0BA3dPcAyzvZFvAu7jZqsp8Lu0HAAwvuizlGjg,2018
-ripple_down_rules/rdr.py,sha256=HpvRpg_cenoJGzYeF_5xlYriWOb0xKQjpbeDyHJNeRg,45389
+ripple_down_rules/rdr.py,sha256=qELIEEokGTWj-VBZZeEM_TiHxaWrlvaKRt2qShuxfvo,45739
 ripple_down_rules/rdr_decorators.py,sha256=VdmE0JrE8j89b6Af1R1tLZiKfy3h1VCvhAUefN_FLLQ,6753
 ripple_down_rules/rules.py,sha256=7NB8qWW7XEB45tmJRYsKJqBG8DN3v02fzAFYmOkX8ow,17458
-ripple_down_rules/utils.py,sha256=5dpkujZDj6vjOpl4dCrhAF30xFABwSCleFrioVxgjs8,49375
+ripple_down_rules/start-code-server.sh,sha256=otClk7VmDgBOX2TS_cjws6K0UwvgAUJhoA0ugkPCLqQ,949
+ripple_down_rules/utils.py,sha256=iM2bYRYanuWTnq7dflRar8tMwRxL88B__hWkayGLVz4,50675
 ripple_down_rules/datastructures/__init__.py,sha256=V2aNgf5C96Y5-IGghra3n9uiefpoIm_QdT7cc_C8cxQ,111
 ripple_down_rules/datastructures/callable_expression.py,sha256=jA7424_mWPbOoPICW3eLMX0-ypxnsW6gOqxrJ7JpDbE,11610
 ripple_down_rules/datastructures/case.py,sha256=oC8OSdhXvHE-Zx1IIQlad-fsKzQQqr6MZBW24c-dbeU,15191
 ripple_down_rules/datastructures/dataclasses.py,sha256=GWnUF4h4zfNHSsyBIz3L9y8sLkrXRv0FK_OxzzLc8L8,8183
 ripple_down_rules/datastructures/enums.py,sha256=ce7tqS0otfSTNAOwsnXlhsvIn4iW_Y_N3TNebF3YoZs,5700
 ripple_down_rules/user_interface/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ripple_down_rules/user_interface/gui.py,sha256=mzkyFs0Z7iS22WpPnCwT7HVQYkB72fy8EifXTTYLEf4,27917
-ripple_down_rules/user_interface/ipython_custom_shell.py,sha256=XS3URpfoGCYA__fKOo2AmJ7wQerp7UXKdhdDKiL5gDY,6537
-ripple_down_rules/user_interface/object_diagram.py,sha256=84JlEH0nQmtGmP8Su5iRX3ZfqByYHbVwd0BQYYPuckY,4436
-ripple_down_rules/user_interface/prompt.py,sha256=97s5mhmsqrFTQkfmHssYFko0SPLBDxesHoLumqZO0FA,8028
+ripple_down_rules/user_interface/gui.py,sha256=u0vsd6arUzvHl9HGTwAb0XF-usiifjdXmTagWpaxT-U,27274
+ripple_down_rules/user_interface/ipython_custom_shell.py,sha256=qRQ0g3rnWy8KVG8jBToJ5u13ofou7umdXaDtX2-_Vvc,6521
+ripple_down_rules/user_interface/object_diagram.py,sha256=tsB6iuLNEbHxp5lR2WjyejjWbnAX_nHF9xS8jNPOQVk,4548
+ripple_down_rules/user_interface/prompt.py,sha256=AkkltdDIaioN43lkRKDPKSjJcmdSSGZDMYz7AL7X9lE,8082
 ripple_down_rules/user_interface/template_file_creator.py,sha256=-0L0jGW1VTrL0aer67mIdjFr3gKjXKA6zRZ5IXbY5vY,13959
-ripple_down_rules-0.4.82.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-ripple_down_rules-0.4.82.dist-info/METADATA,sha256=wf_jJCvujpj9b4QjSx_BtmSPODRwKWsXGGhMOwyF3uY,43218
-ripple_down_rules-0.4.82.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-ripple_down_rules-0.4.82.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
-ripple_down_rules-0.4.82.dist-info/RECORD,,
+ripple_down_rules-0.4.84.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+ripple_down_rules-0.4.84.dist-info/METADATA,sha256=OhD2lKh1beytOqH6r0pAdkyGE67TfH8nC46r1n24sAM,43622
+ripple_down_rules-0.4.84.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+ripple_down_rules-0.4.84.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
+ripple_down_rules-0.4.84.dist-info/RECORD,,