janito 2.3.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

janito/tools/adapters/local/ask_user.py

@@ -1,102 +1,101 @@
-from janito.tools.tool_base import ToolBase
-from janito.tools.adapters.local.adapter import register_local_tool
-
-from rich import print as rich_print
-from janito.i18n import tr
-from rich.panel import Panel
-from prompt_toolkit import PromptSession
-from prompt_toolkit.key_binding import KeyBindings
-from prompt_toolkit.enums import EditingMode
-from prompt_toolkit.formatted_text import HTML
-from janito.cli.chat_mode.prompt_style import chat_shell_style
-from prompt_toolkit.styles import Style
-
-toolbar_style = Style.from_dict({"bottom-toolbar": "fg:yellow bg:darkred"})
-
-
-@register_local_tool
-class AskUserTool(ToolBase):
-    """
-    Prompts the user for clarification or input with a question.
-
-    Args:
-        question (str): The question to ask the user.
-
-    Returns:
-        str: The user's response as a string. Example:
-            - "Yes"
-            - "No"
-            - "Some detailed answer..."
-    """
-
-    tool_name = "ask_user"
-
-    def run(self, question: str) -> str:
-
-        print()  # Print an empty line before the question panel
-        rich_print(Panel.fit(question, title=tr("Question"), style="cyan"))
-
-        bindings = KeyBindings()
-        mode = {"multiline": False}
-
-        @bindings.add("c-r")
-        def _(event):
-            pass
-
-        @bindings.add("f12")
-        def _(event):
-            buf = event.app.current_buffer
-            buf.text = "Do It"
-            buf.validate_and_handle()
-
-        # Use shared CLI styles
-
-        # prompt_style contains the prompt area and input background
-        # toolbar_style contains the bottom-toolbar styling
-
-        # Use the shared chat_shell_style for input styling only
-        style = chat_shell_style
-
-        def get_toolbar():
-            f12_hint = ""
-            if mode["multiline"]:
-                return HTML(
-                    f"<b>Multiline mode (Esc+Enter to submit). Type /single to switch.</b>{f12_hint}"
-                )
-            else:
-                return HTML(
-                    f"<b>Single-line mode (Enter to submit). Type /multi for multiline.</b>{f12_hint}"
-                )
-
-        session = PromptSession(
-            multiline=False,
-            key_bindings=bindings,
-            editing_mode=EditingMode.EMACS,
-            bottom_toolbar=get_toolbar,
-            style=style,
-        )
-
-        prompt_icon = HTML("<inputline>💬 </inputline>")
-
-        while True:
-            response = session.prompt(prompt_icon)
-            if not mode["multiline"] and response.strip() == "/multi":
-                mode["multiline"] = True
-                session.multiline = True
-                continue
-            elif mode["multiline"] and response.strip() == "/single":
-                mode["multiline"] = False
-                session.multiline = False
-                continue
-            else:
-                sanitized = response.strip()
-                try:
-                    sanitized.encode("utf-8")
-                except UnicodeEncodeError:
-                    sanitized = sanitized.encode("utf-8", errors="replace").decode(
-                        "utf-8"
-                    )
-                    rich_print(
-                        "[yellow]Warning: Some characters in your input were not valid UTF-8 and have been replaced.[/yellow]"
-                    )
-                return sanitized
+from janito.tools.tool_base import ToolBase, ToolPermissions
+from janito.tools.adapters.local.adapter import register_local_tool
+
+from rich import print as rich_print
+from janito.i18n import tr
+from rich.panel import Panel
+from prompt_toolkit import PromptSession
+from prompt_toolkit.key_binding import KeyBindings
+from prompt_toolkit.enums import EditingMode
+from prompt_toolkit.formatted_text import HTML
+from janito.cli.chat_mode.prompt_style import chat_shell_style
+from prompt_toolkit.styles import Style
+
+toolbar_style = Style.from_dict({"bottom-toolbar": "fg:yellow bg:darkred"})
+
+
+@register_local_tool
+class AskUserTool(ToolBase):
+    """
+    Prompts the user for clarification or input with a question.
+
+    Args:
+        question (str): The question to ask the user. This parameter is required and should be a string containing the prompt or question to display to the user.
+    Returns:
+        str: The user's response as a string. Example:
+            - "Yes"
+            - "No"
+            - "Some detailed answer..."
+    """
+    permissions = ToolPermissions(read=True)
+    tool_name = "ask_user"
+
+    def run(self, question: str) -> str:
+
+        print()  # Print an empty line before the question panel
+        rich_print(Panel.fit(question, title=tr("Question"), style="cyan"))
+
+        bindings = KeyBindings()
+        mode = {"multiline": False}
+
+        @bindings.add("c-r")
+        def _(event):
+            pass
+
+        @bindings.add("f12")
+        def _(event):
+            buf = event.app.current_buffer
+            buf.text = "Do It"
+            buf.validate_and_handle()
+
+        # Use shared CLI styles
+
+        # prompt_style contains the prompt area and input background
+        # toolbar_style contains the bottom-toolbar styling
+
+        # Use the shared chat_shell_style for input styling only
+        style = chat_shell_style
+
+        def get_toolbar():
+            f12_hint = ""
+            if mode["multiline"]:
+                return HTML(
+                    f"<b>Multiline mode (Esc+Enter to submit). Type /single to switch.</b>{f12_hint}"
+                )
+            else:
+                return HTML(
+                    f"<b>Single-line mode (Enter to submit). Type /multi for multiline.</b>{f12_hint}"
+                )
+
+        session = PromptSession(
+            multiline=False,
+            key_bindings=bindings,
+            editing_mode=EditingMode.EMACS,
+            bottom_toolbar=get_toolbar,
+            style=style,
+        )
+
+        prompt_icon = HTML("<inputline>💬 </inputline>")
+
+        while True:
+            response = session.prompt(prompt_icon)
+            if not mode["multiline"] and response.strip() == "/multi":
+                mode["multiline"] = True
+                session.multiline = True
+                continue
+            elif mode["multiline"] and response.strip() == "/single":
+                mode["multiline"] = False
+                session.multiline = False
+                continue
+            else:
+                sanitized = response.strip()
+                try:
+                    sanitized.encode("utf-8")
+                except UnicodeEncodeError:
+                    sanitized = sanitized.encode("utf-8", errors="replace").decode(
+                        "utf-8"
+                    )
+                    rich_print(
+                        "[yellow]Warning: Some characters in your input were not valid UTF-8 and have been replaced.[/yellow]"
+                    )
+                return sanitized

