如何通过setup.cfg配置忽略指定目录的flake8-docstrings特定错误?
如何在setup.cfg中忽略/foo目录下的D103错误
当然可以!要针对/foo目录下所有文件忽略D103(公共函数缺少文档字符串)错误,你可以借助flake8的per-file-ignores配置项实现精准控制,具体操作如下:
1. 编辑setup.cfg文件
找到项目根目录下的setup.cfg(如果没有就新建一个),定位到[flake8]配置块(没有的话就新增这个块)。
2. 添加per-file-ignores配置
在[flake8]块中添加如下配置:
[flake8] # 针对/foo目录下所有.py文件忽略D103错误 per-file-ignores = /foo/**/*.py: D103
配置说明
per-file-ignores:flake8提供的用于按文件/目录指定忽略错误码的选项/foo/**/*.py:使用通配符匹配/foo目录下所有子目录和文件中的.py文件(如果foo是项目根目录的子目录,写foo/**/*.py也生效): D103:指定要忽略的错误码,这里就是你要处理的D103
额外说明:如果需要忽略整个目录的所有错误
如果你之后需要忽略/foo目录下的所有flake8错误(而不只是D103),可以改用exclude选项:
[flake8] exclude = /foo/
这样配置后,flake8在扫描时就会自动跳过/foo目录下所有文件的D103错误检查啦。
内容的提问来源于stack exchange,提问作者maslak
相关产品推荐
相关产品推荐

