Add update_link_outputs

Author: classiqdor

.internal/update_outputs/update_links.py

@@ -0,0 +1,110 @@
+#!/usr/bin/env python3
+
+import json
+import re
+import sys
+from pathlib import Path
+
+LINK_PATTERN = re.compile(
+    r"Quantum program link: https://platform\.classiq\.io/circuit/\S+\n"
+)
+
+# cell index ; output index ; the link itself
+Link = tuple[int, int, str]
+
+
+def extract_links(cells: list[dict]) -> list[Link]:
+    links = []
+    for cell_index, cell in enumerate(cells):
+        if cell.get("cell_type", "") == "code":
+            outputs = cell.get("outputs", [])
+            for output_index, output in enumerate(outputs):
+                text = (
+                    "".join(output.get("text", []))
+                    if isinstance(output.get("text"), list)
+                    else output.get("text", "")
+                )
+                match = LINK_PATTERN.search(text)
+                if match:
+                    links.append((cell_index, output_index, match.group(0)))
+    return links
+
+
+def update_links(
+    cells: list[dict], old_links: list[Link], new_links: list[Link]
+) -> bool:
+    for (cell_index, output_index, old_link), (_, _, new_link) in zip(
+        old_links, new_links
+    ):
+        output = cells[cell_index]["outputs"][output_index]
+        text = output["text"]
+        for index, line in enumerate(text):
+            if old_link in line:
+                text[index] = line.replace(old_link, new_link)
+                break
+        else:
+            print("Couldn't find link. This shouldn't happen.")
+            return False
+    return True
+
+
+def validate_links_list(
+    old_links: list[Link], new_links: list[Link], force: bool
+) -> bool:
+    # verify list length
+    if len(old_links) != len(new_links):
+        print("Error: Link count mismatch in force mode")
+        return False
+
+    if force:
+        # verify cell index
+        old_indices = [i for i, _ in old_links]
+        new_indices = [i for i, _ in new_links]
+        if old_indices != new_indices:
+            print("Error: Link cell indices mismatch")
+            return False
+
+        # verify link pattern
+        if not all(LINK_PATTERN.match(link) for _, link in new_links):
+            print("Error: Not all new links match expected pattern")
+            return False
+
+    return True
+
+
+def main(dest_file: str, source_file: str, force: bool = False) -> bool:
+    with open(dest_file) as f:
+        old_nb = json.load(f)
+    with open(source_file) as f:
+        new_nb = json.load(f)
+
+    old_links = extract_links(old_nb["cells"])
+    new_links = extract_links(new_nb["cells"])
+
+    if not validate_links_list(old_links, new_links, force):
+        return False
+
+    if not update_links(old_nb["cells"], old_links, new_links):
+        return False
+
+    with open(dest_file, "w") as f:
+        json.dump(old_nb, f, indent=1)
+
+    print(f"Updated notebook written to: {dest_file}")
+    return True
+
+
+if __name__ == "__main__":
+    force = False
+    if "--force" in sys.argv:
+        force = True
+        sys.argv.remove("--force")
+
+    if len(sys.argv) != 3:
+        print(
+            f"Usage: {sys.argv[0]} <file in which we'll update the links> <file from which to take the links> [--force]"
+        )
+        sys.exit(1)
+
+    if not main(sys.argv[1], sys.argv[2], force):
+        sys.exit(1)

.internal/update_outputs/update_notebooks.sh

@@ -32,13 +32,13 @@ current_folder="$(realpath "$(dirname "$0")")"
 
 # note: there's a max of 3 running jobs per user, so we limit the threads to 3
 # # test all bernstein-vazirani notebooks
-find . -type f -name "*bernstein*.ipynb" | xargs -P2 -I{} "$current_folder/update_single_notebook.sh" {}
+find . -type f -name "*bernstein*.ipynb" | xargs -P2 -I{} "$current_folder/update_single_notebook_links.sh" {}
 # test all algorithms
-# find algorithms/ -type f -name "*.ipynb" | xargs -P3 -I{} "$current_folder/update_single_notebook.sh" {}
+# find algorithms/ -type f -name "*.ipynb" | xargs -P3 -I{} "$current_folder/update_single_notebook_links.sh" {}
 # # test 3 notebooks
-# find . -type f -name "*.ipynb" | head -n 3 | xargs -P3 -I{} "$current_folder/update_single_notebook.sh" {}
+# find . -type f -name "*.ipynb" | head -n 3 | xargs -P3 -I{} "$current_folder/update_single_notebook_links.sh" {}
 # # test all notebooks
-# find algorithms applications tutorials -type f -name "*.ipynb" | xargs -P3 -I{} "$current_folder/update_single_notebook.sh" {}
+# find algorithms applications tutorials -type f -name "*.ipynb" | xargs -P3 -I{} "$current_folder/update_single_notebook_links.sh" {}
 
 #
 # 3) Commit the changes + open PR

.internal/update_outputs/update_single_notebook_links.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+notebook_relative_path="$1"
+notebook_path="$(realpath "$notebook_relative_path")"
+
+notebook_dir=$(dirname "$notebook_path")
+notebook_name=$(basename "$notebook_path")
+
+
+current_folder="$(realpath "$(dirname "$0")")"
+
+# disable popping browser for `show(qprog)`
+export BROWSER="$current_folder/fake_browser.sh"
+
+# make a copy
+notebook_copy_path="$notebook_path.temp.ipynb"
+notebook_copy_name=$(basename "$notebook_copy_path")
+cp "$notebook_path" "$notebook_copy_path"
+
+"$current_folder/hook_add_random_seed.py" "$notebook_copy_path"
+
+pushd "$notebook_dir" > /dev/null
+jupyter nbconvert --to notebook --execute --inplace "$notebook_copy_name"
+popd > /dev/null
+
+"$current_folder/hook_remove_random_seed.py" "$notebook_copy_path"
+
+"$current_folder/update_links.py" "$notebook_path" "$notebook_copy_path"
+
+rm "$notebook_copy_path"