find_unused_media.py

from pathlib import Path
import os
import argparse
from typing import Optional
import yaml


def find_unused_media(img_path: Optional[Path] = None, dry_run: bool = False):
    # load mkdocs.yml
    with open("mkdocs.yml", "r", encoding="utf-8") as f:
        # remove all !! pairs from the yaml file
        data = f.read()
        data = data.replace("!!", "")
        config = yaml.safe_load(data)

    docs_dir = Path.cwd() / Path(config.get("docs_dir", "docs"))
    assets_dir = Path(docs_dir, config["extra"]["attachments"])
    print(f"Looking for unused images in {assets_dir}...")
    if img_path:
        assets_dir = img_path

    images = [
        file
        for file in assets_dir.rglob("*")
        if file.is_file() and file.suffix in [".png", ".jpg", ".jpeg", ".gif", ".svg"]
    ]
    md_files = [file for file in docs_dir.rglob("*.md") if file.is_file()]

    # Search for images in markdown files

    used_images = []

    for md_file in md_files:
        for image in images:
            with open(md_file, "r", encoding="utf-8") as f:
                if image.name in f.read():
                    used_images.append(image)

    # compare the two lists
    unused_images = [image for image in images if image not in used_images]

    # delete unused images

    if unused_images:
        print(f"Found {len(unused_images)} unused images in {assets_dir}. Deleting...")
        for image in unused_images:
            if not dry_run:
                print(image)
                os.remove(image)
            else:
                print(f"Would delete {image}")
    else:
        print(f"Found no unused images in {assets_dir}.")


if __name__ == "__main__":
    # use argparse to get the path to the assets folder
    parser = argparse.ArgumentParser()
    parser.add_argument("--path", type=str, help="Path to the assets folder")
    parser.add_argument(
        "--dry-run", action="store_true", help="Do not delete unused images"
    )
    args = parser.parse_args()
    path = Path(args.path) if args.path else None
    find_unused_media(img_path=path, dry_run=args.dry_run)