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

janito/tools/adapters/local/find_files.py

@@ -1,138 +1,138 @@
-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.tools.tool_utils import pluralize, display_path
-from janito.dir_walk_utils import walk_dir_with_gitignore
-from janito.i18n import tr
-import fnmatch
-import os
-
-
-@register_local_tool
-class FindFilesTool(ToolBase):
-    """
-    Find files or directories in one or more directories matching a pattern. Respects .gitignore.
-
-    If a path is an existing file, it is checked against the provided pattern(s) and included in the results if it matches. This allows find_files to be used to look for a specific set of filenames in a single call, as well as searching directories.
-
-    Args:
-        paths (str): String of one or more paths (space-separated) to search in. Each path can be a directory or a file.
-        pattern (str): File pattern(s) to match. Multiple patterns can be separated by spaces. Uses Unix shell-style wildcards (fnmatch), e.g. '*.py', 'data_??.csv', '[a-z]*.txt'.
-            - If the pattern ends with '/' or '\', only matching directory names (with trailing slash) are returned, not the files within those directories. For example, pattern '*/' will return only directories at the specified depth.
-        max_depth (int, optional): Maximum directory depth to search. If None, unlimited recursion. If 0, only the top-level directory. If 1, only the root directory (matches 'find . -maxdepth 1').
-        include_gitignored (bool, optional): If True, includes files/directories ignored by .gitignore. Defaults to False.
-    Returns:
-        str: Newline-separated list of matching file paths. Example:
-            "/path/to/file1.py\n/path/to/file2.py"
-            "Warning: Empty file pattern provided. Operation skipped."
-    """
-
-    tool_name = "find_files"
-
-    def _match_directories(self, root, dirs, pat):
-        dir_output = set()
-        dir_pat = pat.rstrip("/\\")
-        for d in dirs:
-            if fnmatch.fnmatch(d, dir_pat):
-                dir_output.add(os.path.join(root, d) + os.sep)
-        return dir_output
-
-    def _match_files(self, root, files, pat):
-        file_output = set()
-        for filename in fnmatch.filter(files, pat):
-            file_output.add(os.path.join(root, filename))
-        return file_output
-
-    def _match_dirs_without_slash(self, root, dirs, pat):
-        dir_output = set()
-        for d in fnmatch.filter(dirs, pat):
-            dir_output.add(os.path.join(root, d))
-        return dir_output
-
-    def _handle_file_path(self, directory, patterns):
-        dir_output = set()
-        filename = os.path.basename(directory)
-        for pat in patterns:
-            # Only match files, not directories, for file paths
-            if not (pat.endswith("/") or pat.endswith("\\")):
-                if fnmatch.fnmatch(filename, pat):
-                    dir_output.add(directory)
-                    break
-        return dir_output
-
-    def _handle_directory_path(self, directory, patterns, max_depth, include_gitignored):
-        dir_output = set()
-        for root, dirs, files in walk_dir_with_gitignore(
-            directory,
-            max_depth=max_depth,
-            include_gitignored=include_gitignored,
-        ):
-            for pat in patterns:
-                if pat.endswith("/") or pat.endswith("\\"):
-                    dir_output.update(self._match_directories(root, dirs, pat))
-                else:
-                    dir_output.update(self._match_files(root, files, pat))
-                    dir_output.update(
-                        self._match_dirs_without_slash(root, dirs, pat)
-                    )
-        return dir_output
-
-    def _report_search(self, pattern, disp_path, depth_msg):
-        self.report_action(
-            tr(
-                "🔍 Search for files '{pattern}' in '{disp_path}'{depth_msg} ...",
-                pattern=pattern,
-                disp_path=disp_path,
-                depth_msg=depth_msg,
-            ),
-            ReportAction.READ,
-        )
-
-    def _report_success(self, count):
-        self.report_success(
-            tr(
-                " ✅ {count} {file_word}",
-                count=count,
-                file_word=pluralize("file", count),
-            ),
-            ReportAction.READ,
-        )
-
-    def _format_output(self, directory, dir_output):
-        if directory.strip() == ".":
-            dir_output = {
-                p[2:] if (p.startswith("./") or p.startswith(".\\")) else p
-                for p in dir_output
-            }
-        return sorted(dir_output)
-
-    def run(
-        self,
-        paths: str,
-        pattern: str,
-        max_depth: int = None,
-        include_gitignored: bool = False,
-    ) -> str:
-        if not pattern:
-            self.report_warning(tr("ℹ️ Empty file pattern provided."), ReportAction.READ)
-            return tr("Warning: Empty file pattern provided. Operation skipped.")
-        patterns = pattern.split()
-        results = []
-        for directory in paths.split():
-            disp_path = display_path(directory)
-            depth_msg = (
-                tr(" (max depth: {max_depth})", max_depth=max_depth)
-                if max_depth is not None and max_depth > 0
-                else ""
-            )
-            self._report_search(pattern, disp_path, depth_msg)
-            dir_output = set()
-            if os.path.isfile(directory):
-                dir_output = self._handle_file_path(directory, patterns)
-            elif os.path.isdir(directory):
-                dir_output = self._handle_directory_path(directory, patterns, max_depth, include_gitignored)
-            self._report_success(len(dir_output))
-            results.extend(self._format_output(directory, dir_output))
-        result = "\n".join(results)
-        return result
-
+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.tools.tool_utils import pluralize, display_path
+from janito.dir_walk_utils import walk_dir_with_gitignore
+from janito.i18n import tr
+import fnmatch
+import os
+
+
+@register_local_tool
+class FindFilesTool(ToolBase):
+    """
+    Find files or directories in one or more directories matching a pattern. Respects .gitignore.
+
+    If a path is an existing file, it is checked against the provided pattern(s) and included in the results if it matches. This allows find_files to be used to look for a specific set of filenames in a single call, as well as searching directories.
+
+    Args:
+        paths (str): String of one or more paths (space-separated) to search in. Each path can be a directory or a file.
+        pattern (str): File pattern(s) to match. Multiple patterns can be separated by spaces. Uses Unix shell-style wildcards (fnmatch), e.g. '*.py', 'data_??.csv', '[a-z]*.txt'.
+            - If the pattern ends with '/' or '\', only matching directory names (with trailing slash) are returned, not the files within those directories. For example, pattern '*/' will return only directories at the specified depth.
+        max_depth (int, optional): Maximum directory depth to search. If None, unlimited recursion. If 0, only the top-level directory. If 1, only the root directory (matches 'find . -maxdepth 1').
+        include_gitignored (bool, optional): If True, includes files/directories ignored by .gitignore. Defaults to False.
+    Returns:
+        str: Newline-separated list of matching file paths. Example:
+            "/path/to/file1.py\n/path/to/file2.py"
+            "Warning: Empty file pattern provided. Operation skipped."
+    """
+
+    tool_name = "find_files"
+
+    def _match_directories(self, root, dirs, pat):
+        dir_output = set()
+        dir_pat = pat.rstrip("/\\")
+        for d in dirs:
+            if fnmatch.fnmatch(d, dir_pat):
+                dir_output.add(os.path.join(root, d) + os.sep)
+        return dir_output
+
+    def _match_files(self, root, files, pat):
+        file_output = set()
+        for filename in fnmatch.filter(files, pat):
+            file_output.add(os.path.join(root, filename))
+        return file_output
+
+    def _match_dirs_without_slash(self, root, dirs, pat):
+        dir_output = set()
+        for d in fnmatch.filter(dirs, pat):
+            dir_output.add(os.path.join(root, d))
+        return dir_output
+
+    def _handle_file_path(self, directory, patterns):
+        dir_output = set()
+        filename = os.path.basename(directory)
+        for pat in patterns:
+            # Only match files, not directories, for file paths
+            if not (pat.endswith("/") or pat.endswith("\\")):
+                if fnmatch.fnmatch(filename, pat):
+                    dir_output.add(directory)
+                    break
+        return dir_output
+
+    def _handle_directory_path(self, directory, patterns, max_depth, include_gitignored):
+        dir_output = set()
+        for root, dirs, files in walk_dir_with_gitignore(
+            directory,
+            max_depth=max_depth,
+            include_gitignored=include_gitignored,
+        ):
+            for pat in patterns:
+                if pat.endswith("/") or pat.endswith("\\"):
+                    dir_output.update(self._match_directories(root, dirs, pat))
+                else:
+                    dir_output.update(self._match_files(root, files, pat))
+                    dir_output.update(
+                        self._match_dirs_without_slash(root, dirs, pat)
+                    )
+        return dir_output
+
+    def _report_search(self, pattern, disp_path, depth_msg):
+        self.report_action(
+            tr(
+                "🔍 Search for files '{pattern}' in '{disp_path}'{depth_msg} ...",
+                pattern=pattern,
+                disp_path=disp_path,
+                depth_msg=depth_msg,
+            ),
+            ReportAction.READ,
+        )
+
+    def _report_success(self, count):
+        self.report_success(
+            tr(
+                " ✅ {count} {file_word}",
+                count=count,
+                file_word=pluralize("file", count),
+            ),
+            ReportAction.READ,
+        )
+
+    def _format_output(self, directory, dir_output):
+        if directory.strip() == ".":
+            dir_output = {
+                p[2:] if (p.startswith("./") or p.startswith(".\\")) else p
+                for p in dir_output
+            }
+        return sorted(dir_output)
+
+    def run(
+        self,
+        paths: str,
+        pattern: str,
+        max_depth: int = None,
+        include_gitignored: bool = False,
+    ) -> str:
+        if not pattern:
+            self.report_warning(tr("ℹ️ Empty file pattern provided."), ReportAction.READ)
+            return tr("Warning: Empty file pattern provided. Operation skipped.")
+        patterns = pattern.split()
+        results = []
+        for directory in paths.split():
+            disp_path = display_path(directory)
+            depth_msg = (
+                tr(" (max depth: {max_depth})", max_depth=max_depth)
+                if max_depth is not None and max_depth > 0
+                else ""
+            )
+            self._report_search(pattern, disp_path, depth_msg)
+            dir_output = set()
+            if os.path.isfile(directory):
+                dir_output = self._handle_file_path(directory, patterns)
+            elif os.path.isdir(directory):
+                dir_output = self._handle_directory_path(directory, patterns, max_depth, include_gitignored)
+            self._report_success(len(dir_output))
+            results.extend(self._format_output(directory, dir_output))
+        result = "\n".join(results)
+        return result
+

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

