Python 文件

PythonFileToolSpec

基础：BaseToolSpec

源代码位于 llama-index-integrations/tools/llama-index-tools-python-file/llama_index/tools/python_file/base.py

class PythonFileToolSpec(BaseToolSpec):
    spec_functions = ["function_definitions", "get_function", "get_functions"]

    def __init__(self, file_name: str) -> None:
        f = open(file_name).read()
        self.tree = ast.parse(f)

    def function_definitions(self, external: Optional[bool] = True) -> str:
        """
        Use this function to get the name and arguments of all function definitions in the python file.

        Args:
            external (Optional[bool]): Defaults to true. If false, this function will also return functions that start with _

        """
        functions = ""
        for node in ast.walk(self.tree):
            if isinstance(node, ast.FunctionDef):
                if external and node.name.startswith("_"):
                    continue
                functions += f"""
name: {node.name}
arguments: {ast.dump(node.args)}
                    """
        return functions

    def get_function(self, name: str) -> str:
        """
        Use this function to get the name and arguments of a single function definition in the python file.

        Args:
            name (str): The name of the function to retrieve

        """
        for node in ast.walk(self.tree):
            if isinstance(node, ast.FunctionDef):
                if node.name == name:
                    return f"""
name: {node.name}
arguments: {ast.dump(node.args)}
docstring: {ast.get_docstring(node)}
                        """
        return None

    def get_functions(self, names: List[str]) -> str:
        """
        Use this function to get the name and arguments of a list of function definition in the python file.

        Args:
            name (List[str]): The names of the functions to retrieve

        """
        functions = ""
        for name in names:
            functions += self.get_function(name) + "\n"
        return functions

function_definitions

function_definitions(external: Optional[bool] = True) -> str

使用此函数获取 Python 文件中所有函数定义的名称和参数。

参数

名称	类型	描述	默认值
external	可选[布尔值]	默认为 true。如果为 false，此函数也将返回以下划线开头的函数。	True

源代码位于 llama-index-integrations/tools/llama-index-tools-python-file/llama_index/tools/python_file/base.py

    def function_definitions(self, external: Optional[bool] = True) -> str:
        """
        Use this function to get the name and arguments of all function definitions in the python file.

        Args:
            external (Optional[bool]): Defaults to true. If false, this function will also return functions that start with _

        """
        functions = ""
        for node in ast.walk(self.tree):
            if isinstance(node, ast.FunctionDef):
                if external and node.name.startswith("_"):
                    continue
                functions += f"""
name: {node.name}
arguments: {ast.dump(node.args)}
                    """
        return functions

get_function

get_function(name: str) -> str

使用此函数获取 Python 文件中单个函数定义的名称和参数。

参数

名称	类型	描述	默认值
name	str	要检索的函数名称	required

源代码位于 llama-index-integrations/tools/llama-index-tools-python-file/llama_index/tools/python_file/base.py

    def get_function(self, name: str) -> str:
        """
        Use this function to get the name and arguments of a single function definition in the python file.

        Args:
            name (str): The name of the function to retrieve

        """
        for node in ast.walk(self.tree):
            if isinstance(node, ast.FunctionDef):
                if node.name == name:
                    return f"""
name: {node.name}
arguments: {ast.dump(node.args)}
docstring: {ast.get_docstring(node)}
                        """
        return None

get_functions

get_functions(names: List[str]) -> str

使用此函数获取 Python 文件中函数定义列表的名称和参数。

参数

名称	类型	描述	默认值
name	列表[字符串]	要检索的函数名称	required

源代码位于 llama-index-integrations/tools/llama-index-tools-python-file/llama_index/tools/python_file/base.py

def get_functions(self, names: List[str]) -> str:
    """
    Use this function to get the name and arguments of a list of function definition in the python file.

    Args:
        name (List[str]): The names of the functions to retrieve

    """
    functions = ""
    for name in names:
        functions += self.get_function(name) + "\n"
    return functions