Экспортировать оглавление PDF
Достаёт дерево закладок и сохраняет его в Markdown или JSON с номерами страниц.
Что делает скрипт
Скрипт обходит вложенные закладки PDF и превращает их в плоский список с уровнями. Markdown удобно вставлять в документацию, JSON подходит для дальнейшей обработки. Если оглавления нет, команда завершается с кодом 1.
Быстрый старт
python export_pdf_outline.py book.pdf
Скачайте файл, откройте терминал в папке со скриптом и выполните команду.
В Linux и macOS интерпретатор может называться python3, в Windows - python или py.
Другие варианты
python export_pdf_outline.py manual.pdf --format jsonpython export_pdf_outline.py report.pdf --format md --outdir nav --force
Что понадобится
winget install Python.Python.3.12
brew install python
sudo apt install python3
py -m pip install pypdf
python3 -m pip install pypdf
python3 -m pip install pypdf
export_pdf_outline.py
#!/usr/bin/env python3
"""Экспорт дерева закладок PDF."""
from __future__ import annotations
import argparse
import json
import sys
from pathlib import Path
from pypdf import PdfReader
from pypdf.errors import PdfReadError
def walk(items: list, reader: PdfReader, depth: int, rows: list[dict[str, object]]) -> None:
for item in items:
if isinstance(item, list):
walk(item, reader, depth + 1, rows)
continue
try:
page = reader.get_destination_page_number(item) + 1
except Exception:
page = 0
rows.append({"title": str(item.title), "page": page, "level": depth})
def main() -> int:
parser = argparse.ArgumentParser(description="Экспортировать оглавление PDF")
parser.add_argument("input", type=Path, help="Исходный PDF")
parser.add_argument("--format", choices=("md", "json"), default="md", help="Формат отчёта")
parser.add_argument("--password", help="Пароль PDF")
parser.add_argument("--outdir", type=Path, default=Path("outline"), help="Папка результатов")
parser.add_argument("--force", action="store_true", help="Перезаписать результат")
args = parser.parse_args()
path = args.input.expanduser()
if not path.is_file():
print(f"Файл не найден: {path}", file=sys.stderr)
return 2
target = args.outdir.expanduser() / f"{path.stem}.{args.format}"
if target.exists() and not args.force:
print(f"Файл уже существует: {target}. Добавьте --force.", file=sys.stderr)
return 2
try:
reader = PdfReader(str(path))
if reader.is_encrypted and not reader.decrypt(args.password or ""):
print("Неверный пароль", file=sys.stderr)
return 2
rows: list[dict[str, object]] = []
walk(reader.outline, reader, 0, rows)
except (PdfReadError, OSError, ValueError) as error:
print(f"Не удалось прочитать PDF: {error}", file=sys.stderr)
return 1
if not rows:
print("В PDF нет закладок")
return 1
target.parent.mkdir(parents=True, exist_ok=True)
if args.format == "json":
target.write_text(json.dumps(rows, ensure_ascii=False, indent=2) + "\n", encoding="utf-8")
else:
lines = [f"# Оглавление: {path.stem}", ""]
for row in rows:
indent = " " * int(row["level"])
page = f" (стр. {row['page']})" if row["page"] else ""
lines.append(f"{indent}- {row['title']}{page}")
target.write_text("\n".join(lines) + "\n", encoding="utf-8")
print(f"Готово: {target}, пунктов: {len(rows)}")
return 0
if __name__ == "__main__":
raise SystemExit(main())
Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.