首页 > 后端开发 > Python教程 > 使用 ClientAI 和 Ollama 构建本地 AI 代码审查器 - 第 2 部分

使用 ClientAI 和 Ollama 构建本地 AI 代码审查器 - 第 2 部分

Susan Sarandon
发布: 2024-12-28 02:22:08
原创
137 人浏览过

Building a Local AI Code Reviewer with ClientAI and Ollama - Part 2

在第 1 部分中,我们为代码审查器构建了核心分析工具。现在我们将创建一个可以有效使用这些工具的人工智能助手。我们将逐步介绍每个组件,解释所有组件如何协同工作。

有关 ClientAI 的文档,请参阅此处;有关 Github Repo,请参阅此处。

系列索引

  • 第 1 部分:简介、设置、工具创建
  • 第 2 部分:构建助手和命令行界面(你在这里)

使用 ClientAI 注册我们的工具

首先,我们需要让我们的工具可供人工智能系统使用。以下是我们注册它们的方法:

def create_review_tools() -> List[ToolConfig]:
    """Create the tool configurations for code review."""
    return [
        ToolConfig(
            tool=analyze_python_code,
            name="code_analyzer",
            description=(
                "Analyze Python code structure and complexity. "
                "Expects a 'code' parameter with the Python code as a string."
            ),
            scopes=["observe"],
        ),
        ToolConfig(
            tool=check_style_issues,
            name="style_checker",
            description=(
                "Check Python code style issues. "
                "Expects a 'code' parameter with the Python code as a string."
            ),
            scopes=["observe"],
        ),
        ToolConfig(
            tool=generate_docstring,
            name="docstring_generator",
            description=(
                "Generate docstring suggestions for Python code. "
                "Expects a 'code' parameter with the Python code as a string."
            ),
            scopes=["act"],
        ),
    ]
登录后复制
登录后复制

让我们来分解一下这里发生的事情:

  1. 每个工具都包装在一个 ToolConfig 对象中,该对象告诉 ClientAI:

    • 工具:实际调用的函数
    • 名称:工具的唯一标识符
    • 描述:该工具的用途以及它需要哪些参数
    • 范围:工具何时可以使用(“观察”用于分析,“行动”用于生成)
  2. 我们将工具分为两类:

    • “观察”工具(code_analyzer 和 style_checker)收集信息
    • “act”工具(docstring_generator)产生新内容

构建AI助手类

现在让我们创建我们的人工智能助手。我们将其设计为分步骤工作,模仿人类代码审查者的想法:

class CodeReviewAssistant(Agent):
    """An agent that performs comprehensive Python code review."""

    @observe(
        name="analyze_structure",
        description="Analyze code structure and style",
        stream=True,
    )
    def analyze_structure(self, code: str) -> str:
        """Analyze the code structure, complexity, and style issues."""
        self.context.state["code_to_analyze"] = code
        return """
        Please analyze this Python code structure and style:

        The code to analyze has been provided in the context as 'code_to_analyze'.
        Use the code_analyzer and style_checker tools to evaluate:
        1. Code complexity and structure metrics
        2. Style compliance issues
        3. Function and class organization
        4. Import usage patterns
        """
登录后复制
登录后复制

第一个方法至关重要:

  • @observe 装饰器将其标记为观察步骤
  • stream=True 启用实时输出
  • 我们将代码存储在上下文中,以便在后续步骤中访问它
  • 返回字符串是指导AI使用我们的工具的提示

接下来,我们添加改进建议步骤:

    @think(
        name="suggest_improvements",
        description="Suggest code improvements based on analysis",
        stream=True,
    )
    def suggest_improvements(self, analysis_result: str) -> str:
        """Generate improvement suggestions based on the analysis results."""
        current_code = self.context.state.get("current_code", "")
        return f"""
        Based on the code analysis of:

        ```
{% endraw %}
python
        {current_code}
{% raw %}

        ```

        And the analysis results:
        {analysis_result}

        Please suggest specific improvements for:
        1. Reducing complexity where identified
        2. Fixing style issues
        3. Improving code organization
        4. Optimizing import usage
        5. Enhancing readability
        6. Enhancing explicitness
        """
登录后复制
登录后复制

这个方法:

  • 使用@think来表明这是一个推理步骤
  • 将分析结果作为输入
  • 从上下文中检索原始代码
  • 创建改进建议的结构化提示

命令行界面

现在让我们创建一个用户友好的界面。我们将其分解为几个部分:

def main():
    # 1. Set up logging
    logger = logging.getLogger(__name__)

    # 2. Configure Ollama server
    config = OllamaServerConfig(
        host="127.0.0.1",  # Local machine
        port=11434,        # Default Ollama port
        gpu_layers=35,     # Adjust based on your GPU
        cpu_threads=8,     # Adjust based on your CPU
    )
登录后复制
登录后复制

