使用colcon运行flake8时如何排除build、install等目录？

问题根源 #

colcon执行测试时，test_flake8.py是在build目录下的包测试子目录（比如build/dummy_pkg/test）中运行的，此时flake8的工作目录并非包根目录，因此无法自动加载包根的setup.cfg配置文件，导致排除规则失效。而直接在包根执行flake8 ./时，flake8会自动读取当前目录的setup.cfg，所以规则生效。

解决方案 #

方案1：修改test_flake8.py，指定setup.cfg路径 #

打开包内的test/test_flake8.py，修改flake8调用逻辑，手动指定配置文件的绝对路径：

import os
import ament_flake8.main

def test_flake8():
    # 获取包根目录路径
    pkg_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    # 调用flake8时指定配置文件
    rc = ament_flake8.main.main(
        argv=[
            '.',
            '--config', os.path.join(pkg_root, 'setup.cfg')
        ]
    )
    assert rc == 0, 'Found code style errors / warnings'

修改后重新执行colcon build --symlink-install，再运行colcon test --packages-select dummy_pkg，即可让flake8加载正确的排除规则。

方案2：修正setup.cfg的排除规则格式（可选但推荐） #

你的setup.cfg中exclude列表的install条目末尾缺少逗号，虽然flake8可能兼容，但规范写法会避免解析歧义，建议修正为：

[flake8]
exclude =
    .git,
    __pycache__,
    build,
    dist,
    install,
    test
[develop]
script_dir=$base/lib/test_pkg
[install]
install_scripts=$base/lib/test_pkg

方案3：通过colcon命令传递参数（临时方案） #

如果不想修改测试文件，可以在运行测试时手动指定flake8配置文件：

colcon test --packages-select dummy_pkg --pytest-args "--flake8-config=$(pwd)/setup.cfg"

验证 #

修改后执行以下命令确认问题解决：

colcon build --symlink-install
colcon test --packages-select dummy_pkg
colcon test-result --verbose

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