如何用脚本生成文件树状图

wen 实用脚本 2026-08-01 2

高效开发者的秘密武器：如何用脚本一键生成项目文件树状图（附Python/Shell实战）

📚 目录导读

为什么你需要文件树状图？（效率痛点与场景）
基础方案：tree 命令的妙用与局限
进阶方案：Python脚本定制化生成（含代码）
高阶玩法：过滤、输出格式与自动化集成
常见问题问答（FAQ）
选择最适合你的脚本策略

为什么你需要文件树状图？ 在代码审查、文档撰写或项目交接时，一份清晰的目录结构图能瞬间让读者（或未来的你）理清层级关系，手动用和画图不仅耗时，而且极易在项目更新后过期，脚本化生成文件树，是自动化文档和提升专业度的必备技能。

如何用脚本生成文件树状图

基础方案：tree 命令的妙用与局限 几乎所有Linux/Mac系统都自带了 tree 命令,只需在项目根目录执行：

tree -L 2 -I "node_modules|.git|__pycache__"

-L 2 限制层级为2，-I 忽略特定文件夹。
局限：格式单一，无法自定义缩进符号，无法输出为JSON/Markdown，且Windows默认不支持（需安装或使用PowerShell替代）。

进阶方案：Python脚本定制化生成（核心内容） 为了突破局限，我们使用Python的os和pathlib模块编写一个通用脚本，以下代码生成Markdown格式的树状图,并支持忽略列表和深度控制：

import os
from pathlib import Path
def generate_tree(start_path, prefix="", ignore_list=None, max_depth=4, depth=0):
    if ignore_list is None:
        ignore_list = ['.git', 'node_modules', '__pycache__', '.venv']
    if depth >= max_depth:
        return
    start_path = Path(start_path)
    entries = sorted([e for e in start_path.iterdir() if e.name not in ignore_list], 
                     key=lambda e: (e.is_file(), e.name.lower()))
    for index, entry in enumerate(entries):
        is_last = index == len(entries) - 1
        connector = "└── " if is_last else "├── "
        print(f"{prefix}{connector}{entry.name}")
        if entry.is_dir():
            extension = "    " if is_last else "│   "
            generate_tree(entry, prefix + extension, ignore_list, max_depth, depth+1)
if __name__ == "__main__":
    # 使用方法：运行脚本时传入目标路径， python tree_gen.py ./my_project
    target_path = input("请输入项目路径（默认当前目录）: ") or "."
    print("📁 文件结构树：\n")
    generate_tree(target_path)

关键解析：

递归函数 generate_tree：通过 iterdir() 获取子内容，用 is_dir() 判断是否深入。
排序逻辑：目录优先，且忽略大小写,保证视觉整齐。
前缀逻辑：通过 prefix 参数控制和空格,实现树形分支。

高阶玩法：过滤、输出格式与自动化集成

输出为JSON：将 print 改为 yield 构建字典，json.dump,方便程序化处理。
正则过滤：在 ignore_list 中加入正则匹配（如 *.pyc），用 fnmatch 模块。
搭配Cron定时任务：每天凌晨自动生成最新树状图并提交到Git仓库,保证文档实时性。

常见问题问答（FAQ）

Q1: 为什么我的脚本在Windows下运行乱码？
A：Windows控制台默认编码可能不支持符号，在脚本头部加 # -*- coding: utf-8 -*- 并执行 chcp 65001 切换代码页，或者用 os.system('') 开启ANSI转义。

Q2: 遇到超大项目（如几万文件），脚本会很慢怎么办？
A：利用 os.scandir() 代替 iterdir()（效率提升20%），并设置 max_depth 为3，避免递归过深，也可启动多线程,但注意内存开销。

Q3: 如何让树状图直接嵌入CSDN或Word文档？
A：生成Markdown格式后，用 pandoc 将 .md 转为 .docx，或者在脚本中直接输出HTML <ul> 标签,方便复制粘贴。

选择最适合你的脚本策略

简单快速：用系统 tree 命令。
跨平台+定制：用Python脚本,复制上述代码即可。
团队自动化：将脚本封装为CLI工具，并集成到CI/CD流程中。

行动建议：立即保存上文Python代码，在您的个人项目中测试一次，观察输出效果，尝试调整 ignore_list 或 max_depth 参数，你会发现，原本需要10分钟手动绘制的结构图,现在1秒生成且绝不会错。

（全文完）