Структура папок в Markdown
Строит дерево каталога в виде Markdown-блока с ограничением глубины и необязательными размерами файлов.
Что делает скрипт
Скрипт обходит папку, сортирует каталоги перед файлами и рисует переносимую схему с помощью ASCII-символов. Глубину можно ограничить, служебные папки исключить, а результат вывести на экран или сохранить в файл. Метаданные только читаются.
- С --force существующий Markdown-файл будет перезаписан.
Быстрый старт
python tree_markdown.py --dir ./project --depth 3
Скачайте файл, откройте терминал в папке со скриптом и выполните команду.
В Linux и macOS интерпретатор может называться python3, в Windows - python или py.
Другие варианты
python tree_markdown.py --dir . --depth 2 --sizespython tree_markdown.py --dir ./project --output tree.md --force
Что понадобится
winget install Python.Python.3.12
brew install python
sudo apt install python3
tree_markdown.py
#!/usr/bin/env python3
"""Построение дерева каталога в формате Markdown."""
from __future__ import annotations
import argparse
import os
from pathlib import Path
DEFAULT_EXCLUDES = {".git", ".hg", ".svn", "node_modules", "__pycache__", ".venv", "venv"}
def human_size(size: int) -> str:
value = float(size)
for unit in ("B", "KB", "MB", "GB", "TB"):
if value < 1024 or unit == "TB":
return f"{int(value)} B" if unit == "B" else f"{value:.1f} {unit}"
value /= 1024
return f"{size} B"
def build_tree(root: Path, max_depth: int, excludes: set[str], show_sizes: bool) -> tuple[list[str], dict[str, int]]:
lines = [f"{root.name}/"]
counters = {"files": 0, "dirs": 0, "size": 0}
def walk(directory: Path, prefix: str, level: int) -> None:
try:
entries = [entry for entry in os.scandir(directory) if entry.name not in excludes]
except OSError as error:
lines.append(f"{prefix}`-- [ошибка чтения: {error}]")
return
entries.sort(key=lambda entry: (not entry.is_dir(follow_symlinks=False), entry.name.lower()))
for index, entry in enumerate(entries):
last = index == len(entries) - 1
connector = "`-- " if last else "|-- "
is_dir = entry.is_dir(follow_symlinks=False)
suffix = "/" if is_dir else ""
if is_dir:
counters["dirs"] += 1
else:
counters["files"] += 1
if show_sizes:
try:
size = entry.stat(follow_symlinks=False).st_size
counters["size"] += size
suffix += f" ({human_size(size)})"
except OSError:
pass
elif level <= max_depth:
try:
counters["size"] += entry.stat(follow_symlinks=False).st_size
except OSError:
pass
lines.append(f"{prefix}{connector}{entry.name}{suffix}")
if is_dir and level < max_depth:
walk(Path(entry.path), prefix + (" " if last else "| "), level + 1)
walk(root, "", 1)
return lines, counters
def main() -> int:
parser = argparse.ArgumentParser(description="Структура папок в Markdown")
parser.add_argument("--dir", type=Path, required=True, help="Корневая папка")
parser.add_argument("--depth", type=int, default=3, help="Максимальная глубина")
parser.add_argument("--exclude", action="append", default=[], help="Имя папки, которую нужно пропустить")
parser.add_argument("--sizes", action="store_true", help="Показывать размеры файлов")
parser.add_argument("--output", type=Path, help="Сохранить Markdown в файл")
parser.add_argument("--force", action="store_true", help="Перезаписать существующий файл")
args = parser.parse_args()
root = args.dir.expanduser().resolve()
if not root.is_dir():
parser.error(f"Папка не найдена: {root}")
if args.depth < 1:
parser.error("--depth должен быть положительным")
excludes = DEFAULT_EXCLUDES | {item.strip() for item in args.exclude if item.strip()}
lines, counters = build_tree(root, args.depth, excludes, args.sizes)
document = [
f"# Дерево каталога {root.name}",
"",
"```text",
*lines,
"```",
"",
f"Файлов: {counters['files']}, папок: {counters['dirs']}, размер: {human_size(counters['size'])}",
"",
]
text = "\n".join(document)
if args.output:
output = args.output.expanduser()
if output.exists() and not args.force:
parser.error(f"Файл уже существует: {output}. Добавьте --force для перезаписи")
output.parent.mkdir(parents=True, exist_ok=True)
output.write_text(text, encoding="utf-8")
print(f"Markdown сохранён: {output}")
else:
print(text)
return 0
if __name__ == "__main__":
raise SystemExit(main())
Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.