如何将flake8作为单元测试用例校验Python代码PEP8合规性

实现思路 #

Flake8官方提供了稳定的对外API，调用行为和命令行执行flake8命令完全一致，会自动读取项目目录下.flake8、setup.cfg、pyproject.toml中配置的校验规则，和你之前用pycodestyle实现的判断逻辑完全对齐：检查无错误返回True，存在规范问题返回False。

单文件校验实现代码 #

from flake8.api import legacy as flake8

def is_file_compliant(filename: str) -> bool:
    # 初始化风格检查器，自动加载项目本地的flake8配置
    style_guide = flake8.get_style_guide()
    # 对目标文件执行规范检查
    report = style_guide.check_files([filename])
    # 总错误数为0即判定为符合规范
    return report.total_errors == 0

全项目源文件批量校验 #

不需要手动遍历目录下的Python文件，直接将源码目录、测试目录路径传入检查接口即可，flake8会自动识别合法的Python源文件，同时应用配置文件中设置的文件忽略规则：

# 示例：校验src、tests两个目录下所有待检查的Python文件
report = style_guide.check_files(['src/', 'tests/'])

匹配原有pycodestyle检查范围 #

如果需要和之前纯pycodestyle的检查范围完全一致，只校验PEP8风格问题、不启用pyflakes、import排序等其他flake8插件规则，可以在初始化检查器时指定只加载pycodestyle对应的错误码：

# E、W是pycodestyle专属的错误、警告码前缀
style_guide = flake8.get_style_guide(select=['E', 'W'])

单元测试集成示例 #

以pytest为例，直接在测试用例中调用校验逻辑，存在规范问题时断言直接失败：

def test_code_meets_pep8_spec():
    style_guide = flake8.get_style_guide()
    report = style_guide.check_files(['src/', 'tests/'])
    assert report.total_errors == 0, f"检测到{report.total_errors}处不符合代码规范的问题，请修复后重试"

注意事项 #

• 不要直接调用flake8内部未公开的模块接口，上述legacy API是官方承诺兼容的稳定接口，跨版本不会随意变动
• 校验时输出的错误提示和命令行执行flake8的输出格式完全一致，可直接定位到问题所在的文件、行号和错误原因
• 自定义的忽略规则、行长度限制、插件配置都可以直接写在项目的flake8配置文件中，API会自动加载，不需要在代码中重复传参

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