当前位置：首页 > 文章列表 > 文章 > python教程 > 使用 ClientAI 和 Ollama 构建本地 AI 代码审查器

使用 ClientAI 和 Ollama 构建本地 AI 代码审查器

来源：dev.to 2024-12-21 18:19:04 0浏览收藏

珍惜时间，勤奋学习！今天给大家带来《使用 ClientAI 和 Ollama 构建本地 AI 代码审查器》，正文内容主要涉及到等等，如果你正在学习文章，或者是对文章有疑问，欢迎大家关注我！后面我会持续更新相关内容的，希望都能帮到正在学习的大家！

是否曾经想要拥有完全在本地计算机上运行的、由人工智能驱动的代码审查器？在这个由两部分组成的教程中，我们将使用 clientai 和 ollama 来构建它。

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

有关 clientai 的文档，请参阅此处；有关 github repo，请参阅此处。

系列索引

第 1 部分：简介、设置、工具创建（你在这里）
第 2 部分：构建助手和命令行界面

项目概况

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

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

所有这些都将在您的计算机上本地运行，为您提供人工智能辅助代码审查的能力，同时保持代码的完全隐私。

设置我们的环境

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

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代码解析为树结构来帮助我们理解python代码
clientai：提供我们的人工智能框架
用于数据处理和模式匹配的各种实用模块

构建我们的分析结果

分析代码时，我们需要一种干净的方式来组织我们的发现。以下是我们构建结果的方式：

@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:
                    ```
{% endraw %}
python
                    # example usage of {node.name}
{% raw %}

                    ```
                """
        return "no functions or classes found to document."
    except exception as e:
        return f"error generating docstring: {str(e)}"

这个帮手：

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

让我们的工具为人工智能做好准备

为了准备与人工智能系统集成的工具，我们需要将它们包装为 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})

这些包装器添加了输入验证、json 序列化和错误处理，使我们的助手更加防错。