Method _run

src/hyperagent/tools/nav_tools.py:168–198

Run the tool to find all references of a target symbol. Args: word (str): The target symbol to find references for. line (int): The line number where the target symbol is located. relative_path (str): The relative path of the file containing the

(self, word: str, relative_file_path: str, line: Optional[int] = None, num_results: int = 10)

        self.lsptoolkit = LSPToolKit(path, language)
    
    def _run(self, word: str, relative_file_path: str, line: Optional[int] = None, num_results: int = 10):
        """
        Run the tool to find all references of a target symbol.

        Args:
            word (str): The target symbol to find references for.
            line (int): The line number where the target symbol is located.
            relative_path (str): The relative path of the file containing the target symbol.
            query (str, optional): The query used for reranking. Defaults to "".

        Returns:
            Union[str, List[str]]: The list of references or an error message if an exception occurs.
        """
        if relative_file_path is None:
            return "Please specify the relative file path"
        # if "/" not in relative_file_path:
        #     return "Invalid relative file path, please check the path again"
        
        abs_path = os.path.join(self.path, relative_file_path)
        
        is_dir = os.path.isdir(abs_path)
        if is_dir:
            return "The relative path is a folder, please specify the file path instead. Consider using get_tree_structure to find the file name then use this tool one file path at a time"
        
        file_exists = os.path.exists(abs_path)
        if not file_exists:
            return "The file is not found, please check the path again. If you want to find the file, consider using get_tree_structure to find the file name then use this tool one file path at a time or recall your memory."
        
        results = self.lsptoolkit.get_references(word, relative_file_path, line, verbose=True)
            
        return results[:num_results]

class GetAllSymbolsArgs(BaseModel):
    path_to_file: str = Field(..., description="The path of the python file we want extract all symbols from.")