janito/tools/adapters/local/copy_file.py

@@ -1,84 +1,84 @@
-import os
-import shutil
-from typing import List, Union
-from janito.tools.adapters.local.adapter import register_local_tool
-from janito.tools.tool_base import ToolBase
-from janito.tools.tool_utils import display_path
-from janito.report_events import ReportAction
-from janito.i18n import tr
-
-
-@register_local_tool
-class CopyFileTool(ToolBase):
-    """
-    Copy one or more files to a target directory, or copy a single file to a new file.
-    Args:
-        sources (str): Space-separated path(s) to the file(s) to copy.
-            For multiple sources, provide a single string with paths separated by spaces.
-        target (str): Destination path. If copying multiple sources, this must be an existing directory.
-        overwrite (bool, optional): Overwrite existing files. Default: False.
-            Recommended only after reading the file to be overwritten.
-    Returns:
-        str: Status string for each copy operation.
-    """
-
-    tool_name = "copy_file"
-
-    def run(self, sources: str, target: str, overwrite: bool = False) -> str:
-        source_list = [src for src in sources.split() if src]
-        messages = []
-        if len(source_list) > 1:
-            if not os.path.isdir(target):
-                return tr(
-                    "❗ Target must be an existing directory when copying multiple files: '{target}'",
-                    target=display_path(target),
-                )
-            for src in source_list:
-                if not os.path.isfile(src):
-                    messages.append(
-                        tr(
-                            "❗ Source file does not exist: '{src}'",
-                            src=display_path(src),
-                        )
-                    )
-                    continue
-                dst = os.path.join(target, os.path.basename(src))
-                messages.append(self._copy_one(src, dst, overwrite=overwrite))
-        else:
-            src = source_list[0]
-            if os.path.isdir(target):
-                dst = os.path.join(target, os.path.basename(src))
-            else:
-                dst = target
-            messages.append(self._copy_one(src, dst, overwrite=overwrite))
-        return "\n".join(messages)
-
-    def _copy_one(self, src, dst, overwrite=False) -> str:
-        disp_src = display_path(src)
-        disp_dst = display_path(dst)
-        if not os.path.isfile(src):
-            return tr("❗ Source file does not exist: '{src}'", src=disp_src)
-        if os.path.exists(dst) and not overwrite:
-            return tr(
-                "❗ Target already exists: '{dst}'. Set overwrite=True to replace.",
-                dst=disp_dst,
-            )
-        try:
-            os.makedirs(os.path.dirname(dst), exist_ok=True)
-            shutil.copy2(src, dst)
-            note = (
-                "\n⚠️ Overwrote existing file. (recommended only after reading the file to be overwritten)"
-                if (os.path.exists(dst) and overwrite)
-                else ""
-            )
-            self.report_success(
-                tr("✅ Copied '{src}' to '{dst}'", src=disp_src, dst=disp_dst)
-            )
-            return tr("✅ Copied '{src}' to '{dst}'", src=disp_src, dst=disp_dst) + note
-        except Exception as e:
-            return tr(
-                "❗ Copy failed from '{src}' to '{dst}': {err}",
-                src=disp_src,
-                dst=disp_dst,
-                err=str(e),
-            )
+import os
+import shutil
+from typing import List, Union
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.tools.tool_base import ToolBase, ToolPermissions
+from janito.tools.tool_utils import display_path
+from janito.report_events import ReportAction
+from janito.i18n import tr
+
+
+@register_local_tool
+class CopyFileTool(ToolBase):
+    """
+    Copy one or more files to a target directory, or copy a single file to a new file.
+    Args:
+        sources (str): Space-separated path(s) to the file(s) to copy.
+            For multiple sources, provide a single string with paths separated by spaces.
+        target (str): Destination path. If copying multiple sources, this must be an existing directory.
+        overwrite (bool, optional): Overwrite existing files. Default: False.
+            Recommended only after reading the file to be overwritten.
+    Returns:
+        str: Status string for each copy operation.
+    """
+    permissions = ToolPermissions(read=True, write=True)
+    tool_name = "copy_file"
+
+    def run(self, sources: str, target: str, overwrite: bool = False) -> str:
+        source_list = [src for src in sources.split() if src]
+        messages = []
+        if len(source_list) > 1:
+            if not os.path.isdir(target):
+                return tr(
+                    "❗ Target must be an existing directory when copying multiple files: '{target}'",
+                    target=display_path(target),
+                )
+            for src in source_list:
+                if not os.path.isfile(src):
+                    messages.append(
+                        tr(
+                            "❗ Source file does not exist: '{src}'",
+                            src=display_path(src),
+                        )
+                    )
+                    continue
+                dst = os.path.join(target, os.path.basename(src))
+                messages.append(self._copy_one(src, dst, overwrite=overwrite))
+        else:
+            src = source_list[0]
+            if os.path.isdir(target):
+                dst = os.path.join(target, os.path.basename(src))
+            else:
+                dst = target
+            messages.append(self._copy_one(src, dst, overwrite=overwrite))
+        return "\n".join(messages)
+
+    def _copy_one(self, src, dst, overwrite=False) -> str:
+        disp_src = display_path(src)
+        disp_dst = display_path(dst)
+        if not os.path.isfile(src):
+            return tr("❗ Source file does not exist: '{src}'", src=disp_src)
+        if os.path.exists(dst) and not overwrite:
+            return tr(
+                "❗ Target already exists: '{dst}'. Set overwrite=True to replace.",
+                dst=disp_dst,
+            )
+        try:
+            os.makedirs(os.path.dirname(dst), exist_ok=True)
+            shutil.copy2(src, dst)
+            note = (
+                "\n⚠️ Overwrote existing file. (recommended only after reading the file to be overwritten)"
+                if (os.path.exists(dst) and overwrite)
+                else ""
+            )
+            self.report_success(
+                tr("✅ Copied '{src}' to '{dst}'", src=disp_src, dst=disp_dst)
+            )
+            return tr("✅ Copied '{src}' to '{dst}'", src=disp_src, dst=disp_dst) + note
+        except Exception as e:
+            return tr(
+                "❗ Copy failed from '{src}' to '{dst}': {err}",
+                src=disp_src,
+                dst=disp_dst,
+                err=str(e),
+            )

