如何通过配置文件为isort指定根目录扫描时的目标范围
isort 配置限定扫描范围的正确实现
之前尝试的配置失效原因
src_paths:该参数仅用于标记项目源码的根路径,辅助isort区分第一方导入与第三方导入的分类逻辑,完全不参与扫描范围的过滤,设置后isort仍会递归扫描当前路径下所有匹配规则的Python文件sources、directory:不属于isort支持的合法配置项,写入配置文件后会被直接忽略,不会产生任何效果
可行的配置方案
isort 原生没有提供在配置文件中直接指定“仅扫描目录白名单”的参数,所有扫描范围的控制逻辑都是基于路径跳过规则实现的:只要把执行isort .时根目录下不需要处理的路径全部加入跳过列表,isort遍历到对应路径时就会直接跳过、不会递归深入扫描,最终实现只处理预设目标目录的效果。
在pyproject.toml的[tool.isort]配置块中写入如下内容即可:
[tool.isort] profile = "black" # 保留原有src_paths配置,保证导入分类逻辑正确 src_paths = ["src", "test"] # 跳过规则:仅放行根目录下的src、test目录,其余路径全部跳过 skip = [ "^./(?!(src|test)/).*$" ] # 开启文件路径过滤,让跳过规则精准生效 filter_files = true
注意事项
- 上述正则匹配规则会自动过滤根目录下所有除
src、test之外的路径,不需要逐一罗列其他目录,后续新增目录也会被自动排除 - 规则匹配时会跳过所有不满足白名单条件的目录,isort会正常递归处理
src、test目录下的所有Python文件,不会影响导入排序的逻辑
内容的提问来源于stack exchange,提问作者joel
相关产品推荐
相关产品推荐

