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

janito/tools/adapters/local/get_file_outline/python_outline_v2.py

@@ -1,156 +1,156 @@
-import re
-from typing import List
-
-
-def extract_signature_and_decorators(lines, start_idx):
-    """
-    Extracts the signature line and leading decorators for a given function/class/method.
-    Returns (signature:str, decorators:List[str], signature_lineno:int)
-    """
-    decorators = []
-    sig_line = None
-    sig_lineno = start_idx
-    for i in range(start_idx - 1, -1, -1):
-        striped = lines[i].strip()
-        if striped.startswith("@"):
-            decorators.insert(0, striped)
-            sig_lineno = i
-        elif not striped:
-            continue
-        else:
-            break
-    # Find the signature line itself
-    for k in range(start_idx, len(lines)):
-        striped = lines[k].strip()
-        if striped.startswith("def ") or striped.startswith("class "):
-            sig_line = striped
-            sig_lineno = k
-            break
-    return sig_line, decorators, sig_lineno
-
-
-def extract_docstring(lines, start_idx, end_idx):
-    """Extracts a docstring from lines[start_idx:end_idx] if present."""
-    for i in range(start_idx, min(end_idx, len(lines))):
-        line = lines[i].lstrip()
-        if not line:
-            continue
-        if line.startswith('"""') or line.startswith("'''"):
-            quote = line[:3]
-            doc = line[3:]
-            if doc.strip().endswith(quote):
-                return doc.strip()[:-3].strip()
-            docstring_lines = [doc]
-            for j in range(i + 1, min(end_idx, len(lines))):
-                line = lines[j]
-                if line.strip().endswith(quote):
-                    docstring_lines.append(line.strip()[:-3])
-                    return "\n".join([d.strip() for d in docstring_lines]).strip()
-                docstring_lines.append(line)
-            break
-        else:
-            break
-    return ""
-
-
-def build_outline_entry(obj, lines, outline):
-    obj_type, name, start, end, parent, indent = obj
-    # Determine if this is a method
-    if obj_type == "function" and parent:
-        outline_type = "method"
-    elif obj_type == "function":
-        outline_type = "function"
-    else:
-        outline_type = obj_type
-    docstring = extract_docstring(lines, start, end)
-    signature, decorators, signature_lineno = extract_signature_and_decorators(
-        lines, start - 1
-    )
-    outline.append(
-        {
-            "type": outline_type,
-            "name": name,
-            "start": start,
-            "end": end,
-            "parent": parent,
-            "signature": signature,
-            "decorators": decorators,
-            "docstring": docstring,
-        }
-    )
-
-
-def parse_python_outline_v2(lines: List[str]):
-    class_pat = re.compile(r"^(\s*)class\s+(\w+)")
-    func_pat = re.compile(r"^(\s*)def\s+(\w+)")
-    assign_pat = re.compile(r"^(\s*)([A-Za-z_][A-Za-z0-9_]*)\s*=.*")
-    main_pat = re.compile(r"^\s*if\s+__name__\s*==\s*[\'\"]__main__[\'\"]\s*:")
-    outline = []
-    stack = []
-    obj_ranges = []
-    last_top_obj = None
-    for idx, line in enumerate(lines):
-        class_match = class_pat.match(line)
-        func_match = func_pat.match(line)
-        assign_match = assign_pat.match(line)
-        indent = len(line) - len(line.lstrip())
-        parent = ""
-        for s in reversed(stack):
-            if s[0] == "class" and indent > s[2]:
-                parent = s[1]
-                break
-        if class_match:
-            obj = ("class", class_match.group(2), idx + 1, None, parent, indent)
-            stack.append(obj)
-            last_top_obj = obj
-        elif func_match:
-            obj = ("function", func_match.group(2), idx + 1, None, parent, indent)
-            stack.append(obj)
-            last_top_obj = obj
-        elif assign_match and indent == 0:
-            outline.append(
-                {
-                    "type": "const" if assign_match.group(2).isupper() else "var",
-                    "name": assign_match.group(2),
-                    "start": idx + 1,
-                    "end": idx + 1,
-                    "parent": "",
-                    "signature": line.strip(),
-                    "decorators": [],
-                    "docstring": "",
-                }
-            )
-        if line.strip().startswith("if __name__ == "):
-            outline.append(
-                {
-                    "type": "main",
-                    "name": "__main__",
-                    "start": idx + 1,
-                    "end": idx + 1,
-                    "parent": "",
-                    "signature": line.strip(),
-                    "decorators": [],
-                    "docstring": "",
-                }
-            )
-        # Close stack objects if indent falls back
-        while stack and indent <= stack[-1][5] and idx + 1 > stack[-1][2]:
-            finished = stack.pop()
-            outline_entry = finished[:2] + (
-                finished[2],
-                idx + 1,
-                finished[4],
-                finished[5],
-            )
-            build_outline_entry(outline_entry, lines, outline)
-    # Close any remaining objects
-    while stack:
-        finished = stack.pop()
-        outline_entry = finished[:2] + (
-            finished[2],
-            len(lines),
-            finished[4],
-            finished[5],
-        )
-        build_outline_entry(outline_entry, lines, outline)
-    return outline
+import re
+from typing import List
+
+
+def extract_signature_and_decorators(lines, start_idx):
+    """
+    Extracts the signature line and leading decorators for a given function/class/method.
+    Returns (signature:str, decorators:List[str], signature_lineno:int)
+    """
+    decorators = []
+    sig_line = None
+    sig_lineno = start_idx
+    for i in range(start_idx - 1, -1, -1):
+        striped = lines[i].strip()
+        if striped.startswith("@"):
+            decorators.insert(0, striped)
+            sig_lineno = i
+        elif not striped:
+            continue
+        else:
+            break
+    # Find the signature line itself
+    for k in range(start_idx, len(lines)):
+        striped = lines[k].strip()
+        if striped.startswith("def ") or striped.startswith("class "):
+            sig_line = striped
+            sig_lineno = k
+            break
+    return sig_line, decorators, sig_lineno
+
+
+def extract_docstring(lines, start_idx, end_idx):
+    """Extracts a docstring from lines[start_idx:end_idx] if present."""
+    for i in range(start_idx, min(end_idx, len(lines))):
+        line = lines[i].lstrip()
+        if not line:
+            continue
+        if line.startswith('"""') or line.startswith("'''"):
+            quote = line[:3]
+            doc = line[3:]
+            if doc.strip().endswith(quote):
+                return doc.strip()[:-3].strip()
+            docstring_lines = [doc]
+            for j in range(i + 1, min(end_idx, len(lines))):
+                line = lines[j]
+                if line.strip().endswith(quote):
+                    docstring_lines.append(line.strip()[:-3])
+                    return "\n".join([d.strip() for d in docstring_lines]).strip()
+                docstring_lines.append(line)
+            break
+        else:
+            break
+    return ""
+
+
+def build_outline_entry(obj, lines, outline):
+    obj_type, name, start, end, parent, indent = obj
+    # Determine if this is a method
+    if obj_type == "function" and parent:
+        outline_type = "method"
+    elif obj_type == "function":
+        outline_type = "function"
+    else:
+        outline_type = obj_type
+    docstring = extract_docstring(lines, start, end)
+    signature, decorators, signature_lineno = extract_signature_and_decorators(
+        lines, start - 1
+    )
+    outline.append(
+        {
+            "type": outline_type,
+            "name": name,
+            "start": start,
+            "end": end,
+            "parent": parent,
+            "signature": signature,
+            "decorators": decorators,
+            "docstring": docstring,
+        }
+    )
+
+
+def parse_python_outline_v2(lines: List[str]):
+    class_pat = re.compile(r"^(\s*)class\s+(\w+)")
+    func_pat = re.compile(r"^(\s*)def\s+(\w+)")
+    assign_pat = re.compile(r"^(\s*)([A-Za-z_][A-Za-z0-9_]*)\s*=.*")
+    main_pat = re.compile(r"^\s*if\s+__name__\s*==\s*[\'\"]__main__[\'\"]\s*:")
+    outline = []
+    stack = []
+    obj_ranges = []
+    last_top_obj = None
+    for idx, line in enumerate(lines):
+        class_match = class_pat.match(line)
+        func_match = func_pat.match(line)
+        assign_match = assign_pat.match(line)
+        indent = len(line) - len(line.lstrip())
+        parent = ""
+        for s in reversed(stack):
+            if s[0] == "class" and indent > s[2]:
+                parent = s[1]
+                break
+        if class_match:
+            obj = ("class", class_match.group(2), idx + 1, None, parent, indent)
+            stack.append(obj)
+            last_top_obj = obj
+        elif func_match:
+            obj = ("function", func_match.group(2), idx + 1, None, parent, indent)
+            stack.append(obj)
+            last_top_obj = obj
+        elif assign_match and indent == 0:
+            outline.append(
+                {
+                    "type": "const" if assign_match.group(2).isupper() else "var",
+                    "name": assign_match.group(2),
+                    "start": idx + 1,
+                    "end": idx + 1,
+                    "parent": "",
+                    "signature": line.strip(),
+                    "decorators": [],
+                    "docstring": "",
+                }
+            )
+        if line.strip().startswith("if __name__ == "):
+            outline.append(
+                {
+                    "type": "main",
+                    "name": "__main__",
+                    "start": idx + 1,
+                    "end": idx + 1,
+                    "parent": "",
+                    "signature": line.strip(),
+                    "decorators": [],
+                    "docstring": "",
+                }
+            )
+        # Close stack objects if indent falls back
+        while stack and indent <= stack[-1][5] and idx + 1 > stack[-1][2]:
+            finished = stack.pop()
+            outline_entry = finished[:2] + (
+                finished[2],
+                idx + 1,
+                finished[4],
+                finished[5],
+            )
+            build_outline_entry(outline_entry, lines, outline)
+    # Close any remaining objects
+    while stack:
+        finished = stack.pop()
+        outline_entry = finished[:2] + (
+            finished[2],
+            len(lines),
+            finished[4],
+            finished[5],
+        )
+        build_outline_entry(outline_entry, lines, outline)
+    return outline

