janito 3.1.0__py3-none-any.whl → 3.3.0__py3-none-any.whl

janito/plugins_backup_20250825_070018/core/filemanager/tools/replace_text_in_file.py

@@ -0,0 +1,270 @@
+from janito.tools.tool_base import ToolBase, ToolPermissions
+from janito.report_events import ReportAction
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.i18n import tr
+import shutil
+import re
+from janito.tools.adapters.local.validate_file_syntax.core import validate_file_syntax
+
+
+@register_local_tool
+class ReplaceTextInFileTool(ToolBase):
+    """
+    Replace exact occurrences of a given text in a file.
+
+    Note:
+        To avoid syntax errors, ensure your replacement text is pre-indented as needed, matching the indentation of the
+        search text in its original location.
+
+    Args:
+        path (str): Path to the file to modify.
+        search_text (str): The exact text to search for (including indentation).
+        replacement_text (str): The text to replace with (including indentation).
+        replace_all (bool): If True, replace all occurrences; otherwise, only the first occurrence.
+        backup (bool, optional): Deprecated. No backups are created anymore and this flag is ignored. Defaults to False.
+    Returns:
+        str: Status message. Example:
+            - "Text replaced in /path/to/file"
+            - "No changes made. [Warning: Search text not found in file] Please review the original file."
+            - "Error replacing text: <error message>"
+    """
+
+    permissions = ToolPermissions(read=True, write=True)
+    tool_name = "replace_text_in_file"
+
+    def run(
+        self,
+        path: str,
+        search_text: str,
+        replacement_text: str,
+        replace_all: bool = False,
+        backup: bool = False,
+    ) -> str:
+        from janito.tools.tool_utils import display_path
+
+        disp_path = display_path(path)
+        action = "(all)" if replace_all else ""
+        search_lines = len(search_text.splitlines())
+        replace_lines = len(replacement_text.splitlines())
+        info_msg = self._format_info_msg(
+            disp_path,
+            search_lines,
+            replace_lines,
+            action,
+            search_text,
+            replacement_text,
+            path,
+        )
+        self.report_action(info_msg, ReportAction.CREATE)
+        try:
+            content = self._read_file_content(path)
+            match_lines = self._find_match_lines(content, search_text)
+            occurrences = content.count(search_text)
+            replaced_count, new_content = self._replace_content(
+                content, search_text, replacement_text, replace_all, occurrences
+            )
+            file_changed = new_content != content
+            backup_path = None
+            validation_result = ""
+            if file_changed:
+                self._write_file_content(path, new_content)
+                # Perform syntax validation and append result
+                validation_result = validate_file_syntax(path)
+            warning, concise_warning = self._handle_warnings(
+                replaced_count, file_changed, occurrences
+            )
+
+            if concise_warning:
+                return concise_warning
+            self._report_success(match_lines)
+            line_delta_str = self._get_line_delta_str(content, new_content)
+            match_info, details = self._format_match_details(
+                replaced_count,
+                match_lines,
+                search_lines,
+                replace_lines,
+                line_delta_str,
+                replace_all,
+            )
+            return self._format_final_msg(path, warning, match_info, details) + (
+                f"\n{validation_result}" if validation_result else ""
+            )
+        except Exception as e:
+            self.report_error(tr(" ❌ Error"), ReportAction.UPDATE)
+            return tr("Error replacing text: {error}", error=e)
+
+    def _read_file_content(self, path):
+        """Read the entire content of the file."""
+        with open(path, "r", encoding="utf-8", errors="replace") as f:
+            return f.read()
+
+    def _find_match_lines(self, content, search_text):
+        """Find all line numbers where search_text occurs in content."""
+        lines = content.splitlines(keepends=True)
+        joined = "".join(lines)
+        match_lines = []
+        idx = 0
+        while True:
+            idx = joined.find(search_text, idx)
+            if idx == -1:
+                break
+            upto = joined[:idx]
+            line_no = upto.count("\n") + 1
+            match_lines.append(line_no)
+            idx += 1 if not search_text else len(search_text)
+        return match_lines
+
+    def _replace_content(
+        self, content, search_text, replacement_text, replace_all, occurrences
+    ):
+        """Replace occurrences of search_text with replacement_text in content."""
+        if replace_all:
+            replaced_count = content.count(search_text)
+            new_content = content.replace(search_text, replacement_text)
+        else:
+            if occurrences > 1:
+                return 0, content  # No changes made, not unique
+            replaced_count = 1 if occurrences == 1 else 0
+            new_content = content.replace(search_text, replacement_text, 1)
+        return replaced_count, new_content
+
+    def _backup_file(self, path, backup_path):
+        """Create a backup of the file."""
+        shutil.copy2(path, backup_path)
+
+    def _write_file_content(self, path, content):
+        """Write content to the file."""
+        with open(path, "w", encoding="utf-8", errors="replace") as f:
+            f.write(content)
+
+    def _handle_warnings(self, replaced_count, file_changed, occurrences):
+        """Handle and return warnings and concise warnings if needed."""
+        warning = ""
+        concise_warning = None
+        if replaced_count == 0:
+            warning = tr(" [Warning: Search text not found in file]")
+        if not file_changed:
+            self.report_warning(
+                tr(" ℹ️  No changes made. (not found)"), ReportAction.CREATE
+            )
+            concise_warning = tr(
+                "No changes made. The search text was not found. Expand your search context with surrounding lines if needed."
+            )
+        if occurrences > 1 and replaced_count == 0:
+            self.report_warning(
+                tr(" ℹ️  No changes made. (not unique)"), ReportAction.CREATE
+            )
+            concise_warning = tr(
+                "No changes made. The search text is not unique. Expand your search context with surrounding lines to ensure uniqueness."
+            )
+        return warning, concise_warning
+
+    def _report_success(self, match_lines):
+        """Report success with line numbers where replacements occurred."""
+        if match_lines:
+            lines_str = ", ".join(str(line_no) for line_no in match_lines)
+            self.report_success(
+                tr(" ✅ replaced at {lines_str}", lines_str=lines_str),
+                ReportAction.CREATE,
+            )
+        else:
+            self.report_success(tr(" ✅ replaced (lines unknown)"), ReportAction.CREATE)
+
+    def _get_line_delta_str(self, content, new_content):
+        """Return a string describing the net line change after replacement."""
+        total_lines_before = content.count("\n") + 1
+        total_lines_after = new_content.count("\n") + 1
+        line_delta = total_lines_after - total_lines_before
+        if line_delta > 0:
+            return f" (+{line_delta} lines)"
+        elif line_delta < 0:
+            return f" ({line_delta} lines)"
+        else:
+            return " (no net line change)"
+
+    def _format_info_msg(
+        self,
+        disp_path,
+        search_lines,
+        replace_lines,
+        action,
+        search_text,
+        replacement_text,
+        path,
+    ):
+        """Format the info message for the operation."""
+        if replace_lines == 0:
+            return tr(
+                "📝 Replace in {disp_path} del {search_lines} lines {action}",
+                disp_path=disp_path,
+                search_lines=search_lines,
+                action=action,
+            )
+        else:
+            try:
+                with open(path, "r", encoding="utf-8", errors="replace") as f:
+                    _content = f.read()
+                _new_content = _content.replace(
+                    search_text, replacement_text, -1 if action else 1
+                )
+                _total_lines_before = _content.count("\n") + 1
+                _total_lines_after = _new_content.count("\n") + 1
+                _line_delta = _total_lines_after - _total_lines_before
+            except Exception:
+                _line_delta = replace_lines - search_lines
+            if _line_delta > 0:
+                delta_str = f"+{_line_delta} lines"
+            elif _line_delta < 0:
+                delta_str = f"{_line_delta} lines"
+            else:
+                delta_str = "+0"
+            return tr(
+                "📝 Replace in {disp_path} {delta_str} {action}",
+                disp_path=disp_path,
+                delta_str=delta_str,
+                action=action,
+            )
+
+    def _format_match_details(
+        self,
+        replaced_count,
+        match_lines,
+        search_lines,
+        replace_lines,
+        line_delta_str,
+        replace_all,
+    ):
+        """Format match info and details for the final message."""
+        if replaced_count > 0:
+            if replace_all:
+                match_info = tr(
+                    "Matches found at lines: {lines}. ",
+                    lines=", ".join(str(line) for line in match_lines),
+                )
+            else:
+                match_info = (
+                    tr("Match found at line {line}. ", line=match_lines[0])
+                    if match_lines
+                    else ""
+                )
+            details = tr(
+                "Replaced {replaced_count} occurrence(s) at above line(s): {search_lines} lines replaced with {replace_lines} lines each.{line_delta_str}",
+                replaced_count=replaced_count,
+                search_lines=search_lines,
+                replace_lines=replace_lines,
+                line_delta_str=line_delta_str,
+            )
+        else:
+            match_info = ""
+            details = ""
+        return match_info, details
+
+    def _format_final_msg(self, path, warning, match_info, details):
+        """Format the final status message."""
+        return tr(
+            "Text replaced in {path}{warning}. {match_info}{details}",
+            path=path,
+            warning=warning,
+            match_info=match_info,
+            details=details,
+        )