@@ -1 +1 @@
-# Outline tools and parsers package
+# Outline tools and parsers package

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

@@ -1,117 +1,117 @@
-from janito.tools.adapters.local.adapter import register_local_tool
-from .python_outline import parse_python_outline
-from .markdown_outline import parse_markdown_outline
-from janito.formatting import OutlineFormatter
-from .java_outline import parse_java_outline
-import os
-from janito.tools.tool_base import ToolBase
-from janito.report_events import ReportAction
-from janito.tools.tool_utils import display_path, pluralize
-from janito.i18n import tr
-
-from janito.tools.adapters.local.adapter import register_local_tool as register_tool
-
-
-@register_tool
-class GetFileOutlineTool(ToolBase):
-    """
-    Get an outline of a file's structure. Supports Python and Markdown files.
-
-    Args:
-        file_path (str): Path to the file to outline.
-    """
-
-    tool_name = "get_file_outline"
-
-    def run(self, file_path: str) -> str:
-        try:
-            self.report_action(
-                tr(
-                    "📄 Outline file '{disp_path}' ...",
-                    disp_path=display_path(file_path),
-                ),
-                ReportAction.READ,
-            )
-            ext = os.path.splitext(file_path)[1].lower()
-            with open(file_path, "r", encoding="utf-8", errors="replace") as f:
-                lines = f.readlines()
-            return self._outline_by_extension(ext, lines)
-        except Exception as e:
-            self.report_error(
-                tr("❌ Error reading file: {error}", error=e),
-                ReportAction.READ,
-            )
-            return tr("Error reading file: {error}", error=e)
-
-    def _outline_by_extension(self, ext, lines):
-        if ext == ".py":
-            outline_items = parse_python_outline(lines)
-            outline_type = "python"
-            table = OutlineFormatter.format_outline_table(outline_items)
-            self.report_success(
-                tr(
-                    "✅ Outlined {count} {item_word}",
-                    count=len(outline_items),
-                    item_word=pluralize("item", len(outline_items)),
-                ),
-                ReportAction.READ,
-            )
-            return (
-                tr(
-                    "Outline: {count} items ({outline_type})\n",
-                    count=len(outline_items),
-                    outline_type=outline_type,
-                )
-                + table
-            )
-        elif ext == ".md":
-            outline_items = parse_markdown_outline(lines)
-            outline_type = "markdown"
-            table = OutlineFormatter.format_markdown_outline_table(outline_items)
-            self.report_success(
-                tr(
-                    "✅ Outlined {count} {item_word}",
-                    count=len(outline_items),
-                    item_word=pluralize("item", len(outline_items)),
-                ),
-                ReportAction.READ,
-            )
-            return (
-                tr(
-                    "Outline: {count} items ({outline_type})\n",
-                    count=len(outline_items),
-                    outline_type=outline_type,
-                )
-                + table
-            )
-        elif ext == ".java":
-            outline_items = parse_java_outline(lines)
-            outline_type = "java"
-            table = OutlineFormatter.format_outline_table(outline_items)
-            self.report_success(
-                tr(
-                    "✅ Outlined {count} {item_word}",
-                    count=len(outline_items),
-                    item_word=pluralize("item", len(outline_items)),
-                ),
-                ReportAction.READ,
-            )
-            return (
-                tr(
-                    "Outline: {count} items ({outline_type})\n",
-                    count=len(outline_items),
-                    outline_type=outline_type,
-                )
-                + table
-            )
-        else:
-            outline_type = "default"
-            self.report_success(
-                tr("✅ Outlined {count} items", count=len(lines)),
-                ReportAction.READ,
-            )
-            return tr(
-                "Outline: {count} lines ({outline_type})\nFile has {count} lines.",
-                count=len(lines),
-                outline_type=outline_type,
-            )
+from janito.tools.adapters.local.adapter import register_local_tool
+from .python_outline import parse_python_outline
+from .markdown_outline import parse_markdown_outline
+from janito.formatting import OutlineFormatter
+from .java_outline import parse_java_outline
+import os
+from janito.tools.tool_base import ToolBase
+from janito.report_events import ReportAction
+from janito.tools.tool_utils import display_path, pluralize
+from janito.i18n import tr
+
+from janito.tools.adapters.local.adapter import register_local_tool as register_tool
+
+
+@register_tool
+class GetFileOutlineTool(ToolBase):
+    """
+    Get an outline of a file's structure. Supports Python and Markdown files.
+
+    Args:
+        file_path (str): Path to the file to outline.
+    """
+
+    tool_name = "get_file_outline"
+
+    def run(self, file_path: str) -> str:
+        try:
+            self.report_action(
+                tr(
+                    "📄 Outline file '{disp_path}' ...",
+                    disp_path=display_path(file_path),
+                ),
+                ReportAction.READ,
+            )
+            ext = os.path.splitext(file_path)[1].lower()
+            with open(file_path, "r", encoding="utf-8", errors="replace") as f:
+                lines = f.readlines()
+            return self._outline_by_extension(ext, lines)
+        except Exception as e:
+            self.report_error(
+                tr("❌ Error reading file: {error}", error=e),
+                ReportAction.READ,
+            )
+            return tr("Error reading file: {error}", error=e)
+
+    def _outline_by_extension(self, ext, lines):
+        if ext == ".py":
+            outline_items = parse_python_outline(lines)
+            outline_type = "python"
+            table = OutlineFormatter.format_outline_table(outline_items)
+            self.report_success(
+                tr(
+                    "✅ Outlined {count} {item_word}",
+                    count=len(outline_items),
+                    item_word=pluralize("item", len(outline_items)),
+                ),
+                ReportAction.READ,
+            )
+            return (
+                tr(
+                    "Outline: {count} items ({outline_type})\n",
+                    count=len(outline_items),
+                    outline_type=outline_type,
+                )
+                + table
+            )
+        elif ext == ".md":
+            outline_items = parse_markdown_outline(lines)
+            outline_type = "markdown"
+            table = OutlineFormatter.format_markdown_outline_table(outline_items)
+            self.report_success(
+                tr(
+                    "✅ Outlined {count} {item_word}",
+                    count=len(outline_items),
+                    item_word=pluralize("item", len(outline_items)),
+                ),
+                ReportAction.READ,
+            )
+            return (
+                tr(
+                    "Outline: {count} items ({outline_type})\n",
+                    count=len(outline_items),
+                    outline_type=outline_type,
+                )
+                + table
+            )
+        elif ext == ".java":
+            outline_items = parse_java_outline(lines)
+            outline_type = "java"
+            table = OutlineFormatter.format_outline_table(outline_items)
+            self.report_success(
+                tr(
+                    "✅ Outlined {count} {item_word}",
+                    count=len(outline_items),
+                    item_word=pluralize("item", len(outline_items)),
+                ),
+                ReportAction.READ,
+            )
+            return (
+                tr(
+                    "Outline: {count} items ({outline_type})\n",
+                    count=len(outline_items),
+                    outline_type=outline_type,
+                )
+                + table
+            )
+        else:
+            outline_type = "default"
+            self.report_success(
+                tr("✅ Outlined {count} items", count=len(lines)),
+                ReportAction.READ,
+            )
+            return tr(
+                "Outline: {count} lines ({outline_type})\nFile has {count} lines.",
+                count=len(lines),
+                outline_type=outline_type,
+            )

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