janito/tools/adapters/local/get_file_outline/search_outline.py

@@ -1,33 +1,33 @@
-from janito.tools.tool_base import ToolBase
-from janito.report_events import ReportAction
-
-
-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.tools.tool_utils import display_path
-        from janito.i18n import tr
-
-        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:
-        # self.report_warning(tr("No files found with supported extensions."))
-        # self.report_warning(tr("Error reading {file_path}: {error}", file_path=file_path, error=e))
-        # self.report_success(tr("✅ {count} {match_word} found", count=len(output), match_word=pluralize('match', len(output))))
-        pass
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
+
+
+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.tools.tool_utils import display_path
+        from janito.i18n import tr
+
+        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:
+        # self.report_warning(tr("No files found with supported extensions."))
+        # self.report_warning(tr("Error reading {file_path}: {error}", file_path=file_path, error=e))
+        # self.report_success(tr("✅ {count} {match_word} found", count=len(output), match_word=pluralize('match', len(output))))
+        pass

janito/tools/adapters/local/move_file.py

@@ -16,7 +16,7 @@ class MoveFileTool(ToolBase):
         src_path (str): Source file or directory path.
         dest_path (str): Destination file or directory path.
         overwrite (bool, optional): Whether to overwrite if the destination exists. Defaults to False.