janito/plugins_backup_20250825_070018/core/filemanager/tools/validate_file_syntax/__init__.py

@@ -0,0 +1 @@
+# Validation syntax package

janito/plugins_backup_20250825_070018/core/filemanager/tools/validate_file_syntax/core.py

@@ -0,0 +1,114 @@
+import os
+from janito.tools.path_utils import expand_path
+from janito.i18n import tr
+from janito.tools.tool_base import ToolBase, ToolPermissions
+from janito.report_events import ReportAction
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.tools.tool_utils import display_path
+from janito.tools.adapters.local.adapter import register_local_tool as register_tool
+
+from .python_validator import validate_python
+from .json_validator import validate_json
+from .yaml_validator import validate_yaml
+from .ps1_validator import validate_ps1
+from .xml_validator import validate_xml
+from .html_validator import validate_html
+from .markdown_validator import validate_markdown
+from .js_validator import validate_js
+from .css_validator import validate_css
+from .jinja2_validator import validate_jinja2
+from janito.tools.loop_protection_decorator import protect_against_loops
+
+
+def _get_validator(ext):
+    """Return the appropriate validator function for the file extension."""
+    mapping = {
+        ".py": validate_python,
+        ".pyw": validate_python,
+        ".json": validate_json,
+        ".yml": validate_yaml,
+        ".yaml": validate_yaml,
+        ".ps1": validate_ps1,
+        ".xml": validate_xml,
+        ".html": validate_html,
+        ".htm": validate_html,
+        ".md": validate_markdown,
+        ".js": validate_js,
+        ".css": validate_css,
+        ".j2": validate_jinja2,
+        ".jinja2": validate_jinja2,
+    }
+    return mapping.get(ext)
+
+
+def _handle_validation_error(e, report_warning):
+    msg = tr("⚠️ Warning: Syntax error: {error}", error=e)
+    if report_warning:
+        report_warning(msg)
+    return msg
+
+
+def validate_file_syntax(
+    path: str, report_info=None, report_warning=None, report_success=None
+) -> str:
+    ext = os.path.splitext(path)[1].lower()
+    validator = _get_validator(ext)
+    try:
+        if validator:
+            return validator(path)
+        else:
+            msg = tr("⚠️ Warning: Unsupported file extension: {ext}", ext=ext)
+            if report_warning:
+                report_warning(msg)
+            return msg
+    except Exception as e:
+        return _handle_validation_error(e, report_warning)
+
+
+class ValidateFileSyntaxTool(ToolBase):
+    """
+    Validate a file for syntax issues.
+
+    Supported types:
+      - Python (.py, .pyw)
+      - JSON (.json)
+      - YAML (.yml, .yaml)
+      - PowerShell (.ps1)
+      - XML (.xml)
+      - HTML (.html, .htm) [lxml]
+      - Markdown (.md)
+      - JavaScript (.js)
+      - Jinja2 templates (.j2, .jinja2)
+
+    Args:
+        path (str): Path to the file to validate.
+    Returns:
+        str: Validation status message. Example:
+            - "✅ Syntax OK"
+            - "⚠️ Warning: Syntax error: <error message>"
+            - "⚠️ Warning: Unsupported file extension: <ext>"
+    """
+
+    permissions = ToolPermissions(read=True)
+    tool_name = "validate_file_syntax"
+
+    @protect_against_loops(max_calls=5, time_window=10.0, key_field="path")
+    def run(self, path: str) -> str:
+        path = expand_path(path)
+        disp_path = display_path(path)
+        self.report_action(
+            tr(
+                "🔎 Validate syntax for file '{disp_path}' ...",
+                disp_path=disp_path,
+            ),
+            ReportAction.READ,
+        )
+        result = validate_file_syntax(
+            path,
+            report_warning=self.report_warning,
+            report_success=self.report_success,
+        )
+        if result.startswith("✅"):
+            self.report_success(result, ReportAction.READ)
+
+        return result

