tiennm99/serena
1
0
Fork 0
mirror of https://github.com/tiennm99/serena.git synced 2026-08-23 10:26:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged the overview tools into a single tool

Browse Source
This commit is contained in:
Michael Panchenko
2025-04-08 15:39:19 +02:00
parent 664d959eb8
commit 5d3e973ea8
2 changed files with 9 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -2
View File
@@ -584,8 +584,7 @@ Here is the full list of Serena's tools with a short description (output of `uv
* `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
* `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
* `get_active_project`: Gets the name of the currently active project (if any) and lists existing projects
* `get_dir_overview`: Gets an overview of the top-level symbols defined in all files within a given directory.
* `get_document_overview`: Gets an overview of the top-level symbols defined in a given file.
* `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file or directory.
* `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
* `insert_at_line`: Inserts content at a given line in a file.
* `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
src/serena/agent.py
+8 -29
View File
@@ -590,25 +590,26 @@ class ListDirTool(Tool):
return self._limit_length(result, max_answer_chars)
class GetDirOverviewTool(Tool):
class GetSymbolsOverviewTool(Tool):
"""
Gets an overview of the top-level symbols defined in all files within a given directory.
Gets an overview of the top-level symbols defined in a given file or directory.
"""
def apply(self, relative_path: str, max_answer_chars: int = _DEFAULT_MAX_ANSWER_LENGTH) -> str:
"""
Gets an overview of the given directory.
For each file in the directory, we list the top-level symbols in the file (name, kind, line).
Use this tool to get a high-level understanding of the code symbols inside a directory.
Gets an overview of the given file or directory.
For each analyzed file, we list the top-level symbols in the file (name, kind, line).
Use this tool to get a high-level understanding of the code symbols.
Calling this is often a good idea before more targeted reading, searching or editing operations on the code symbols.
:param relative_path: the relative path to the directory to get the overview of
:param relative_path: the relative path to the file or directory to get the overview of
:param max_answer_chars: if the overview is longer than this number of characters,
no content will be returned. Don't adjust unless there is really no other way to get the content
required for the task. If the overview is too long, you should use a smaller directory instead,
(e.g. a subdirectory).
:return: a JSON object mapping relative paths of all contained files to info about top-level symbols in the file (name, kind, line, column).
"""
path_to_symbol_infos = self.language_server.request_dir_overview(relative_path)
path_to_symbol_infos = self.language_server.request_overview(relative_path)
result = {}
for file_path, symbols in path_to_symbol_infos.items():
result[file_path] = [_tuple_to_info(*symbol_info) for symbol_info in symbols]
@@ -617,28 +618,6 @@ class GetDirOverviewTool(Tool):
return self._limit_length(result_json_str, max_answer_chars)
class GetDocumentOverviewTool(Tool):
"""
Gets an overview of the top-level symbols defined in a given file.
"""
def apply(self, relative_path: str, max_answer_chars: int = _DEFAULT_MAX_ANSWER_LENGTH) -> str:
"""
Use this tool to get a high-level understanding of the code symbols in a file. It often makes sense
to call this before targeted reading, searching or editing operations on the code symbols in the file,
as the output will contain a lot of information about names and lines.
:param relative_path: the relative path to the file to get the overview of
:param max_answer_chars: if the overview is longer than this number of characters,
no content will be returned. Don't adjust unless there is really no other way to get the content
required for the task.
:return: a JSON object with the info (name, kind, line, column) of all top-level symbols in the file.
"""
result = self.language_server.request_document_overview(relative_path)
result_json_str = json.dumps([_tuple_to_info(*symbol_info) for symbol_info in result])
return self._limit_length(result_json_str, max_answer_chars)
class FindSymbolTool(Tool):
"""
Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).