-        backup (bool, optional): If True, create a backup (.bak for files, .bak.zip for directories) of the destination before moving if it exists. Recommend using backup=True only in the first call to avoid redundant backups. Defaults to False.
+        backup (bool, optional): Deprecated. No backups are created anymore. This flag is ignored. Defaults to False.
     Returns:
         str: Status message indicating the result.
     """
@@ -60,11 +60,7 @@ class MoveFileTool(ToolBase):
             shutil.move(src, dest)
             self.report_success(tr("✅ Move complete."))
             msg = tr("✅ Move complete.")
-            if backup_path:
-                msg += tr(
-                    " (backup at {backup_disp})",
-                    backup_disp=display_path(backup_path),
-                )
+
             return msg
         except Exception as e:
             self.report_error(tr("❌ Error moving: {error}", error=e))
@@ -116,13 +112,7 @@ class MoveFileTool(ToolBase):
                     "❗ Destination '{disp_dest}' already exists and overwrite is False.",
                     disp_dest=disp_dest,
                 )
-            if backup:
-                if os.path.isfile(dest):
-                    backup_path = dest + ".bak"
-                    shutil.copy2(dest, backup_path)
-                elif os.path.isdir(dest):
-                    backup_path = dest.rstrip("/\\") + ".bak.zip"
-                    shutil.make_archive(dest.rstrip("/\\") + ".bak", "zip", dest)
+
             try:
                 if os.path.isfile(dest):
                     os.remove(dest)

janito/tools/adapters/local/open_html_in_browser.py

@@ -1,43 +1,38 @@
-from janito.tools.tool_base import ToolBase
+import os
+import webbrowser
 from janito.tools.adapters.local.adapter import register_local_tool
+from janito.tools.tool_base import ToolBase
 from janito.report_events import ReportAction
-import webbrowser
-import os
+from janito.i18n import tr
 
 @register_local_tool
 class OpenHtmlInBrowserTool(ToolBase):
     """