janito/plugins_backup_20250825_070018/core/filemanager/tools/view_file.py

@@ -0,0 +1,172 @@
+from janito.tools.tool_base import ToolBase, ToolPermissions
+from janito.report_events import ReportAction
+from janito.tools.adapters.local.adapter import register_local_tool
+from janito.tools.tool_utils import pluralize
+from janito.i18n import tr
+from janito.tools.loop_protection_decorator import protect_against_loops
+
+
+@register_local_tool
+class ViewFileTool(ToolBase):
+    """
+    Read lines from a file. You can specify a line range, or read the entire file by simply omitting the from_line and to_line parameters.
+
+    Args:
+        path (str): Path to the file to read lines from.
+        from_line (int, optional): Starting line number (1-based). Omit to start from the first line.
+        to_line (int, optional): Ending line number (1-based). Omit to read to the end of the file.
+
+    To read the full file, just provide path and leave from_line and to_line unset.
+
+    Returns:
+        str: File content with a header indicating the file name and line range. Example:
+            - "---\nFile: /path/to/file.py | Lines: 1-10 (of 100)\n---\n<lines...>"
+            - "---\nFile: /path/to/file.py | All lines (total: 100 (all))\n---\n<all lines...>"
+            - "Error reading file: <error message>"
+            - "❗ not found"
+    """
+
+    permissions = ToolPermissions(read=True)
+    tool_name = "view_file"
+
+    @protect_against_loops(max_calls=5, time_window=10.0, key_field="path")
+    def run(self, path: str, from_line: int = None, to_line: int = None) -> str:
+        import os
+        from janito.tools.tool_utils import display_path
+        from janito.tools.path_utils import expand_path
+
+        path = expand_path(path)
+        disp_path = display_path(path)
+        self.report_action(
+            tr("📖 View '{disp_path}'", disp_path=disp_path),
+            ReportAction.READ,
+        )
+        try:
+            if os.path.isdir(path):
+                return self._list_directory(path, disp_path)
+            lines = self._read_file_lines(path)
+            selected, selected_len, total_lines = self._select_lines(
+                lines, from_line, to_line
+            )
+            self._report_success(selected_len, from_line, to_line, total_lines)
+            header = self._format_header(
+                disp_path, from_line, to_line, selected_len, total_lines
+            )
+            return header + "".join(selected)
+        except FileNotFoundError as e:
+            self.report_warning(tr("❗ not found"))
+            return f"Error reading file: {e}"
+        except Exception as e:
+            self.report_error(tr(" ❌ Error: {error}", error=e))
+            return tr("Error reading file: {error}", error=e)
+
+    def _list_directory(self, path, disp_path):
+        import os
+
+        try:
+            entries = os.listdir(path)
+            entries.sort()
+            # Suffix subdirectories with '/'
+            formatted_entries = []
+            for entry in entries:
+                full_path = os.path.join(path, entry)
+                if os.path.isdir(full_path):
+                    formatted_entries.append(entry + "/")
+                else:
+                    formatted_entries.append(entry)
+            header = (
+                f"--- view_file: {disp_path} [directory, {len(entries)} entries] ---\n"
+            )
+            listing = "\n".join(formatted_entries)
+            self.report_success(tr("📁 Directory ({count} items)", count=len(entries)))
+            return header + listing + "\n"
+        except Exception as e:
+            self.report_error(tr(" ❌ Error listing directory: {error}", error=e))
+            return tr("Error listing directory: {error}", error=e)
+
+    def _read_file_lines(self, path):
+        """Read all lines from the file."""
+        with open(path, "r", encoding="utf-8", errors="replace") as f:
+            return f.readlines()
+
+    def _select_lines(self, lines, from_line, to_line):
+        """Select the requested lines and return them with their count and total lines."""
+        selected = lines[
+            (from_line - 1 if from_line else 0) : (to_line if to_line else None)
+        ]
+        selected_len = len(selected)
+        total_lines = len(lines)
+        return selected, selected_len, total_lines
+
+    def _report_success(self, selected_len, from_line, to_line, total_lines):
+        """Report the success message after reading lines."""
+        if from_line and to_line:
+            requested = to_line - from_line + 1
+            at_end = to_line >= total_lines or selected_len < requested
+            if at_end:
+                self.report_success(
+                    tr(
+                        " ✅ {selected_len} {line_word} (end)",
+                        selected_len=selected_len,
+                        line_word=pluralize("line", selected_len),
+                    )
+                )
+            elif to_line < total_lines:
+                self.report_success(
+                    tr(
+                        " ✅ {selected_len} {line_word} ({remaining} to end)",
+                        selected_len=selected_len,
+                        line_word=pluralize("line", selected_len),
+                        remaining=total_lines - to_line,
+                    )
+                )
+        else:
+            self.report_success(
+                tr(
+                    " ✅ {selected_len} {line_word} (all)",
+                    selected_len=selected_len,
+                    line_word=pluralize("line", selected_len),
+                )
+            )
+
+    def _format_header(self, disp_path, from_line, to_line, selected_len, total_lines):
+        """Format the header for the output."""
+        if from_line and to_line:
+            requested = to_line - from_line + 1
+            at_end = selected_len < requested or to_line >= total_lines
+            if at_end:
+                return tr(
+                    "---\n{disp_path} {from_line}-{to_line} (end)\n---\n",
+                    disp_path=disp_path,
+                    from_line=from_line,
+                    to_line=to_line,
+                )
+            else:
+                return tr(
+                    "---\n{disp_path} {from_line}-{to_line} (of {total_lines})\n---\n",
+                    disp_path=disp_path,
+                    from_line=from_line,
+                    to_line=to_line,
+                    total_lines=total_lines,
+                )
+        elif from_line:
+            return tr(
+                "---\n{disp_path} {from_line}-END (of {total_lines})\n---\n",
+                disp_path=disp_path,
+                from_line=from_line,
+                total_lines=total_lines,
+            )
+        else:
+            return tr(
+                "---\n{disp_path} All lines (total: {total_lines} (all))\n---\n",
+                disp_path=disp_path,
+                total_lines=total_lines,
+            )
+
+    def _handle_read_error(self, e):
+        """Handle file read errors and report appropriately."""
+        if isinstance(e, FileNotFoundError):
+            self.report_error(tr("❗ not found"), ReportAction.READ)
+            return tr("❗ not found")
+        self.report_error(tr(" ❌ Error: {error}", error=e), ReportAction.READ)
+        return tr("Error reading file: {error}", error=e)

