登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  python教程

Python pathlib.Path.walk 怎么剪枝目录遍历

来源:17golang原创

时间:2026-09-27 02:36:37 159浏览 收藏

Path.walk() 剪枝的核心只有一句:保持 top_down=True,在遍历当前目录时原地修改 dirnames。被移除的目录不会继续递归。不能只写 dirnames = [...],因为这只是让局部变量指向新列表,遍历器仍持有原来的列表。

要点速览
  • 剪枝只在 top_down=True 时有效,这是 Path.walk() 的默认值。
  • 使用 dirnames[:]、remove() 或 del 原地修改目录列表。
  • 默认不跟随目录符号链接;开启后要自行防止循环,并用 on_error 决定错误策略。

用原地切片赋值跳过整个子树

下面的生成器只返回 Python 文件,并在进入子目录前排除常见的大型无关目录。dirpath 是 Path,而 dirnames、filenames 是名称字符串列表,因此最终路径要用 dirpath / filename 拼接。

from pathlib import Path

SKIP_DIRS = {".git", ".venv", "__pycache__", "node_modules"}

def walk_python_files(root: Path):
    def handle_error(exc: OSError) -> None:
        # 这里选择记录后继续;严格任务可以改成 raise exc。
        print(f"跳过无法访问的目录: {exc.filename}: {exc}")

    for dirpath, dirnames, filenames in root.walk(
        top_down=True,
        on_error=handle_error,
        follow_symlinks=False,
    ):
        # 必须原地改列表,Path.walk 才能看到剪枝结果。
        dirnames[:] = [name for name in dirnames if name not in SKIP_DIRS]

        for filename in filenames:
            path = dirpath / filename
            if path.suffix == ".py":
                yield path
Python Path.walk 通过原地修改 dirnames 剪掉无关目录子树的结构示意图
图1:查看根目录旁的 dirnames 控制列表;从列表移除 .git、.venv 和 node_modules 后,这些分支不再展开,保留分支继续扫描。

如果只想删除单项,也可以写 dirnames.remove(".git");规则较多时,切片赋值更清楚。需要稳定扫描顺序时,可在过滤后调用 dirnames.sort()。

固定名称之外,还可以按完整路径剪枝

有些目录名称本身没有问题,但目录内存在 .noindex、.generated 等标记时就应跳过。过滤条件可以同时查看名称和即将进入的完整路径:

def should_enter(parent: Path, name: str) -> bool:
    candidate = parent / name
    if name.startswith(".") and name not in {".config"}:
        return False
    if (candidate / ".noindex").exists():
        return False
    return True

for dirpath, dirnames, filenames in Path("src").walk(top_down=True):
    dirnames[:] = [name for name in dirnames if should_enter(dirpath, name)]
    # 此处处理 filenames

这种规则适合生成目录、归档目录或业务侧明确标记为“不扫描”的目录。不要在过滤函数里读取大量文件内容,否则剪枝节省的遍历成本可能又被额外 I/O 抵消。

符号链接和访问错误要单独决定

follow_symlinks=False 是默认值。目录符号链接不会被当作普通子目录继续递归,而会出现在 filenames 中。若改为 True,Path.walk() 不会自动记录已访问目录,链接环可能造成无限递归;此时应按设备号与 inode 保存已访问集合,或继续保持默认设置。

Python Path.walk 的符号链接、权限错误和继续遍历边界示意图
图2:重点看两条边界:目录链接在默认设置下不继续跟随,权限错误交给 on_error;记录后继续或抛出终止应由任务的重要性决定。
需求或现象正确处理原因
跳过固定目录原地过滤 dirnames遍历器会读取同一个列表决定下一层
过滤后仍进入目录检查是否写成 dirnames = [...]重绑定不会改变原列表
top_down=False 时剪枝无效改回 top_down=True自底向上时子目录已经生成
部分目录无权限提供 on_error 回调可以记录后继续,也可重新抛出

常见问题

为什么 dirnames = filtered 没有效果?

因为它只替换了局部变量引用。请使用 dirnames[:] = filtered,或对原列表调用 remove、del。

可以在 top_down=False 时修改 dirnames 吗?

可以修改列表本身,但不能影响递归结果,因为子目录在返回当前目录之前已经遍历完成。需要剪枝时必须使用 top_down=True。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>