第一部分设置错误日志记录,使用合理的默认值配置 Ollama 服务器,并允许自定义 GPU 和 CPU 使用情况。

接下来,我们创建AI客户端和助手:

    # Use context manager for Ollama server
    with OllamaManager(config) as manager:
        # Initialize ClientAI with Ollama
        client = ClientAI(
            "ollama", 
            host=f"http://{config.host}:{config.port}"
        )

        # Create code review assistant with tools
        assistant = CodeReviewAssistant(
            client=client,
            default_model="llama3",
            tools=create_review_tools(),
            tool_confidence=0.8,  # How confident the AI should be before using tools
            max_tools_per_step=2, # Maximum tools to use per step
        )
登录后复制

此设置的要点:

  • 上下文管理器(with)确保正确的服务器清理
  • 我们连接到本地 Ollama 实例
  • 助手配置有:
    • 我们的定制工具
    • 工具使用的置信度阈值
    • 每个步骤的工具限制,以防止过度使用

最后,我们创建交互式循环:

def create_review_tools() -> List[ToolConfig]:
    """Create the tool configurations for code review."""
    return [
        ToolConfig(
            tool=analyze_python_code,
            name="code_analyzer",
            description=(
                "Analyze Python code structure and complexity. "
                "Expects a 'code' parameter with the Python code as a string."
            ),
            scopes=["observe"],
        ),
        ToolConfig(
            tool=check_style_issues,
            name="style_checker",
            description=(
                "Check Python code style issues. "
                "Expects a 'code' parameter with the Python code as a string."
            ),
            scopes=["observe"],
        ),
        ToolConfig(
            tool=generate_docstring,
            name="docstring_generator",
            description=(
                "Generate docstring suggestions for Python code. "
                "Expects a 'code' parameter with the Python code as a string."
            ),
            scopes=["act"],
        ),
    ]
登录后复制
登录后复制

此界面:

  • 收集多行代码输入,直到看到“###”
  • 处理流式和非流式输出
  • 提供干净的错误处理
  • 允许通过“退出”轻松退出

让我们将其设为我们能够运行的脚本:

class CodeReviewAssistant(Agent):
    """An agent that performs comprehensive Python code review."""

    @observe(
        name="analyze_structure",
        description="Analyze code structure and style",
        stream=True,
    )
    def analyze_structure(self, code: str) -> str:
        """Analyze the code structure, complexity, and style issues."""
        self.context.state["code_to_analyze"] = code
        return """
        Please analyze this Python code structure and style:

        The code to analyze has been provided in the context as 'code_to_analyze'.
        Use the code_analyzer and style_checker tools to evaluate:
        1. Code complexity and structure metrics
        2. Style compliance issues
        3. Function and class organization
        4. Import usage patterns
        """
登录后复制
登录后复制

使用助手

让我们看看助手如何处理真实的代码。让我们运行一下:

    @think(
        name="suggest_improvements",
        description="Suggest code improvements based on analysis",
        stream=True,
    )
    def suggest_improvements(self, analysis_result: str) -> str:
        """Generate improvement suggestions based on the analysis results."""
        current_code = self.context.state.get("current_code", "")
        return f"""
        Based on the code analysis of:

        ```
{% endraw %}
python
        {current_code}
{% raw %}

        ```

        And the analysis results:
        {analysis_result}

        Please suggest specific improvements for:
        1. Reducing complexity where identified
        2. Fixing style issues
        3. Improving code organization
        4. Optimizing import usage
        5. Enhancing readability
        6. Enhancing explicitness
        """
登录后复制
登录后复制

这是一个需要查找问题的示例:

def main():
    # 1. Set up logging
    logger = logging.getLogger(__name__)

    # 2. Configure Ollama server
    config = OllamaServerConfig(
        host="127.0.0.1",  # Local machine
        port=11434,        # Default Ollama port
        gpu_layers=35,     # Adjust based on your GPU
        cpu_threads=8,     # Adjust based on your CPU
    )
登录后复制
登录后复制

小助手会多方面分析:

  • 结构问题(嵌套 if 语句增加复杂性、缺少类型提示、无输入验证)
  • 样式问题(变量命名不一致、逗号后缺少空格、缺少文档字符串)

扩展想法

以下是增强助手的一些方法:

  • 其他分析工具
  • 增强的样式检查
  • 文档改进
  • 自动修复功能

通过创建新的工具函数,将其包装为适当的 JSON 格式,将其添加到 create_review_tools() 函数,然后更新助手的提示以使用新工具,可以添加其中的每一个。

要了解有关 ClientAI 的更多信息,请访问文档。

与我联系

如果您有任何疑问,想要讨论技术相关主题或分享您的反馈,请随时在社交媒体上与我联系:

  • GitHub:igorbenav
  • X/Twitter:@igorbenav
  • 领英:伊戈尔

以上是使用 ClientAI 和 Ollama 构建本地 AI 代码审查器 - 第 2 部分的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:dev.to
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板