@@ -1,40 +1,40 @@
-import re
-from typing import List, Dict
-
-def parse_java_outline(lines: List[str]) -> List[Dict]:
-    """
-    Parses Java source code lines and extracts classes and methods with their signatures.
-    Returns a list of outline items: {type, name, return_type, parameters, generics, line}
-    """
-    outline = []
-    class_pattern = re.compile(r"\bclass\s+(\w+)(\s*<[^>]+>)?")
-    # Match methods with or without visibility modifiers (including package-private)
-    method_pattern = re.compile(r"^(?:\s*(public|protected|private)\s+)?(?:static\s+)?([\w<>\[\]]+)\s+(\w+)\s*\(([^)]*)\)")
-    current_class = None
-    for idx, line in enumerate(lines, 1):
-        class_match = class_pattern.search(line)
-        if class_match:
-            class_name = class_match.group(1)
-            generics = class_match.group(2) or ""
-            outline.append({
-                "type": "class",
-                "name": class_name,
-                "generics": generics.strip("<>") if generics else None,
-                "line": idx
-            })
-            current_class = class_name
-        else:
-            method_match = method_pattern.search(line)
-            if method_match:
-                return_type = method_match.group(2)
-                method_name = method_match.group(3)
-                params = method_match.group(4)
-                outline.append({
-                    "type": "method",
-                    "class": current_class,
-                    "name": method_name,
-                    "return_type": return_type,
-                    "parameters": params.strip(),
-                    "line": idx
-                })
-    return outline
+import re
+from typing import List, Dict
+
+def parse_java_outline(lines: List[str]) -> List[Dict]:
+    """
+    Parses Java source code lines and extracts classes and methods with their signatures.
+    Returns a list of outline items: {type, name, return_type, parameters, generics, line}
+    """
+    outline = []
+    class_pattern = re.compile(r"\bclass\s+(\w+)(\s*<[^>]+>)?")
+    # Match methods with or without visibility modifiers (including package-private)
+    method_pattern = re.compile(r"^(?:\s*(public|protected|private)\s+)?(?:static\s+)?([\w<>\[\]]+)\s+(\w+)\s*\(([^)]*)\)")
+    current_class = None
+    for idx, line in enumerate(lines, 1):
+        class_match = class_pattern.search(line)
+        if class_match:
+            class_name = class_match.group(1)
+            generics = class_match.group(2) or ""
+            outline.append({
+                "type": "class",
+                "name": class_name,
+                "generics": generics.strip("<>") if generics else None,
+                "line": idx
+            })
+            current_class = class_name
+        else:
+            method_match = method_pattern.search(line)
+            if method_match:
+                return_type = method_match.group(2)
+                method_name = method_match.group(3)
+                params = method_match.group(4)
+                outline.append({
+                    "type": "method",
+                    "class": current_class,
+                    "name": method_name,
+                    "return_type": return_type,
+                    "parameters": params.strip(),
+                    "line": idx
+                })
+    return outline

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

@@ -1,14 +1,14 @@
-import re
-from typing import List
-
-
-def parse_markdown_outline(lines: List[str]):
-    header_pat = re.compile(r"^(#+)\s+(.*)")
-    outline = []
-    for idx, line in enumerate(lines):
-        match = header_pat.match(line)
-        if match:
-            level = len(match.group(1))
-            title = match.group(2).strip()
-            outline.append({"level": level, "title": title, "line": idx + 1})
-    return outline
+import re
+from typing import List
+
+
+def parse_markdown_outline(lines: List[str]):
+    header_pat = re.compile(r"^(#+)\s+(.*)")
+    outline = []
+    for idx, line in enumerate(lines):
+        match = header_pat.match(line)
+        if match:
+            level = len(match.group(1))
+            title = match.group(2).strip()
+            outline.append({"level": level, "title": title, "line": idx + 1})
+    return outline