janito/tools/adapters/local/create_directory.py

@@ -1,69 +1,69 @@
-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
-import os
-
-
-@register_local_tool
-class CreateDirectoryTool(ToolBase):
-    """
-    Create a new directory at the specified file_path.
-    Args:
-        file_path (str): Path for the new directory.
-    Returns:
-        str: Status message indicating the result. Example:
-            - "5c5 Successfully created the directory at ..."
-            - "5d7 Cannot create directory: ..."
-    """
-
-    tool_name = "create_directory"
-
-    def run(self, file_path: str) -> str:
-        # file_path = expand_path(file_path)
-        # Using file_path as is
-        disp_path = display_path(file_path)
-        self.report_action(
-            tr("📁 Create directory '{disp_path}' ...", disp_path=disp_path),
-            ReportAction.CREATE,
-        )
-        try:
-            if os.path.exists(file_path):
-                if not os.path.isdir(file_path):
-                    self.report_error(
-                        tr(
-                            "❌ Path '{disp_path}' exists and is not a directory.",
-                            disp_path=disp_path,
-                        )
-                    )
-                    return tr(
-                        "❌ Path '{disp_path}' exists and is not a directory.",
-                        disp_path=disp_path,
-                    )
-                self.report_error(
-                    tr(
-                        "❗ Directory '{disp_path}' already exists.",
-                        disp_path=disp_path,
-                    )
-                )
-                return tr(
-                    "❗ Cannot create directory: '{disp_path}' already exists.",
-                    disp_path=disp_path,
-                )
-            os.makedirs(file_path, exist_ok=True)
-            self.report_success(tr("✅ Directory created"))
-            return tr(
-                "✅ Successfully created the directory at '{disp_path}'.",
-                disp_path=disp_path,
-            )
-        except Exception as e:
-            self.report_error(
-                tr(
-                    "❌ Error creating directory '{disp_path}': {error}",
-                    disp_path=disp_path,
-                    error=e,
-                )
-            )
-            return tr("❌ Cannot create directory: {error}", error=e)
+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, ToolPermissions
+from janito.report_events import ReportAction
+from janito.i18n import tr
+import os
+
+
+@register_local_tool
+class CreateDirectoryTool(ToolBase):
+    """
+    Create a new directory at the specified file_path.
+    Args:
+        file_path (str): Path for the new directory.
+    Returns:
+        str: Status message indicating the result. Example:
+            - "5c5 Successfully created the directory at ..."
+            - "5d7 Cannot create directory: ..."
+    """
+    permissions = ToolPermissions(write=True)
+    tool_name = "create_directory"
+
+    def run(self, file_path: str) -> str:
+        # file_path = expand_path(file_path)
+        # Using file_path as is
+        disp_path = display_path(file_path)
+        self.report_action(
+            tr("📁 Create directory '{disp_path}' ...", disp_path=disp_path),
+            ReportAction.CREATE,
+        )
+        try:
+            if os.path.exists(file_path):
+                if not os.path.isdir(file_path):
+                    self.report_error(
+                        tr(
+                            "❌ Path '{disp_path}' exists and is not a directory.",
+                            disp_path=disp_path,
+                        )
+                    )
+                    return tr(
+                        "❌ Path '{disp_path}' exists and is not a directory.",
+                        disp_path=disp_path,
+                    )
+                self.report_error(
+                    tr(
+                        "❗ Directory '{disp_path}' already exists.",
+                        disp_path=disp_path,
+                    )
+                )
+                return tr(
+                    "❗ Cannot create directory: '{disp_path}' already exists.",
+                    disp_path=disp_path,
+                )
+            os.makedirs(file_path, exist_ok=True)
+            self.report_success(tr("✅ Directory created"))
+            return tr(
+                "✅ Successfully created the directory at '{disp_path}'.",
+                disp_path=disp_path,
+            )
+        except Exception as e:
+            self.report_error(
+                tr(
+                    "❌ Error creating directory '{disp_path}': {error}",
+                    disp_path=disp_path,
+                    error=e,
+                )
+            )
+            return tr("❌ Cannot create directory: {error}", error=e)