使用 Ollama 构建代码分析助手：本地 LLM 分步指南

想要一个完全在本地机器上运行的 AI 驱动代码审查工具吗？在这个两部分的教程中，我们将使用 ClientAI 和 Ollama 来构建这样一个助手。

我们的助手将分析 Python 代码结构，识别潜在问题，并提出改进建议——同时保持您的代码私密和安全。

有关 ClientAI 的文档请点击这里，Github 仓库请点击这里。

以下是本系列文章的索引：

第 1 部分：介绍、设置、工具创建（您在这里）
第 2 部分：构建助手和命令行接口

让我们开始吧！

项目概述

我们的代码分析助手将能够：

分析代码结构和复杂性
识别样式问题和潜在问题
生成文档建议
提供可行的改进建议

所有这些功能将在您的机器上本地运行，让您在保持代码完全隐私的同时，享受AI辅助的代码审查能力。

设置我们的环境

首先，为您的项目创建一个新目录：

mkdir local_task_planner
cd local_task_planner

安装支持Ollama的ClientAI：

pip install clientai[ollama]

确保您的系统上已安装Ollama。您可以从 Ollama的网站获取它。

现在让我们创建一个文件，用于编写代码：

touch code_analyzer.py

并开始我们的核心导入：

import ast
import json
import logging
import re
from dataclasses import dataclass
from typing import List

from clientai import ClientAI
from clientai.agent import (
  Agent,
  ToolConfig,
  act,
  observe,
  run,
  synthesize,
  think,
)
from clientai.ollama import OllamaManager, OllamaServerConfig

这些组件各自发挥着至关重要的作用：

ast: 通过将Python代码解析为树结构，帮助我们理解代码
ClientAI: 提供我们的AI框架
各种用于数据处理和模式匹配的实用模块

结构化我们的分析结果

在分析代码时，我们需要一种清晰的方式来组织我们的发现。以下是我们将如何结构化我们的结果：

@dataclass
class CodeAnalysisResult:
  """Results from code analysis."""
  complexity: int
  functions: List[str]
  classes: List[str]
  imports: List[str]
  issues: List[str]

可以将其视为我们代码分析的成绩单：

复杂度评分表示代码的复杂程度
函数和类的列表帮助我们理解代码结构
导入显示外部依赖
问题跟踪我们发现的任何问题

构建核心分析引擎

现在进入实际核心——让我们构建我们的代码分析引擎：

def analyze_python_code_original(code: str) -> CodeAnalysisResult:
    """Analyze Python code structure and complexity."""
    try:
        tree = ast.parse(code)
        functions = []
        classes = []
        imports = []
        complexity = 0
        for node in ast.walk(tree):
            if isinstance(node, ast.FunctionDef):
                functions.append(node.name)
                complexity += sum(
                    1
                    for _ in ast.walk(node)
                    if isinstance(_, (ast.If, ast.For, ast.While))
                )
            elif isinstance(node, ast.ClassDef):
                classes.append(node.name)
            elif isinstance(node, (ast.Import, ast.ImportFrom)):
                for name in node.names:
                    imports.append(name.name)

        return CodeAnalysisResult(
            complexity=complexity,
            functions=functions,
            classes=classes,
            imports=imports,
            issues=[],
        )
    except Exception as e:
        return CodeAnalysisResult(
            complexity=0,
            functions=[],
            classes=[],
            imports=[],
            issues=[str(e)]
        )

这个函数就像我们的代码侦探。它：

将代码解析为树结构
遍历树寻找函数、类和导入
通过计算控制结构来评估复杂性
返回全面的分析结果

实现风格检查

优质代码不仅要正确运行，还应具备可读性和可维护性。以下是我们的风格检查器：

def check_style_issues_original(code: str) -> List[str]:
    """Check for Python code style issues."""
    issues = []
    for i, line in enumerate(code.split("\n"), 1):
        if len(line.strip()) > 88:
            issues.append(f"Line {i} exceeds 88 characters")
    function_pattern = r"def\s+([a-zA-Z_][a-zA-Z0-9_]*)\s*\("
    for match in re.finditer(function_pattern, code):
        name = match.group(1)
        if not name.islower():
            issues.append(f"Function '{name}' should use snake_case")
    return issues

我们的风格检查器关注两个关键方面：

行长度 — 确保代码保持可读性
函数命名约定 — 强制使用Python推荐的snake_case风格

文档助手

文档对于可维护的代码至关重要。以下是我们的文档生成器：

def generate_docstring(code: str) -> str:
    """Generate docstring for Python code."""
    try:
        tree = ast.parse(code)
        for node in ast.walk(tree):
            if isinstance(node, (ast.FunctionDef, ast.ClassDef)):
                args = []
                if isinstance(node, ast.FunctionDef):
                    args = [a.arg for a in node.args.args]
                return f"""
                Suggested docstring for {node.name}:
                Args:
                {chr(4).join(f"{arg}: Description of {arg}" for arg in args)}
                Returns:
                    Description of return value
                Examples:
                    ```python
                    # Example usage of {node.name}
                    ```
                """
        return "No functions or classes found to document."
    except Exception as e:
        return f"Error generating docstring: {str(e)}"

该助手：

识别函数和类
提取参数信息
生成文档模板
包含示例的占位符

使我们的工具具备 AI 准备性

为了使我们的工具能够与 AI 系统集成，我们需要将它们封装为 JSON 友好的格式：

def analyze_python_code(code: str) -> str:
    """Wrap analyze_python_code_original to return JSON string."""
    if not code:
        return json.dumps({"error": "No code provided"})
    result = analyze_python_code_original(code)
    return json.dumps({
        "complexity": result.complexity,
        "functions": result.functions,
        "classes": result.classes,
        "imports": result.imports,
        "issues": result.issues,
    })

def check_style_issues(code: str) -> str:
    """Wrap check_style_issues_original to return JSON string."""
    if not code:
        return json.dumps({"error": "No code provided"})
    issues = check_style_issues_original(code)
    return json.dumps({"issues": issues})