pathlib 如何递归删除目录但保留特定文件(如 .gitkeep)

应手动遍历路径并逐个删除:先用Path.rglob("*")获取所有子孙路径,反向排序确保子路径优先处理;过滤时需用should_keep(path)函数,结合path.is_file()和白名单(如{".gitkeep"})判断;删除前校验path.is_relative_to(root),再对文件调用unlink(missing_ok=True),

对空目录调用rmdir()。

pathlib 遍历并筛选要删除的路径

直接调用 shutil.rmtree() 会无差别删掉整个目录,没法保留文件;必须手动遍历、判断、逐个删除。核心是用 Path.rglob("*") 拿到所有子孙路径,再反向排序(确保子路径先于父路径处理),避免因父目录已删导致子路径操作失败。

注意:rglob("*") 不包含起始目录本身,所以最后还得单独判断根目录是否要删——但通常你只想清空它,而不是删掉目录容器本身。

  • sorted(paths, reverse=True) 确保 foo/bar/file.txtfoo/bar 之前处理
  • rglob("*") 会跳过空目录,所以空目录需额外识别(比如用 is_dir() and not any(dir.iterdir())
  • 保留逻辑建议写成函数,例如 should_keep(path: Path) -> bool,方便复用和测试

如何安全保留 .gitkeep 和其他白名单文件

保留不是“跳过删除”,而是“不加入待删列表”。关键在过滤条件:既要匹配文件名(如 .gitkeep),也要注意路径类型(只对文件生效,目录不能只因名字叫 .gitkeep 就保留)。

常见错误是写成 path.name == ".gitkeep" 却没加 path.is_file() 判断,结果把同名目录也放过了,后续删其子项时可能报错或漏删。

  • 推荐白名单用集合: KEEP_FILES = {".gitkeep", ".keep", ".placeholder"}
  • 判断逻辑应为:path.is_file() and path.name in KEEP_FILES
  • 如果还要保留某些扩展名(如 .env.example),可补充 path.suffix == ".example" 等条件

删除前务必检查路径是否在目标根目录内

rglob() 返回的是绝对路径(如果原 Path 是绝对路径),但你实际只想操作某个子树。若不校验,一不小心可能把 /home/user/.gitkeep 也当成目标路径误判——尤其当代码里用了 Path(".").resolve() 后又拼接了用户输入。

最稳妥的方式是用 path.is_relative_to(root)(Python 3.9+),旧版本可用 str(path).startswith(str(root) + "/") or path == root,但要注意跨平台路径分隔符。

  • 永远对 root 调用 .resolve() 再参与比较,避免符号链接或 .. 导致判断失效
  • 如果 root 是相对路径,先转绝对路径再比,否则 is_relative_to 会抛 ValueError
  • 别依赖 path.parent 向上追溯来判断归属——遇到硬链接或挂载点可能绕出目标范围

执行删除时优先用 unlink(missing_ok=True)rmdir()

不用 shutil.rmtree() 的另一个原因是它不区分文件/目录,而我们已经按顺序排好路径,可以精准调用对应方法:文件用 unlink(),空目录用 rmdir()。这样更可控,也便于捕获具体哪类操作失败。

missing_ok=True 很重要——因为多线程/其他进程可能在你遍历后、删除前就删掉了某文件,不加这个参数会导致 FileNotFoundError 中断整个流程。

  • 对每个路径:先 path.unlink(missing_ok=True)(如果是文件)
  • 再尝试 path.rmdir()(如果是目录且为空);非空目录会被前面的子路径清理掉,所以这里应该总能成功
  • 删完不补日志或异常处理的话,建议至少用 try/except OSError 包一层,避免权限问题卡死
真正容易被忽略的是:**保留文件的父目录如果变为空,它本身不会自动被保留**——比如删光 dist/ 下所有内容,只留 dist/.gitkeep,那 dist/ 目录还在;但如果你本意是“清空目录但确保它存在”,就得在最后检查并重建空目录,而不是指望 .gitkeep 自动撑住父级。