65. AI代码审查与质量保证¶

传统审查：人工逐行看代码 → 慢、容易遗漏、受审查者水平限制
AI审查：  AI自动扫描代码  → 快、覆盖全面、24小时在线不知疲倦
最佳实践：AI审查 + 人工审查结合，AI做粗筛，人做精审

# .coderabbit.yaml 配置示例
reviews:
  auto_review:
    enabled: true          # 开启自动审查
  path_instructions:
    - path: "scripts/*.py"
      instructions: "检查是否有硬编码路径和缺少随机种子设置"

# .github/workflows/ai-review.yml
name: AI Code Review
on: [pull_request]
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4      # 拉取代码
      - name: AI Review
        uses: coderabbitai/ai-pr-reviewer@latest  # 调用AI审查
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

请审查以下Python代码，关注以下方面：
1. 逻辑错误和潜在Bug
2. 代码风格是否符合PEP8
3. 变量命名是否清晰
4. 有无安全隐患（如硬编码密码）
5. 性能是否可以优化
6. 是否有适当的错误处理

代码如下：
[粘贴你的代码]

请审查以下生信分析脚本，额外关注：
1. 文件路径是否硬编码（应改为命令行参数或配置文件）
2. 随机种子是否设置（保证结果可重复）
3. 中间结果是否有保存/checkpoint
4. 是否有适当的日志记录（logging而非print）
5. 输入数据是否有格式校验
6. 大文件处理是否用了迭代器/分块读取

代码如下：
[粘贴你的代码]

请审查以下Git diff，关注修改是否引入新Bug，
是否有遗漏的边界条件，修改是否完整（所有相关地方都改了）：

[粘贴git diff输出]

# 圈复杂度=1（最简单，没有分支）
def add(a, b):
    return a + b

# 圈复杂度=4（有3个分支判断 + 1个基础路径）
def classify_bmi(bmi):
    if bmi < 18.5:        # +1
        return "偏瘦"
    elif bmi < 24:         # +1
        return "正常"
    elif bmi < 28:         # +1
        return "偏胖"
    else:
        return "肥胖"

# 用pytest计算覆盖率
pip install pytest-cov                    # 安装覆盖率插件
pytest --cov=my_module tests/            # 运行测试并计算覆盖率
pytest --cov=my_module --cov-report=html  # 生成HTML报告

# Python命名规范（PEP8）
my_variable = 1          # 变量名：小写+下划线（snake_case）
MY_CONSTANT = 3.14       # 常量名：全大写+下划线
class MyClass:            # 类名：大驼峰（PascalCase）
def my_function():        # 函数名：小写+下划线
_private_var = "secret"   # 私有变量：前缀下划线

# 错误：硬编码路径，换台电脑就跑不了
data = pd.read_csv("/home/zhangsan/data/abundance.csv")

# 正确：用命令行参数
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--input", required=True, help="输入文件路径")  # 用参数传入路径
args = parser.parse_args()
data = pd.read_csv(args.input)

# 或者用配置文件
import yaml
with open("config.yaml") as f:
    config = yaml.safe_load(f)    # 从配置文件读路径
data = pd.read_csv(config["input_path"])

import numpy as np
import random
import torch  # 如果用深度学习

# 必须设置随机种子！白话：固定"随机"的起点，每次结果一样
SEED = 42
random.seed(SEED)                    # Python内置随机
np.random.seed(SEED)                 # NumPy随机
# torch.manual_seed(SEED)            # PyTorch随机（如果用的话）

# 记录软件版本，方便别人复现
import sys
print(f"Python: {sys.version}")      # 记录Python版本
print(f"NumPy: {np.__version__}")    # 记录NumPy版本
print(f"pandas: {pd.__version__}")   # 记录pandas版本

import logging

# 设置日志（比print更专业）
logging.basicConfig(
    level=logging.INFO,                              # 日志级别
    format="%(asctime)s - %(levelname)s - %(message)s",  # 带时间戳的格式
    handlers=[
        logging.FileHandler("analysis.log"),          # 同时写入文件
        logging.StreamHandler()                       # 同时输出到屏幕
    ]
)
logger = logging.getLogger(__name__)

# 使用日志
logger.info(f"读取数据：{input_file}，共{len(df)}行")     # 普通信息
logger.warning(f"缺失值比例：{missing_ratio:.2%}")         # 警告信息
logger.error(f"文件不存在：{input_file}")                   # 错误信息

