ripple-down-rules 0.3.0__py3-none-any.whl → 0.4.1__py3-none-any.whl

ripple_down_rules/prompt.py

@@ -1,510 +0,0 @@
-import ast
-import logging
-import os
-import shutil
-import socket
-import subprocess
-import tempfile
-from _ast import AST
-from functools import cached_property
-from textwrap import indent, dedent
-
-from IPython.core.magic import line_magic, Magics, magics_class
-from IPython.terminal.embed import InteractiveShellEmbed
-from colorama import Fore, Style
-from pygments import highlight
-from pygments.formatters.terminal import TerminalFormatter
-from pygments.lexers.python import PythonLexer
-from traitlets.config import Config
-from typing_extensions import List, Optional, Tuple, Dict, Type
-
-from .datastructures.callable_expression import CallableExpression, parse_string_to_expression
-from .datastructures.case import Case
-from .datastructures.dataclasses import CaseQuery
-from .datastructures.enums import PromptFor, Editor
-from .utils import extract_dependencies, contains_return_statement, get_imports_from_scope, make_list, \
-    get_imports_from_types, extract_function_source, encapsulate_user_input, str_to_snake_case, typing_hint_to_str
-
-
-def detect_available_editor() -> Optional[Editor]:
-    """
-    Detect the available editor on the system.
-
-    :return: The first found editor that is available on the system.
-    """
-    editor_env = os.environ.get("RDR_EDITOR")
-    if editor_env:
-        return Editor.from_str(editor_env)
-    for editor in [Editor.Pycharm, Editor.Code, Editor.CodeServer]:
-        if shutil.which(editor.value):
-            return editor
-    return None
-
-
-def is_port_in_use(port: int = 8080) -> bool:
-    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s:
-        return s.connect_ex(("localhost", port)) == 0
-
-
-def start_code_server(workspace):
-    """
-    Start the code-server in the given workspace.
-    """
-    filename = os.path.join(os.path.dirname(__file__), "start-code-server.sh")
-    os.system(f"chmod +x {filename}")
-    print(f"Starting code-server at {filename}")
-    return subprocess.Popen(["/bin/bash", filename, workspace], stdout=subprocess.PIPE,
-                            stderr=subprocess.PIPE, text=True)
-
-
-@magics_class
-class MyMagics(Magics):
-    temp_file_path: Optional[str] = None
-    """
-    The path to the temporary file that is created for the user to edit.
-    """
-    port: int = int(os.environ.get("RDR_EDITOR_PORT", 8080))
-    """
-    The port to use for the code-server.
-    """
-    process: Optional[subprocess.Popen] = None
-    """
-    The process of the code-server.
-    """
-
-    def __init__(self, shell, scope,
-                 code_to_modify: Optional[str] = None,
-                 prompt_for: Optional[PromptFor] = None,
-                 case_query: Optional[CaseQuery] = None):
-        super().__init__(shell)
-        self.scope = scope
-        self.code_to_modify = code_to_modify
-        self.prompt_for = prompt_for
-        self.case_query = case_query
-        self.output_type = self.get_output_type()
-        self.user_edit_line = 0
-        self.func_name: str = self.get_func_name()
-        self.func_doc: str = self.get_func_doc()
-        self.function_signature: str = self.get_function_signature()
-        self.editor: Optional[Editor] = detect_available_editor()
-        self.workspace: str = os.environ.get("RDR_EDITOR_WORKSPACE", os.path.dirname(self.scope['__file__']))
-        self.temp_file_path: str = os.path.join(self.workspace, "edit_code_here.py")
-
-    def get_output_type(self) -> List[Type]:
-        """
-        :return: The output type of the function as a list of types.
-        """
-        if self.prompt_for == PromptFor.Conditions:
-            output_type = bool
-        else:
-            output_type = self.case_query.attribute_type
-        return make_list(output_type) if output_type is not None else None
-
-    @line_magic
-    def edit(self, line):
-        if self.editor is None:
-            print(f"{Fore.RED}ERROR:: No editor found. Please install PyCharm, VSCode or code-server.{Style.RESET_ALL}")
-            return
-
-        boilerplate_code = self.build_boilerplate_code()
-        self.write_to_file(boilerplate_code)
-
-        self.open_file_in_editor()
-
-    def open_file_in_editor(self):
-        """
-        Open the file in the available editor.
-        """
-        if self.editor == Editor.Pycharm:
-            subprocess.Popen(["pycharm", "--line", str(self.user_edit_line), self.temp_file_path],
-                             stdout=subprocess.DEVNULL,
-                             stderr=subprocess.DEVNULL)
-        elif self.editor == Editor.Code:
-            subprocess.Popen(["code", self.temp_file_path])
-        elif self.editor == Editor.CodeServer:
-            try:
-                subprocess.check_output(["pgrep", "-f", "code-server"])
-                # check if same port is in use
-                if is_port_in_use(self.port):
-                    print(f"Code-server is already running on port {self.port}.")
-                else:
-                    raise ValueError("Port is not in use.")
-            except (subprocess.CalledProcessError, ValueError) as e:
-                self.process = start_code_server(self.workspace)
-            print(f"Open code-server in your browser at http://localhost:{self.port}?folder={self.workspace}")
-        print(f"Edit the file: {Fore.BLUE}{self.temp_file_path}")
-
-    def build_boilerplate_code(self):
-        imports = self.get_imports()
-        if self.function_signature is None:
-            self.function_signature = self.get_function_signature()
-        if self.func_doc is None:
-            self.func_doc = self.get_func_doc()
-        if self.code_to_modify is not None:
-            body = indent(dedent(self.code_to_modify), '    ')
-        else:
-            body = "    # Write your code here\n    pass"
-        boilerplate = f"""{imports}\n\n{self.function_signature}\n    \"\"\"{self.func_doc}\"\"\"\n{body}"""
-        self.user_edit_line = imports.count('\n') + 6
-        return boilerplate
-
-    def get_function_signature(self) -> str:
-        if self.func_name is None:
-            self.func_name = self.get_func_name()
-        output_type_hint = self.get_output_type_hint()
-        func_args = self.get_func_args()
-        return f"def {self.func_name}({func_args}){output_type_hint}:"
-
-    def get_output_type_hint(self) -> str:
-        """
-        :return: A string containing the output type hint for the function.
-        """
-        output_type_hint = ""
-        if self.prompt_for == PromptFor.Conditions:
-            output_type_hint = " -> bool"
-        elif self.prompt_for == PromptFor.Conclusion:
-            output_type_hint = f" -> {self.case_query.attribute_type_hint}"
-        return output_type_hint
-
-    def get_func_args(self) -> str:
-        """
-        :return: A string containing the function arguments.
-        """
-        if self.case_query.is_function:
-            func_args = {}
-            for k, v in self.case_query.case.items():
-                if (self.case_query.function_args_type_hints is not None
-                        and k in self.case_query.function_args_type_hints):
-                    func_args[k] = typing_hint_to_str(self.case_query.function_args_type_hints[k])[0]
-                else:
-                    func_args[k] = type(v).__name__ if not isinstance(v, type) else f"Type[{v.__name__}]"
-            func_args = ', '.join([f"{k}: {v}" if str(v) not in ["NoneType", "None"] else str(k)
-                                   for k, v in func_args.items()])
-        else:
-            func_args = f"case: {self.case_type.__name__}"
-        return func_args
-
-    def write_to_file(self, code: str):
-        if self.temp_file_path is None:
-            tmp = tempfile.NamedTemporaryFile(mode='w+', delete=False, suffix=".py",
-                                              dir=self.workspace)
-            tmp.write(code)
-            tmp.flush()
-            self.temp_file_path = tmp.name
-            tmp.close()
-        else:
-            with open(self.temp_file_path, 'w+') as f:
-                f.write(code)
-
-    def get_imports(self):
-        """
-        :return: A string containing the imports for the function.
-        """
-        case_type_imports = []
-        if self.case_query.is_function:
-            for k, v in self.case_query.case.items():
-                if (self.case_query.function_args_type_hints is not None
-                        and k in self.case_query.function_args_type_hints):
-                    hint_list = typing_hint_to_str(self.case_query.function_args_type_hints[k])[1]
-                    for hint in hint_list:
-                        hint_split = hint.split('.')
-                        if len(hint_split) > 1:
-                            case_type_imports.append(f"from {'.'.join(hint_split[:-1])} import {hint_split[-1]}")
-                else:
-                    if isinstance(v, type):
-                        case_type_imports.append(f"from {v.__module__} import {v.__name__}")
-                    elif hasattr(v, "__module__") and not v.__module__.startswith("__"):
-                        case_type_imports.append(f"\nfrom {type(v).__module__} import {type(v).__name__}")
-        else:
-            case_type_imports.append(f"from {self.case_type.__module__} import {self.case_type.__name__}")
-        if self.output_type is None:
-            output_type_imports = [f"from typing_extensions import Any"]
-        else:
-            output_type_imports = get_imports_from_types(self.output_type)
-            if len(self.output_type) > 1:
-                output_type_imports.append("from typing_extensions import Union")
-            if list in self.output_type:
-                output_type_imports.append("from typing_extensions import List")
-        imports = get_imports_from_scope(self.scope)
-        imports = [i for i in imports if ("get_ipython" not in i)]
-        imports.extend(case_type_imports)
-        imports.extend([oti for oti in output_type_imports if oti not in imports])
-        imports = set(imports)
-        return '\n'.join(imports)
-
-    def get_func_doc(self) -> Optional[str]:
-        """
-        :return: A string containing the function docstring.
-        """
-        if self.prompt_for == PromptFor.Conditions:
-            return (f"Get conditions on whether it's possible to conclude a value"
-                    f" for {self.case_query.name}")
-        else:
-            return f"Get possible value(s) for {self.case_query.name}"
-
-    def get_func_name(self) -> Optional[str]:
-        func_name = ""
-        if self.prompt_for == PromptFor.Conditions:
-            func_name = f"{self.prompt_for.value.lower()}_for_"
-        case_name = self.case_query.name.replace(".", "_")
-        if self.case_query.is_function:
-            # convert any CamelCase word into snake_case by adding _ before each capital letter
-            case_name = case_name.replace(f"_{self.case_query.attribute_name}", "")
-        func_name += case_name
-        return str_to_snake_case(func_name)
-
-    @cached_property
-    def case_type(self) -> Type:
-        """
-        Get the type of the case object in the current scope.
-
-        :return: The type of the case object.
-        """
-        case = self.scope['case']
-        return case._obj_type if isinstance(case, Case) else type(case)
-
-    @line_magic
-    def load(self, line):
-        if not self.temp_file_path:
-            print(f"{Fore.RED}ERROR:: No file to load. Run %edit first.{Style.RESET_ALL}")
-            return
-
-        with open(self.temp_file_path, 'r') as f:
-            source = f.read()
-
-        tree = ast.parse(source)
-        for node in tree.body:
-            if isinstance(node, ast.FunctionDef) and node.name == self.func_name:
-                exec_globals = {}
-                exec(source, self.scope, exec_globals)
-                user_function = exec_globals[self.func_name]
-                self.shell.user_ns[self.func_name] = user_function
-                print(f"{Fore.BLUE}Loaded `{self.func_name}` function into user namespace.{Style.RESET_ALL}")
-                return
-
-        print(f"{Fore.RED}ERROR:: Function `{self.func_name}` not found.{Style.RESET_ALL}")
-
-    @line_magic
-    def help(self, line):
-        """
-        Display help information for the Ipython shell.
-        """
-        help_text = f"""
-Directly write python code in the shell, and then `{Fore.GREEN}return {Fore.RESET}output`. Or use 
-the magic commands to write the code in a temporary file and edit it in PyCharm:
-{Fore.MAGENTA}Usage: %edit{Style.RESET_ALL}
-Opens a temporary file in PyCharm for editing a function (conclusion or conditions for case)
- that will be executed on the case object.
-{Fore.MAGENTA}Usage: %load{Style.RESET_ALL}
-Loads the function defined in the temporary file into the user namespace, that can then be used inside the
- Ipython shell. You can then do `{Fore.GREEN}return {Fore.RESET}function_name(case)`.
-        """
-        print(help_text)
-
-    def __del__(self):
-        if hasattr(self, 'process') and self.process is not None and self.process.poll() is None:
-            self.process.terminate()  # Graceful shutdown
-            self.process.wait()  # Ensure cleanup
-
-
-class CustomInteractiveShell(InteractiveShellEmbed):
-    def __init__(self, code_to_modify: Optional[str] = None,
-                 prompt_for: Optional[PromptFor] = None,
-                 case_query: Optional[CaseQuery] = None,
-                 **kwargs):
-        super().__init__(**kwargs)
-        self.my_magics = MyMagics(self, self.user_ns, code_to_modify=code_to_modify,
-                                  prompt_for=prompt_for, case_query=case_query)
-        self.register_magics(self.my_magics)
-        self.all_lines = []
-
-    def run_cell(self, raw_cell: str, **kwargs):
-        """
-        Override the run_cell method to capture return statements.
-        """
-        if contains_return_statement(raw_cell) and 'def ' not in raw_cell:
-            if self.my_magics.func_name in raw_cell:
-                self.all_lines = extract_function_source(self.my_magics.temp_file_path,
-                                                         self.my_magics.func_name,
-                                                         join_lines=False)[self.my_magics.func_name]
-            self.all_lines.append(raw_cell)
-            self.history_manager.store_inputs(line_num=self.execution_count, source=raw_cell)
-            self.ask_exit()
-            return None
-        result = super().run_cell(raw_cell, **kwargs)
-        if result.error_in_exec is None and result.error_before_exec is None:
-            self.all_lines.append(raw_cell)
-        return result
-
-
-class IPythonShell:
-    """
-    Create an embedded Ipython shell that can be used to prompt the user for input.
-    """
-
-    def __init__(self, scope: Optional[Dict] = None, header: Optional[str] = None,
-                 prompt_for: Optional[PromptFor] = None, case_query: Optional[CaseQuery] = None,
-                 code_to_modify: Optional[str] = None):
-        """
-        Initialize the Ipython shell with the given scope and header.
-
-        :param scope: The scope to use for the shell.
-        :param header: The header to display when the shell is started.
-        :param prompt_for: The type of information to ask the user about.
-        :param case_query: The case query which contains the case and the attribute to ask about.
-        :param code_to_modify: The code to modify. If given, will be used as a start for user to modify.
-        """
-        self.scope: Dict = scope or {}
-        self.header: str = header or ">>> Embedded Ipython Shell"
-        self.case_query: Optional[CaseQuery] = case_query
-        self.prompt_for: Optional[PromptFor] = prompt_for
-        self.code_to_modify: Optional[str] = code_to_modify
-        self.user_input: Optional[str] = None
-        self.shell: CustomInteractiveShell = self._init_shell()
-        self.all_code_lines: List[str] = []
-
-    def _init_shell(self):
-        """
-        Initialize the Ipython shell with a custom configuration.
-        """
-        cfg = Config()
-        shell = CustomInteractiveShell(config=cfg, user_ns=self.scope, banner1=self.header,
-                                       code_to_modify=self.code_to_modify,
-                                       prompt_for=self.prompt_for,
-                                       case_query=self.case_query,
-                                       )
-        return shell
-
-    def run(self):
-        """
-        Run the embedded shell.
-        """
-        while True:
-            try:
-                self.shell()
-                self.update_user_input_from_code_lines()
-                break
-            except Exception as e:
-                logging.error(e)
-                print(f"{Fore.RED}ERROR::{e}{Style.RESET_ALL}")
-
-    def update_user_input_from_code_lines(self):
-        """
-        Update the user input from the code lines captured in the shell.
-        """
-        if len(self.shell.all_lines) == 1 and self.shell.all_lines[0].replace('return', '').strip() == '':
-            self.user_input = None
-        else:
-            self.all_code_lines = extract_dependencies(self.shell.all_lines)
-            if len(self.all_code_lines) == 1 and self.all_code_lines[0].strip() == '':
-                self.user_input = None
-            else:
-                self.user_input = '\n'.join(self.all_code_lines)
-                self.user_input = encapsulate_user_input(self.user_input, self.shell.my_magics.function_signature,
-                                                         self.shell.my_magics.func_doc)
-                if self.case_query.is_function:
-                    args = "**case"
-                else:
-                    args = "case"
-                if f"return {self.shell.my_magics.func_name}({args})" not in self.user_input:
-                    self.user_input = self.user_input.strip() + f"\nreturn {self.shell.my_magics.func_name}({args})"
-
-
-def prompt_user_for_expression(case_query: CaseQuery, prompt_for: PromptFor, prompt_str: Optional[str] = None) \
-        -> Tuple[Optional[str], Optional[CallableExpression]]:
-    """
-    Prompt the user for an executable python expression to the given case query.
-
-    :param case_query: The case query to prompt the user for.
-    :param prompt_for: The type of information ask user about.
-    :param prompt_str: The prompt string to display to the user.
-    :return: A callable expression that takes a case and executes user expression on it.
-    """
-    prev_user_input: Optional[str] = None
-    callable_expression: Optional[CallableExpression] = None
-    while True:
-        user_input, expression_tree = prompt_user_about_case(case_query, prompt_for, prompt_str,
-                                                             code_to_modify=prev_user_input)
-        if user_input is None:
-            if prompt_for == PromptFor.Conclusion:
-                print(f"{Fore.YELLOW}No conclusion provided. Exiting.{Style.RESET_ALL}")
-                return None, None
-            else:
-                print(f"{Fore.RED}Conditions must be provided. Please try again.{Style.RESET_ALL}")
-                continue
-        prev_user_input = '\n'.join(user_input.split('\n')[2:-1])
-        conclusion_type = bool if prompt_for == PromptFor.Conditions else case_query.attribute_type
-        callable_expression = CallableExpression(user_input, conclusion_type, expression_tree=expression_tree,
-                                                 scope=case_query.scope,
-                                                  mutually_exclusive=case_query.mutually_exclusive)
-        try:
-            result = callable_expression(case_query.case)
-            if len(make_list(result)) == 0:
-                print(f"{Fore.YELLOW}The given expression gave an empty result for case {case_query.name}."
-                      f" Please modify!{Style.RESET_ALL}")
-                continue
-            break
-        except Exception as e:
-            logging.error(e)
-            print(f"{Fore.RED}{e}{Style.RESET_ALL}")
-    return user_input, callable_expression
-
-
-def prompt_user_about_case(case_query: CaseQuery, prompt_for: PromptFor,
-                           prompt_str: Optional[str] = None,
-                           code_to_modify: Optional[str] = None) -> Tuple[Optional[str], Optional[AST]]:
-    """
-    Prompt the user for input.
-
-    :param case_query: The case query to prompt the user for.
-    :param prompt_for: The type of information the user should provide for the given case.
-    :param prompt_str: The prompt string to display to the user.
-    :param code_to_modify: The code to modify. If given will be used as a start for user to modify.
-    :return: The user input, and the executable expression that was parsed from the user input.
-    """
-    if prompt_str is None:
-        if prompt_for == PromptFor.Conclusion:
-            prompt_str = f"Give possible value(s) for:\n"
-        else:
-            prompt_str = f"Give conditions on when can the rule be evaluated for:\n"
-        prompt_str += (f"{Fore.CYAN}{case_query.name}{Fore.MAGENTA} of type(s) "
-                       f"{Fore.CYAN}({', '.join(map(lambda x: x.__name__, case_query.core_attribute_type))}){Fore.MAGENTA}")
-        if prompt_for == PromptFor.Conditions:
-            prompt_str += (f"\ne.g. `{Fore.GREEN}return {Fore.BLUE}len{Fore.RESET}(case.attribute) > {Fore.BLUE}0` "
-                           f"{Fore.MAGENTA}\nOR `{Fore.GREEN}return {Fore.YELLOW}True`{Fore.MAGENTA} (If you want the"
-                           f" rule to be always evaluated) \n"
-                           f"You can also do {Fore.YELLOW}%edit{Fore.MAGENTA} for more complex conditions.")
-    prompt_str = f"{Fore.MAGENTA}{prompt_str}{Fore.YELLOW}\n(Write %help for guide){Fore.RESET}"
-    scope = {'case': case_query.case, **case_query.scope}
-    shell = IPythonShell(scope=scope, header=prompt_str, prompt_for=prompt_for, case_query=case_query,
-                         code_to_modify=code_to_modify)
-    return prompt_user_input_and_parse_to_expression(shell=shell)
-
-
-def prompt_user_input_and_parse_to_expression(shell: Optional[IPythonShell] = None,
-                                              user_input: Optional[str] = None) \
-        -> Tuple[Optional[str], Optional[ast.AST]]:
-    """
-    Prompt the user for input.
-
-    :param shell: The Ipython shell to use for prompting the user.
-    :param user_input: The user input to use. If given, the user input will be used instead of prompting the user.
-    :return: The user input and the AST tree.
-    """
-    while True:
-        if user_input is None:
-            shell = IPythonShell() if shell is None else shell
-            shell.run()
-            user_input = shell.user_input
-            if user_input is None:
-                return None, None
-            print(f"{Fore.BLUE}Captured User input: {Style.RESET_ALL}")
-            highlighted_code = highlight(user_input, PythonLexer(), TerminalFormatter())
-            print(highlighted_code)
-        try:
-            return user_input, parse_string_to_expression(user_input)
-        except Exception as e:
-            msg = f"Error parsing expression: {e}"
-            logging.error(msg)
-            print(f"{Fore.RED}{msg}{Style.RESET_ALL}")
-            user_input = None