-    Opens an HTML file in the default web browser.
+    Open the supplied HTML file in the default web browser.
 
     Args:
-        file_path (str): The path to the HTML file to open.
-
+        file_path (str): 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."
+        str: Status message indicating the result.
     """
-
     tool_name = "open_html_in_browser"
 
     def run(self, file_path: str) -> str:
-        from janito.i18n import tr
-        disp_path = file_path
-        self.report_action(tr("📖 Opening HTML file: '{disp_path}'", disp_path=disp_path), ReportAction.EXECUTE)
-
-        if not os.path.exists(file_path):
-            self.report_error(tr("⚠️ The specified file does not exist: '{disp_path}'", disp_path=disp_path))
-            return "⚠️ The specified file does not exist."
-
-        if not file_path.lower().endswith('.html'):
-            self.report_error(tr("⚠️ The specified file is not an HTML file: '{disp_path}'", disp_path=disp_path))
-            return "⚠️ The specified file is not an HTML file."
-
+        if not file_path.strip():
+            self.report_warning(tr("ℹ️ Empty file path provided."))
+            return tr("Warning: Empty file path provided. Operation skipped.")
+        if not os.path.isfile(file_path):
+            self.report_error(tr("❗ File does not exist: {file_path}", file_path=file_path))
+            return tr("Warning: File does not exist: {file_path}", file_path=file_path)
+        if not file_path.lower().endswith(('.html', '.htm')):
+            self.report_warning(tr("⚠️ Not an HTML file: {file_path}", file_path=file_path))
+            return tr("Warning: Not an HTML file: {file_path}", file_path=file_path)
+        url = 'file://' + os.path.abspath(file_path)
+        self.report_action(tr("📖 Opening HTML file in browser: {file_path}", file_path=file_path), ReportAction.READ)
         try:
-            webbrowser.open(f"file://{os.path.abspath(file_path)}")
-            self.report_success(tr("✅ Ok"))
-            return "✅ Ok"
-        except Exception as e:
-            self.report_error(tr("⚠️ Failed to open the HTML file: {err}", err=str(e)))
-            return f"⚠️ Failed to open the file: {str(e)}"
+            webbrowser.open(url)
+        except Exception as err:
+            self.report_error(tr("❗ Error opening HTML file: {file_path}: {err}", file_path=file_path, err=str(err)))
+            return tr("Warning: Error opening HTML file: {file_path}: {err}", file_path=file_path, err=str(err))
+        self.report_success(tr("✅ HTML file opened in browser: {file_path}", file_path=file_path))
+        return tr("HTML file opened in browser: {file_path}", file_path=file_path)

janito/tools/adapters/local/open_url.py

@@ -8,9 +8,10 @@ from janito.i18n import tr
 @register_local_tool
 class OpenUrlTool(ToolBase):
     """
-    Open the supplied URL in the default web browser.
+    Open the supplied URL or local file in the default web browser.
+
     Args:
-        url (str): The URL to open.
+        url (str): The URL or local file path (as a file:// URL) to open. Supports both web URLs (http, https) and local files (file://).
     Returns:
         str: Status message indicating the result.
     """