janito/plugins_backup_20250825_070018/core/imagedisplay/__init__.py

@@ -0,0 +1,14 @@
+"""
+Image Display Plugin - Core plugin for displaying images inline in the terminal.
+
+This plugin provides tools for displaying images directly in the terminal using
+rich library's image rendering capabilities.
+"""
+
+from .plugin import ImageDisplayPlugin
+
+# Plugin metadata for discovery/listing
+__plugin_name__ = "core.imagedisplay"
+__plugin_description__ = "Display images inline in the terminal using rich"
+
+__all__ = ["ImageDisplayPlugin"]

janito/plugins_backup_20250825_070018/core/imagedisplay/plugin.py

@@ -0,0 +1,51 @@
+"""
+Image Display Plugin implementation.
+"""
+
+from typing import Dict, Any, List, Type
+
+from janito.plugin_system.base import Plugin, PluginMetadata
+from janito.tools.tool_base import ToolBase
+from .tools.show_image import ShowImageTool
+from .tools.show_image_grid import ShowImageGridTool
+
+
+class ImageDisplayPlugin(Plugin):
+    """Plugin for displaying images inline in the terminal using rich."""
+
+    def get_metadata(self) -> PluginMetadata:
+        return PluginMetadata(
+            name="core.imagedisplay",
+            version="1.0.0",
+            description="Display images inline in the terminal using rich",
+            author="Janito",
+            dependencies=["rich", "pillow"],
+        )
+
+    def get_tools(self) -> List[Type[ToolBase]]:
+        # Return tool classes so the PluginManager can register them
+        return [ShowImageTool, ShowImageGridTool]
+
+    def get_config_schema(self) -> Dict[str, Any]:
+        return {
+            "type": "object",
+            "properties": {
+                "default_width": {
+                    "type": "integer",
+                    "description": "Default width for image display",
+                    "minimum": 1,
+                    "maximum": 200,
+                },
+                "default_height": {
+                    "type": "integer",
+                    "description": "Default height for image display",
+                    "minimum": 1,
+                    "maximum": 100,
+                },
+                "preserve_aspect": {
+                    "type": "boolean",
+                    "description": "Preserve aspect ratio by default",
+                    "default": True,
+                },
+            },
+        }

janito/plugins_backup_20250825_070018/core/imagedisplay/tools/__init__.py

@@ -0,0 +1 @@
+"""Tools for image display plugin."""