ripple_down_rules-0.3.0.dist-info/RECORD

@@ -1,20 +0,0 @@
-ripple_down_rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ripple_down_rules/datasets.py,sha256=zi5LVNA3oYUYL26HVUgOV8lKQ-wSmaJeOKHptdJ8A3E,6667
-ripple_down_rules/experts.py,sha256=8wTInaKum38mH5r5esw7tXq_iL15-JP2tf5VIHHBmpw,6229
-ripple_down_rules/failures.py,sha256=E6ajDUsw3Blom8eVLbA7d_Qnov2conhtZ0UmpQ9ZtSE,302
-ripple_down_rules/helpers.py,sha256=TvTJU0BA3dPcAyzvZFvAu7jZqsp8Lu0HAAwvuizlGjg,2018
-ripple_down_rules/prompt.py,sha256=KmlMRZRKqoyYIinp9l09LWL7e41DsqsGNcVbHRjebhg,23122
-ripple_down_rules/rdr.py,sha256=7Ir3jYqAf2qZwi0Quz-ZMc3jreiSADo9xfAfLj2gbLM,43491
-ripple_down_rules/rdr_decorators.py,sha256=VdmE0JrE8j89b6Af1R1tLZiKfy3h1VCvhAUefN_FLLQ,6753
-ripple_down_rules/rules.py,sha256=QQy7NBG6mKiowxVG_LjQJBxLTDW2hMyx5zAgwUxdCMM,17183
-ripple_down_rules/utils.py,sha256=SXNkIA9k75yKbfCAWQzq4XVxh3CpcxqSistnVFY3gBQ,48917
-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=sOEKvsmcFUnztScFOGmrxgrBNeIYHfV_CeQ5_Sj62so,5368
-ripple_down_rules-0.3.0.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-ripple_down_rules-0.3.0.dist-info/METADATA,sha256=f-xZg62otuqgnzlf4Bwzt0ns25WQLWl2RgIARt9v-tk,42576
-ripple_down_rules-0.3.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-ripple_down_rules-0.3.0.dist-info/top_level.txt,sha256=VeoLhEhyK46M1OHwoPbCQLI1EifLjChqGzhQ6WEUqeM,18
-ripple_down_rules-0.3.0.dist-info/RECORD,,