OpenAI Codex Agent 模式实战：从零构建自动化代码审查机器人

# 通过 npm 安装全局命令行工具
npm install -g @openai/codex

# 验证安装

codex --version

# 输出: codex/1.2.0



# 配置 API Key

codex auth login

# 按提示输入 OpenAI API Key

mkdir codex-review-bot && cd codex-review-bot
git init

# 创建示例 Python 项目结构

mkdir -p src/codex_bot tests
touch src/codex_bot/__init__.py
touch src/codex_bot/reviewer.py
touch src/codex_bot/utils.py
touch tests/test_reviewer.py
touch requirements.txt

"""工具函数模块 - 包含待优化的代码示例"""
import os
import json

def load_config(path="config.json"):
    """加载配置文件"""
    f = open(path, "r")
    data = json.load(f)
    return data



def calc_discount(price, level):
    """计算折扣价格"""
    if level == "gold":
        return price * 0.8
    elif level == "silver":
        return price * 0.9
    elif level == "bronze":
        return price * 0.95
    else:
        return price



def fetch_user_data(user_id):
    """获取用户数据（模拟SQL查询）"""
    query = "SELECT * FROM users WHERE id = " + str(user_id)
    # TODO: 执行查询
    return {"id": user_id, "name": "test"}



def process_items(items):
    """处理列表数据"""
    result = []
    for i in range(len(items)):
        result.append(items[i] * 2)
    return result

codex agent

审查 src/codex_bot/utils.py 文件，修复以下问题：- 确保文件正确关闭或使用 with 语句
- 添加类型注解
- 修复 SQL 注入漏洞，使用参数化查询
- 将 process_items 改为列表推导式
- 添加适当的异常处理
- 为所有函数添加文档字符串


修改完成后运行 tests/test_reviewer.py 确认没有破坏现有功能。

[Agent] 分析任务目标...
[Agent] 读取 src/codex_bot/utils.py 文件内容
[Agent] 识别 6 处需要修改的位置
[Agent] 生成修复方案...

[Agent] 正在修改: 使用 with 语句确保文件关闭
[Agent] 正在修改: 添加类型注解
[Agent] 正在修改: 修复 SQL 注入漏洞
[Agent] 正在修改: 优化 process_items 为列表推导式
[Agent] 正在修改: 添加异常处理
[Agent] 正在修改: 完善文档字符串



[Agent] 运行测试: pytest tests/test_reviewer.py -v
[Agent] 测试通过，所有修改完成！

"""工具函数模块 - 代码审查优化后的版本"""
import os
import json
from typing import Any, Dict, List, Union

def load_config(path: str = "config.json") -> Dict[str, Any]:
    """加载 JSON 配置文件。



Args:
        path: 配置文件路径，默认为当前目录下的 config.json



Returns:
        解析后的配置字典



Raises:
        FileNotFoundError: 配置文件不存在时抛出
        json.JSONDecodeError: JSON 格式无效时抛出
    """
    try:
        with open(path, "r", encoding="utf-8") as f:
            return json.load(f)
    except FileNotFoundError:
        raise FileNotFoundError(f"配置文件未找到: {path}")
    except json.JSONDecodeError as e:
        raise json.JSONDecodeError(f"配置文件 JSON 格式错误: {e}")



def calc_discount(price: float, level: str) -> float:
    """根据会员等级计算折扣后价格。



Args:
        price: 原始价格，必须大于等于 0
        level: 会员等级，可选值为 "gold", "silver", "bronze"



Returns:
        折扣后的价格



Raises:
        ValueError: 价格小于 0 或会员等级无效时抛出
    """
    if price < 0:
        raise ValueError("价格不能为负数")



discount_map = {
        "gold": 0.8,
        "silver": 0.9,
        "bronze": 0.95,
    }



if level not in discount_map:
        raise ValueError(f"无效的会员等级: {level}，可选值: {list(discount_map.keys())}")



return price * discount_map[level]



def fetch_user_data(user_id: int) -> Dict[str, Union[int, str]]:
    """安全地获取用户数据。



使用参数化查询防止 SQL 注入攻击。



Args:
        user_id: 用户唯一标识符



Returns:
        包含用户信息的字典



Raises:
        ValueError: user_id 无效时抛出
    """
    if not isinstance(user_id, int) or user_id <= 0:
        raise ValueError("user_id 必须是正整数")



# 使用参数化查询，彻底杜绝 SQL 注入
    query = "SELECT * FROM users WHERE id = %s"
    params = (user_id,)



# TODO: 使用 ORM 或数据库连接池执行查询
    # db.execute(query, params)



return {"id": user_id, "name": "test"}



def process_items(items: List[int]) -> List[int]:
    """将列表中的每个元素乘以 2。



Args:
        items: 整数列表



Returns:
        每个元素乘以 2 后的新列表
    """
    return [item * 2 for item in items]

# 审查 src 目录下所有 Python 文件
codex agent --scope src/ \
  --prompt "审查所有 Python 文件，统一添加类型注解，修复安全问题，优化性能瓶颈"

# Codex Agent 审查规则配置
code_review:
  # 强制要求
  required:- type_annotations: true
- docstrings: true
- error_handling: true


# 安全规则
  security:

- no_sql_injection: true
- no_hardcoded_secrets: true
- input_validation: true


# 性能规则
  performance:

- prefer_list_comprehension: true
- avoid_nested_loops: warn


# 风格规则
  style:

- line_length: 88
- import_order: google

使用 .codex/rules.yaml 中的规则审查 src/ 目录，
对不符合 required 规则的问题必须修复，
对 performance 和 style 规则的问题给出优化建议。

# .github/workflows/codex-review.yml
name: Codex Auto Review

on:
  pull_request:
    paths:

- "src//*.py"


jobs:
  codex-review:
    runs-on: ubuntu-latest
    steps:

- uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
        with:
          node-version: "20"- name: Install Codex CLI
run: npm install -g @openai/codex- name: Run Codex Agent Review
env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
        run: |
          codex agent \
            --scope ${{ github.event.pull_request.changed_files }} \
            --prompt "审查变更的代码文件，生成审查报告并输出到 codex-review.md" \
            --output codex-review.md- name: Upload Review Report
uses: actions/upload-artifact@v4
        with:
          name: codex-review-report
          path: codex-review.md