Adding scripts/compare-changed-pdfs.py

py-pdf · Mar 7, 2024 · be66689 · be66689
1 parent 148a1b6
commit be66689
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 0 deletions.
diff --git a/scripts/changed_pdfs_comparison.html b/scripts/changed_pdfs_comparison.html
@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html lang="en"><head>
+    <title>Comparison of modified test/ PDF files</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <style>
+    </style>
+</head>
+<body>
+    {% for changed_pdf_file in changed_pdf_files %}
+    <span class="filename">{{ changed_pdf_file }}</span>
+    <div class="side-by-side">
+        <embed src="{{ changed_pdf_file }}" width="500px" height="707px" />
+        <embed src="master-checkouts/{{ changed_pdf_file }}" width="500px" height="707px" />
+    </div>
+    {% endfor %}
+</body>
+</html>
diff --git a/scripts/compare-changed-pdfs.py b/scripts/compare-changed-pdfs.py
@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+
+# Generate a HTML page that makes it easy to visually compare all PDF files
+# that are modified in the current branch, compared to the master branch.
+
+# USAGE: ./compare-changed-pdfs.py
+
+import webbrowser
+from functools import partial
+from http.server import HTTPServer, SimpleHTTPRequestHandler
+from os import makedirs, scandir
+from pathlib import Path
+from subprocess import check_output
+
+from jinja2 import Environment, FileSystemLoader
+
+PORT = 8000
+TEMPLATE_FILENAME = "changed_pdfs_comparison.html"
+
+SCRIPTS_DIR = Path(__file__).parent
+REPO_DIR = SCRIPTS_DIR.parent
+TMP_DIR = REPO_DIR / "master-checkouts"
+
+
+def scantree_dirs(path):
+    "Recursively yield DirEntry objects for all sub-directories in the given folder"
+    yield path
+    for entry in scandir(path):
+        if entry.is_dir():
+            yield from scantree_dirs(entry.path)
+
+
+stdout = check_output("git diff --name-status master", shell=True)
+changed_pdf_files = [
+    line[1:].strip()
+    for line in stdout.decode("utf-8").splitlines()
+    if line.startswith("M\ttest/")
+]
+
+TMP_DIR.mkdir(exist_ok=True)
+for dir in scantree_dirs(REPO_DIR / "test"):
+    (TMP_DIR / dir).mkdir(exist_ok=True)
+for changed_pdf_file in changed_pdf_files:
+    command = f"git show master:{changed_pdf_file} > {TMP_DIR}/{changed_pdf_file}"
+    print(command)
+    check_output(command, shell=True)
+
+env = Environment(
+    loader=FileSystemLoader(str(SCRIPTS_DIR)),
+    autoescape=True,
+    trim_blocks=True,
+    lstrip_blocks=True,
+)
+template = env.get_template(TEMPLATE_FILENAME)
+(REPO_DIR / TEMPLATE_FILENAME).write_text(
+    template.render(changed_pdf_files=changed_pdf_files)
+)
+
+httpd = HTTPServer(
+    ("", PORT), partial(SimpleHTTPRequestHandler, directory=str(REPO_DIR))
+)
+webbrowser.open(f"http://localhost:{PORT}/{TEMPLATE_FILENAME}")
+httpd.serve_forever()