讲师中心 微信公众号
AI工具推荐 视频效率加速

怎样用Python编写自动化生成项目README目录结构的工具

星芳姑娘_6318

星芳姑娘_6318

发布时间:2026-10-09 10:51:01

|

529人浏览过

|

来源于php中文网

原创

应过滤隐藏目录和虚拟环境:遍历中修改dirnames列表,排除以.开头及venv、env等;用relpath计算真实深度控制缩进;路径转小写连字符生成GitHub兼容锚点;通过标记定位更新README,避免覆盖原有内容。

怎样用python编写自动化生成项目readme目录结构的工具

用 os.walk() 遍历项目目录时,如何跳过隐藏文件和虚拟环境

直接调用 os.walk() 会遍历所有子目录,包括 .git、__pycache__、venv、.idea 等干扰项,导致生成的目录树冗长且无意义。

实操建议:在遍历前过滤掉以 . 开头的目录名,并显式排除常见虚拟环境路径:

  • 检查 dirnames 列表并原地修改(del 或 [:] =),不能只用 continue,否则子目录仍会被递归进入
  • 推荐写法:
    for root, dirnames, filenames in os.walk(top):<br>    dirnames[:] = [d for d in dirnames if not d.startswith('.') and d not in ('venv', 'env', '.venv', '__pycache__')]
  • 注意 os.walk() 的 topdown=True 是默认行为,必须保持,否则过滤无效

生成 Markdown 目录树时,缩进层级怎么对应实际目录深度

很多人用字符串拼接 " " 或 "\t" 控制缩进,结果层级错乱——因为根目录深度为 0,但第一级子目录应显示为 - src/,不是 - - src/。

实操建议:用 os.path.relpath(path, start) 计算相对路径,再按 os.sep 分割得到真实深度:

立即学习“Python免费学习笔记(深入)”;

testing-python
testing-python

使用pytest编写和评估有效的Python测试。适用于编写测试、审查测试代码、调试测试失败或提高测试覆盖率。

下载
  • 设项目根为 project_root = os.getcwd(),对每个 root 调用 relpath = os.path.relpath(root, project_root)
  • 若 relpath == '.',深度为 0;否则 depth = len(relpath.split(os.sep))
  • 每层用 " " * depth + "- " + basename + "/"(目录)或 " " * (depth + 1) + "- " + filename(文件)
  • 避免用 root.count(os.sep) —— Windows 下 drive:\path 会导致计数错误

怎样让 README.md 里的目录结构支持点击跳转(锚点)

纯文本目录好看但没法点,用户仍得手动翻找。Markdown 锚点依赖文件名转义规则,Python 默认不处理,直接写 [src/](#src) 会 404。

实操建议:对路径做 GitHub 风格的锚点编码 —— 小写 + 连字符替换空格/斜杠/点,去掉非 ASCII 字符:

  • 用正则 re.sub(r'[^\w\s-]', '', name) 清理非法字符
  • 再用 re.sub(r'[-\s]+', '-', name.strip()).lower() 标准化
  • 例如 tests/unit/test_utils.py → tests-unit-test-utils-py,最终生成:[tests/unit/test_utils.py](#tests-unit-test-utils-py)
  • 注意:GitHub 对锚点大小写敏感,务必统一转小写;中文路径建议跳过生成或提示警告,不强行转拼音

运行脚本后 README.md 被覆盖,怎么安全更新又不丢原有内容

直接 open('README.md', 'w') 会清空全文,如果原 README 有安装说明、作者信息等,就全没了。

实操建议:把目录结构插入到特定标记之间,比如 <!-- DIR-TREE:START --> 和 <!-- DIR-TREE:END -->:

  • 读取原文件为字符串,用 re.split() 或两次 str.find() 定位标记位置
  • 只替换两标记之间的内容,其余部分原样保留
  • 首次运行时若标记不存在,在文件末尾追加(或开头,按需),并带上注释说明用途
  • 强烈建议加 --dry-run 参数,先打印将要写入的内容,确认无误再落盘

目录结构工具真正的难点不在遍历或格式化,而在于“不破坏已有文档语义”——它本质是个文本编辑器,不是生成器。你得预判哪些行该留、哪些标记是人工维护的、哪些路径应该被忽略。一次写对不难,难的是下次项目结构调整后还能稳定跑通。

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1691

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4244

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1669

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

24677

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3007

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3047

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1163

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

C++运算符基础入门
C++运算符基础入门

本专题详细讲解了C++运算符的类型、语法与使用方法,涵盖算术运算符、关系运算符、逻辑运算符、位运算符、赋值运算符、条件运算符及其他特殊运算符,并通过代码示例解析优先级与结合性。

0

2026.10.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn