janito 1.14.3__py3-none-any.whl → 2.0.1__py3-none-any.whl

janito/{agent/tools → tools/adapters/local}/get_file_outline/search_outline.py

@@ -1,24 +1,29 @@
-from janito.agent.tool_base import ToolBase
-from janito.agent.tools_utils.action_type import ActionType
-from janito.agent.tool_registry import register_tool
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
 
 
-@register_tool(name="search_outline")
 class SearchOutlineTool(ToolBase):
     """
     Tool for searching outlines in files.
+
+    Args:
+        file_path (str): Path to the file for which to generate an outline.
+    Returns:
+        str: Outline search result or status message.
     """
 
+    tool_name = "search_outline"
+
     def run(self, file_path: str) -> str:
-        from janito.agent.tools_utils.utils import display_path
+        from janito.tools.tool_utils import display_path
         from janito.i18n import tr
 
-        self.report_info(
-            ActionType.READ,
+        self.report_action(
             tr(
                 "🔍 Searching for outline in '{disp_path}'",
                 disp_path=display_path(file_path),
             ),
+            ReportAction.READ,
         )
         # ... rest of implementation ...
         # Example warnings and successes:

janito/{agent/tools → tools/adapters/local}/move_file.py

@@ -1,13 +1,13 @@
 import os
 import shutil
-from janito.agent.tool_registry import register_tool
-from janito.agent.tools_utils.utils import display_path
-from janito.agent.tool_base import ToolBase
-from janito.agent.tools_utils.action_type import ActionType
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.tools.tool_utils import display_path
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
 from janito.i18n import tr
 
 
-@register_tool(name="move_file")
+@register_local_tool
 class MoveFileTool(ToolBase):
     """
     Move a file or directory from src_path to dest_path.
@@ -21,6 +21,8 @@ class MoveFileTool(ToolBase):
         str: Status message indicating the result.
     """
 
+    tool_name = "move_file"
+
     def run(
         self,
         src_path: str,
@@ -47,13 +49,13 @@ class MoveFileTool(ToolBase):
                 return err_msg
 
         try:
-            self.report_info(
-                ActionType.WRITE,
+            self.report_action(
                 tr(
                     "📝 Moving from '{disp_src}' to '{disp_dest}' ...",
                     disp_src=disp_src,
                     disp_dest=disp_dest,
                 ),
+                ReportAction.CREATE,
             )
             shutil.move(src, dest)
             self.report_success(tr("✅ Move complete."))
@@ -107,7 +109,8 @@ class MoveFileTool(ToolBase):
                     tr(
                         "❗ Destination '{disp_dest}' exists and overwrite is False.",
                         disp_dest=disp_dest,
-                    )
+                    ),
+                    ReportAction.MOVE,
                 )
                 return None, tr(
                     "❗ Destination '{disp_dest}' already exists and overwrite is False.",
@@ -127,7 +130,8 @@ class MoveFileTool(ToolBase):
                     shutil.rmtree(dest)
             except Exception as e:
                 self.report_error(
-                    tr("❌ Error removing destination before move: {error}", error=e)
+                    tr("❌ Error removing destination before move: {error}", error=e),
+                    ReportAction.MOVE,
                 )
                 return None, tr(
                     "❌ Error removing destination before move: {error}", error=e

janito/tools/adapters/local/open_html_in_browser.py

@@ -0,0 +1,34 @@
+from janito.tools.tool_base import ToolBase
+from janito.tools.adapters.local.adapter import register_local_tool
+import webbrowser
+import os
+
+@register_local_tool
+class OpenHtmlInBrowserTool(ToolBase):
+    """
+    Opens an HTML file in the default web browser.
+
+    Args:
+        file_path (str): The path to the HTML file to open.
+
+    Returns:
+        str: Status message indicating the result. Example:
+            - "✅ Successfully opened the file in the default browser."
+            - "⚠️ Error: The specified file does not exist."
+            - "⚠️ Error: The specified file is not an HTML file."
+    """
+
+    tool_name = "open_html_in_browser"
+
+    def run(self, file_path: str) -> str:
+        if not os.path.exists(file_path):
+            return "⚠️ Error: The specified file does not exist."
+        
+        if not file_path.lower().endswith('.html'):
+            return "⚠️ Error: The specified file is not an HTML file."
+        
+        try:
+            webbrowser.open(f"file://{os.path.abspath(file_path)}")
+            return "✅ Opened."
+        except Exception as e:
+            return f"⚠️ Error: {str(e)}"

janito/{agent/tools → tools/adapters/local}/open_url.py

@@ -1,11 +1,11 @@
 import webbrowser
-from janito.agent.tool_registry import register_tool
-from janito.agent.tool_base import ToolBase
-from janito.agent.tools_utils.action_type import ActionType
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
 from janito.i18n import tr
 
 
-@register_tool(name="open_url")
+@register_local_tool
 class OpenUrlTool(ToolBase):
     """
     Open the supplied URL in the default web browser.
@@ -15,11 +15,13 @@ class OpenUrlTool(ToolBase):
         str: Status message indicating the result.
     """
 
+    tool_name = "open_url"
+
     def run(self, url: str) -> str:
         if not url.strip():
             self.report_warning(tr("ℹ️ Empty URL provided."))
             return tr("Warning: Empty URL provided. Operation skipped.")
-        self.report_info(ActionType.READ, tr("🌐 Opening URL '{url}' ...", url=url))
+        self.report_action(tr("🌐 Opening URL '{url}' ...", url=url), ReportAction.READ)
         try:
             webbrowser.open(url)
         except Exception as err:

janito/tools/adapters/local/python_code_run.py

@@ -0,0 +1,165 @@
+import subprocess
+import os
+import sys
+import tempfile
+import threading
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.i18n import tr
+
+
+@register_local_tool
+class PythonCodeRunTool(ToolBase):
+    """
+    Tool to execute Python code by passing it to the interpreter via standard input (stdin).
+
+    Parameters:
+        code (str): The Python code to execute as a string.
+        timeout (int): Timeout in seconds for the command. Defaults to 60.
+
+    Returns:
+        str: Output and status message, or file paths/line counts if output is large.
+    """
+    provides_execution = True
+    tool_name = "python_code_run"
+
+    def run(self, code: str, timeout: int = 60) -> str:
+        if not code.strip():
+            self.report_warning(tr("ℹ️ Empty code provided."), ReportAction.EXECUTE)
+            return tr("Warning: Empty code provided. Operation skipped.")
+        self.report_action(
+            tr("⚡ Running: python (stdin mode) ...\n{code}\n", code=code),
+            ReportAction.EXECUTE,
+        )
+        try:
+            with (
+                tempfile.NamedTemporaryFile(
+                    mode="w+",
+                    prefix="python_stdin_stdout_",
+                    delete=False,
+                    encoding="utf-8",
+                ) as stdout_file,
+                tempfile.NamedTemporaryFile(
+                    mode="w+",
+                    prefix="python_stdin_stderr_",
+                    delete=False,
+                    encoding="utf-8",
+                ) as stderr_file,
+            ):
+                process = subprocess.Popen(
+                    [sys.executable],
+                    stdin=subprocess.PIPE,
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                    text=True,
+                    bufsize=1,
+                    universal_newlines=True,
+                    encoding="utf-8",
+                    env={**os.environ, "PYTHONIOENCODING": "utf-8"},
+                )
+                stdout_lines, stderr_lines = self._stream_process_output(
+                    process, stdout_file, stderr_file, code
+                )
+                return_code = self._wait_for_process(process, timeout)
+                if return_code is None:
+                    return tr(
+                        "Code timed out after {timeout} seconds.", timeout=timeout
+                    )
+                stdout_file.flush()
+                stderr_file.flush()
+                self.report_success(
+                    tr("✅ Return code {return_code}", return_code=return_code),
+                    ReportAction.EXECUTE,
+                )
+                return self._format_result(
+                    stdout_file.name, stderr_file.name, return_code
+                )
+        except Exception as e:
+            self.report_error(tr("❌ Error: {error}", error=e), ReportAction.EXECUTE)
+            return tr("Error running code via stdin: {error}", error=e)
+
+    def _stream_process_output(self, process, stdout_file, stderr_file, code):
+        stdout_lines = 0
+        stderr_lines = 0
+
+        def stream_output(stream, file_obj, report_func, count_func):
+            nonlocal stdout_lines, stderr_lines
+            for line in stream:
+                file_obj.write(line)
+                file_obj.flush()
+                report_func(line.rstrip("\r\n"))
+                if count_func == "stdout":
+                    stdout_lines += 1
+                else:
+                    stderr_lines += 1
+
+        stdout_thread = threading.Thread(
+            target=stream_output,
+            args=(process.stdout, stdout_file, self.report_stdout, "stdout"),
+        )
+        stderr_thread = threading.Thread(
+            target=stream_output,
+            args=(process.stderr, stderr_file, self.report_stderr, "stderr"),
+        )
+        stdout_thread.start()
+        stderr_thread.start()
+        process.stdin.write(code)
+        process.stdin.close()
+        stdout_thread.join()
+        stderr_thread.join()
+        return stdout_lines, stderr_lines
+
+    def _wait_for_process(self, process, timeout):
+        try:
+            return process.wait(timeout=timeout)
+        except subprocess.TimeoutExpired:
+            process.kill()
+            self.report_error(
+                tr("❌ Timed out after {timeout} seconds.", timeout=timeout),
+                ReportAction.EXECUTE,
+            )
+            return None
+
+    def _format_result(self, stdout_file_name, stderr_file_name, return_code):
+        with open(stdout_file_name, "r", encoding="utf-8", errors="replace") as out_f:
+            stdout_content = out_f.read()
+        with open(stderr_file_name, "r", encoding="utf-8", errors="replace") as err_f:
+            stderr_content = err_f.read()
+        max_lines = 100
+        stdout_lines = stdout_content.count("\n")
+        stderr_lines = stderr_content.count("\n")
+
+        def head_tail(text, n=10):
+            lines = text.splitlines()
+            if len(lines) <= 2 * n:
+                return "\n".join(lines)
+            return "\n".join(
+                lines[:n]
+                + ["... ({} lines omitted) ...".format(len(lines) - 2 * n)]
+                + lines[-n:]
+            )
+
+        if stdout_lines <= max_lines and stderr_lines <= max_lines:
+            result = f"Return code: {return_code}\n--- python_code_run: STDOUT ---\n{stdout_content}"
+            if stderr_content.strip():
+                result += f"\n--- python_code_run: STDERR ---\n{stderr_content}"
+            return result
+        else:
+            result = f"stdout_file: {stdout_file_name} (lines: {stdout_lines})\n"
+            if stderr_lines > 0 and stderr_content.strip():
+                result += f"stderr_file: {stderr_file_name} (lines: {stderr_lines})\n"
+            result += f"returncode: {return_code}\n"
+            result += (
+                "--- python_code_run: STDOUT (head/tail) ---\n"
+                + head_tail(stdout_content)
+                + "\n"
+            )
+            if stderr_content.strip():
+                result += (
+                    "--- python_code_run: STDERR (head/tail) ---\n"
+                    + head_tail(stderr_content)
+                    + "\n"
+                )
+            result += "Use the view_file tool to inspect the contents of these files when needed."
+            return result

janito/tools/adapters/local/python_command_run.py

@@ -0,0 +1,163 @@
+import subprocess
+import os
+import sys
+import tempfile
+import threading
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.i18n import tr
+
+
+@register_local_tool
+class PythonCommandRunTool(ToolBase):
+    """
+    Tool to execute Python code using the `python -c` command-line flag.
+
+    Parameters:
+        code (str): The Python code to execute as a string.
+        timeout (int): Timeout in seconds for the command. Defaults to 60.
+
+    Returns:
+        str: Output and status message, or file paths/line counts if output is large.
+    """
+    provides_execution = True
+    tool_name = "python_command_run"
+
+    def run(self, code: str, timeout: int = 60) -> str:
+        if not code.strip():
+            self.report_warning(tr("ℹ️ Empty code provided."), ReportAction.EXECUTE)
+            return tr("Warning: Empty code provided. Operation skipped.")
+        self.report_action(
+            tr("🐍 Running: python -c ...\n{code}\n", code=code), ReportAction.EXECUTE
+        )
+        try:
+            with (
+                tempfile.NamedTemporaryFile(
+                    mode="w+",
+                    prefix="python_cmd_stdout_",
+                    delete=False,
+                    encoding="utf-8",
+                ) as stdout_file,
+                tempfile.NamedTemporaryFile(
+                    mode="w+",
+                    prefix="python_cmd_stderr_",
+                    delete=False,
+                    encoding="utf-8",
+                ) as stderr_file,
+            ):
+                process = subprocess.Popen(
+                    [sys.executable, "-c", code],
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                    text=True,
+                    bufsize=1,
+                    universal_newlines=True,
+                    encoding="utf-8",
+                    env={**os.environ, "PYTHONIOENCODING": "utf-8"},
+                )
+                stdout_lines, stderr_lines = self._stream_process_output(
+                    process, stdout_file, stderr_file
+                )
+                return_code = self._wait_for_process(process, timeout)
+                if return_code is None:
+                    return tr(
+                        "Code timed out after {timeout} seconds.", timeout=timeout
+                    )
+                stdout_file.flush()
+                stderr_file.flush()
+                self.report_success(
+                    tr("✅ Return code {return_code}", return_code=return_code),
+                    ReportAction.EXECUTE,
+                )
+                return self._format_result(
+                    stdout_file.name, stderr_file.name, return_code
+                )
+        except Exception as e:
+            self.report_error(tr("❌ Error: {error}", error=e), ReportAction.EXECUTE)
+            return tr("Error running code: {error}", error=e)
+
+    def _stream_process_output(self, process, stdout_file, stderr_file):
+        stdout_lines = 0
+        stderr_lines = 0
+
+        def stream_output(stream, file_obj, report_func, count_func):
+            nonlocal stdout_lines, stderr_lines
+            for line in stream:
+                file_obj.write(line)
+                file_obj.flush()
+                from janito.tools.tool_base import ReportAction
+
+                report_func(line.rstrip("\r\n"), ReportAction.EXECUTE)
+                if count_func == "stdout":
+                    stdout_lines += 1
+                else:
+                    stderr_lines += 1
+
+        stdout_thread = threading.Thread(
+            target=stream_output,
+            args=(process.stdout, stdout_file, self.report_stdout, "stdout"),
+        )
+        stderr_thread = threading.Thread(
+            target=stream_output,
+            args=(process.stderr, stderr_file, self.report_stderr, "stderr"),
+        )
+        stdout_thread.start()
+        stderr_thread.start()
+        stdout_thread.join()
+        stderr_thread.join()
+        return stdout_lines, stderr_lines
+
+    def _wait_for_process(self, process, timeout):
+        try:
+            return process.wait(timeout=timeout)
+        except subprocess.TimeoutExpired:
+            process.kill()
+            self.report_error(
+                tr("❌ Timed out after {timeout} seconds.", timeout=timeout),
+                ReportAction.EXECUTE,
+            )
+            return None
+
+    def _format_result(self, stdout_file_name, stderr_file_name, return_code):
+        with open(stdout_file_name, "r", encoding="utf-8", errors="replace") as out_f:
+            stdout_content = out_f.read()
+        with open(stderr_file_name, "r", encoding="utf-8", errors="replace") as err_f:
+            stderr_content = err_f.read()
+        max_lines = 100
+        stdout_lines = stdout_content.count("\n")
+        stderr_lines = stderr_content.count("\n")
+
+        def head_tail(text, n=10):
+            lines = text.splitlines()
+            if len(lines) <= 2 * n:
+                return "\n".join(lines)
+            return "\n".join(
+                lines[:n]
+                + ["... ({} lines omitted) ...".format(len(lines) - 2 * n)]
+                + lines[-n:]
+            )
+
+        if stdout_lines <= max_lines and stderr_lines <= max_lines:
+            result = f"Return code: {return_code}\n--- python_command_run: STDOUT ---\n{stdout_content}"
+            if stderr_content.strip():
+                result += f"\n--- python_command_run: STDERR ---\n{stderr_content}"
+            return result
+        else:
+            result = f"stdout_file: {stdout_file_name} (lines: {stdout_lines})\n"
+            if stderr_lines > 0 and stderr_content.strip():
+                result += f"stderr_file: {stderr_file_name} (lines: {stderr_lines})\n"
+            result += f"returncode: {return_code}\n"
+            result += (
+                "--- python_command_run: STDOUT (head/tail) ---\n"
+                + head_tail(stdout_content)
+                + "\n"
+            )
+            if stderr_content.strip():
+                result += (
+                    "--- python_command_run: STDERR (head/tail) ---\n"
+                    + head_tail(stderr_content)
+                    + "\n"
+                )
+            result += "Use the view_file tool to inspect the contents of these files when needed."
+            return result

janito/tools/adapters/local/python_file_run.py

@@ -0,0 +1,162 @@
+import subprocess
+import os
+import sys
+import tempfile
+import threading
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.i18n import tr
+
+
+@register_local_tool
+class PythonFileRunTool(ToolBase):
+    """
+    Tool to execute a specified Python script file.
+
+    Parameters:
+        file_path (str): Path to the Python script file to execute.
+        timeout (int): Timeout in seconds for the command. Defaults to 60.
+
+    Returns:
+        str: Output and status message, or file paths/line counts if output is large.
+    """
+    provides_execution = True
+    tool_name = "python_file_run"
+
+    def run(self, file_path: str, timeout: int = 60) -> str:
+        self.report_action(
+            tr("🚀 Running: python {file_path}", file_path=file_path),
+            ReportAction.EXECUTE,
+        )
+        try:
+            with (
+                tempfile.NamedTemporaryFile(
+                    mode="w+",
+                    prefix="python_file_stdout_",
+                    delete=False,
+                    encoding="utf-8",
+                ) as stdout_file,
+                tempfile.NamedTemporaryFile(
+                    mode="w+",
+                    prefix="python_file_stderr_",
+                    delete=False,
+                    encoding="utf-8",
+                ) as stderr_file,
+            ):
+                process = subprocess.Popen(
+                    [sys.executable, file_path],
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                    text=True,
+                    bufsize=1,
+                    universal_newlines=True,
+                    encoding="utf-8",
+                    env={**os.environ, "PYTHONIOENCODING": "utf-8"},
+                )
+                stdout_lines, stderr_lines = self._stream_process_output(
+                    process, stdout_file, stderr_file
+                )
+                return_code = self._wait_for_process(process, timeout)
+                if return_code is None:
+                    return tr(
+                        "Code timed out after {timeout} seconds.", timeout=timeout
+                    )
+                stdout_file.flush()
+                stderr_file.flush()
+                self.report_success(
+                    tr("✅ Return code {return_code}", return_code=return_code),
+                    ReportAction.EXECUTE,
+                )
+                return self._format_result(
+                    stdout_file.name, stderr_file.name, return_code
+                )
+        except Exception as e:
+            self.report_error(tr("❌ Error: {error}", error=e), ReportAction.EXECUTE)
+            return tr("Error running file: {error}", error=e)
+
+    def _stream_process_output(self, process, stdout_file, stderr_file):
+        stdout_lines = 0
+        stderr_lines = 0
+
+        def stream_output(stream, file_obj, report_func, count_func):
+            nonlocal stdout_lines, stderr_lines
+            for line in stream:
+                file_obj.write(line)
+                file_obj.flush()
+                # Always supply a default action for stdout/stderr reporting
+                from janito.report_events import ReportAction
+
+                report_func(line.rstrip("\r\n"), ReportAction.EXECUTE)
+                if count_func == "stdout":
+                    stdout_lines += 1
+                else:
+                    stderr_lines += 1
+
+        stdout_thread = threading.Thread(
+            target=stream_output,
+            args=(process.stdout, stdout_file, self.report_stdout, "stdout"),
+        )
+        stderr_thread = threading.Thread(
+            target=stream_output,
+            args=(process.stderr, stderr_file, self.report_stderr, "stderr"),
+        )
+        stdout_thread.start()
+        stderr_thread.start()
+        stdout_thread.join()
+        stderr_thread.join()
+        return stdout_lines, stderr_lines
+
+    def _wait_for_process(self, process, timeout):
+        try:
+            return process.wait(timeout=timeout)
+        except subprocess.TimeoutExpired:
+            process.kill()
+            self.report_error(
+                tr("❌ Timed out after {timeout} seconds.", timeout=timeout),
+                ReportAction.EXECUTE,
+            )
+            return None
+
+    def _format_result(self, stdout_file_name, stderr_file_name, return_code):
+        with open(stdout_file_name, "r", encoding="utf-8", errors="replace") as out_f:
+            stdout_content = out_f.read()
+        with open(stderr_file_name, "r", encoding="utf-8", errors="replace") as err_f:
+            stderr_content = err_f.read()
+        max_lines = 100
+        stdout_lines = stdout_content.count("\n")
+        stderr_lines = stderr_content.count("\n")
+
+        def head_tail(text, n=10):
+            lines = text.splitlines()
+            if len(lines) <= 2 * n:
+                return "\n".join(lines)
+            return "\n".join(
+                lines[:n]
+                + ["... ({} lines omitted) ...".format(len(lines) - 2 * n)]
+                + lines[-n:]
+            )
+
+        if stdout_lines <= max_lines and stderr_lines <= max_lines:
+            result = f"Return code: {return_code}\n--- python_file_run: STDOUT ---\n{stdout_content}"
+            if stderr_content.strip():
+                result += f"\n--- python_file_run: STDERR ---\n{stderr_content}"
+            return result
+        else:
+            result = f"stdout_file: {stdout_file_name} (lines: {stdout_lines})\n"
+            if stderr_lines > 0 and stderr_content.strip():
+                result += f"stderr_file: {stderr_file_name} (lines: {stderr_lines})\n"
+            result += f"returncode: {return_code}\n"
+            result += (
+                "--- python_file_run: STDOUT (head/tail) ---\n"
+                + head_tail(stdout_content)
+                + "\n"
+            )
+            if stderr_content.strip():
+                result += (
+                    "--- python_file_run: STDERR (head/tail) ---\n"
+                    + head_tail(stderr_content)
+                    + "\n"
+                )
+            result += "Use the view_file tool to inspect the contents of these files when needed."
+            return result