为现有代码库接入mypy：逐个屏蔽类型错误的最优方案

核心思路 #

通过让mypy输出结构化错误日志，再用脚本批量解析日志并在对应代码行添加指定注释，避免手动逐个修改。

步骤1：生成结构化错误日志 #

先让mypy输出JSON格式的错误信息，方便后续脚本解析：

mypy --json . > mypy_errors.json

可根据你的mypy配置添加额外参数（比如--strict），确保覆盖所有需要处理的错误。

步骤2：编写批量添加注释的Python脚本 #

以下脚本会自动读取错误日志，给每个报错行添加指定的# type: ignore注释，同时处理重复行、文件备份等问题：

import json
import os

# 替换为你的实际工单编号
TICKET_NUMBER = "PROJ-456"
IGNORE_COMMENT = f"# type: ignore  # Legacy types.  Ignoring for now.  See {TICKET_NUMBER}.  If you edit this code, please fix the types."

def add_ignore_comment(file_path, line_num):
    line_idx = line_num - 1  # 转换为Python列表的0索引
    try:
        with open(file_path, 'r', encoding='utf-8') as f:
            lines = f.readlines()
        
        # 跳过超出文件行数的无效错误
        if line_idx >= len(lines):
            print(f"跳过 {file_path}: 行号 {line_num} 超出文件范围")
            return
        
        target_line = lines[line_idx].rstrip('\n')
        # 避免重复添加相同注释
        if IGNORE_COMMENT in target_line:
            print(f"跳过 {file_path}: 行 {line_num} 已存在忽略注释")
            return
        
        # 在行尾添加注释（预留空格分隔原内容）
        new_line = f"{target_line}  {IGNORE_COMMENT}\n"
        lines[line_idx] = new_line
        
        # 备份原文件后写入修改内容
        backup_path = f"{file_path}.bak"
        if not os.path.exists(backup_path):
            os.rename(file_path, backup_path)
        
        with open(file_path, 'w', encoding='utf-8') as f:
            f.writelines(lines)
        print(f"已更新 {file_path}: 行 {line_num}")
    except Exception as e:
        print(f"处理 {file_path} 出错: {e}")

def main():
    with open('mypy_errors.json', 'r') as f:
        errors = json.load(f)
    
    # 按文件+行号去重，同一行只处理一次
    processed = set()
    for error in errors:
        if 'file' not in error or 'line' not in error:
            continue
        key = (error['file'], error['line'])
        if key in processed:
            continue
        processed.add(key)
        add_ignore_comment(error['file'], error['line'])

if __name__ == "__main__":
    main()

步骤3：执行与验证 #

1. 提前备份：先提交当前代码到Git，或手动备份代码库，防止脚本出错导致代码损坏。
2. 替换工单号：修改脚本中的TICKET_NUMBER为你的实际工单编号。
3. 运行脚本：执行上述Python脚本，等待处理完成。
4. 验证结果：重新运行mypy确认错误消除，同时抽查几个文件，确保注释正确添加到对应行末尾。

注意事项 #

• 脚本会给每个报错行添加通用的# type: ignore，忽略该行所有类型错误，符合你的需求。
• 每个修改过的文件会自动生成.bak后缀的备份，确认无误后可删除这些备份。
• 若遇到多行语句的报错，mypy标注的行号是语句起始行，脚本会在起始行添加注释，mypy可正常识别。

内容的提问来源于stack exchange，提问作者sixtyfootersdude