def validate_abundance_table(df):
    """校验物种丰度表格式是否正确"""
    # 检查是否为空
    assert len(df) > 0, "丰度表为空"

    # 检查数值是否非负
    numeric_cols = df.select_dtypes(include=[np.number]).columns  # 取数值列
    assert (df[numeric_cols] >= 0).all().all(), "丰度值不能为负数"

    # 检查是否有全零行（空样本）
    zero_rows = (df[numeric_cols].sum(axis=1) == 0).sum()  # 统计全零行数
    if zero_rows > 0:
        logger.warning(f"发现{zero_rows}个全零样本，建议检查")

pip install black                 # 安装Black
black my_script.py                # 格式化单个文件
black scripts/                    # 格式化整个目录
black --check scripts/            # 只检查不修改（CI中使用）
black --line-length 88 scripts/   # 设置最大行宽（默认88）

pip install ruff                  # 安装Ruff
ruff check scripts/               # 检查代码问题
ruff check --fix scripts/         # 自动修复可修复的问题
ruff format scripts/              # 格式化代码（可替代Black）

[tool.ruff]
line-length = 88                   # 最大行宽
target-version = "py310"           # 目标Python版本

[tool.ruff.lint]
select = [
    "E",   # pycodestyle错误
    "W",   # pycodestyle警告
    "F",   # pyflakes（未使用的import等）
    "I",   # isort（import排序）
    "N",   # pep8-naming（命名规范）
    "D",   # pydocstyle（文档字符串）
    "UP",  # pyupgrade（过时语法升级）
]
ignore = ["D100", "D104"]          # 忽略某些规则

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["D"]                  # 测试文件不要求文档字符串

# 没有类型注解：运行时才发现类型错误
def calculate_diversity(abundances):
    return -sum(p * log(p) for p in abundances if p > 0)

# 有类型注解：mypy可以在运行前发现类型错误
def calculate_diversity(abundances: list[float]) -> float:
    return -sum(p * log(p) for p in abundances if p > 0)

pip install mypy                   # 安装mypy
mypy my_script.py                  # 检查类型
mypy --ignore-missing-imports scripts/  # 忽略第三方库缺少类型

conda activate bioinfo              # 激活生信环境
pip install ruff black               # 安装Ruff和Black

# bad_example.py - 故意写得不规范的生信代码
import pandas as pd
import numpy as np
import os,sys                        # 错误：多个import写一行
from math import log,sqrt,exp       # 错误：逗号后没空格

data_path="/home/user/data/otu_table.csv"  # 错误：硬编码路径
df=pd.read_csv(data_path)           # 错误：等号两边没空格

def CalcShannon( abundances ):       # 错误：函数名不符合snake_case
    """calculate shannon diversity"""
    total=sum(abundances)
    result=0
    for a in abundances:
        if a>0:
            p=a/total
            result+=-p*log(p)
    return result

class  diversityCalculator:          # 错误：类名不符合PascalCase
    pass

ruff check bad_example.py            # 查看问题列表
# 输出示例：
# bad_example.py:3:1: E401 Multiple imports on one line
# bad_example.py:4:17: E231 Missing whitespace after ','
# bad_example.py:6:1: E225 Missing whitespace around operator
# bad_example.py:8:1: N802 Function name should be lowercase
# bad_example.py:16:1: N801 Class name should use CapWords

ruff check --fix bad_example.py      # Ruff自动修复（import排序等）
black bad_example.py                  # Black自动格式化（缩进/空格/换行等）

# 修复后的代码（自动格式化结果）
import os
import sys
from math import exp, log, sqrt      # 自动排序，加了空格

import numpy as np
import pandas as pd

data_path = "/home/user/data/otu_table.csv"  # 等号两边加了空格
df = pd.read_csv(data_path)


def calc_shannon(abundances):         # 函数名改为snake_case（需手动）
    """calculate shannon diversity"""
    total = sum(abundances)
    result = 0
    for a in abundances:
        if a > 0:
            p = a / total
            result += -p * log(p)
    return result


class DiversityCalculator:            # 类名改为PascalCase（需手动）
    pass

[ ] 路径参数化（无硬编码路径）
[ ] 随机种子已设置
[ ] 软件版本已记录
[ ] 用logging替代print
[ ] 输入数据有校验
[ ] 大文件用迭代器处理
[ ] 中间结果有checkpoint
[ ] 异常处理完善
[ ] 命名符合PEP8
[ ] 有README说明运行方式