# Copyright (c) Microsoft Corporation. # Licensed under the MIT license. """Inject the PyRIT version picker into a built doc site. Usage: python -m build_scripts.inject_version_picker \\ --site-dir dist \\ --base /PyRIT The script walks every *.html under and injects (all into ): * * (CSS is bundled inside) Idempotent: files that already contain our marker are skipped. Why inline the JS instead of \n' def _inject(html: str, base: str, picker_js: str) -> tuple[str, bool]: if INJECT_MARKER in html: return html, False head_block = _head_block(base, picker_js) new = html.replace("", f"{head_block}", 1) if "" in html else head_block + html return new, True def _load_picker_js() -> str: js_src = ASSETS_SOURCE_DIR / "picker.js" closest_page_src = ASSETS_SOURCE_DIR / "closest_page.js" if not js_src.is_file(): raise FileNotFoundError(f"picker.js not found at {js_src}") if not closest_page_src.is_file(): raise FileNotFoundError(f"closest_page.js not found at {closest_page_src}") picker = js_src.read_text(encoding="utf-8") closest = closest_page_src.read_text(encoding="utf-8") if CLOSEST_PAGE_MARKER not in picker: raise RuntimeError( f"picker.js is missing the {CLOSEST_PAGE_MARKER!r} marker; the closest-page algorithm cannot be inlined." ) return picker.replace(CLOSEST_PAGE_MARKER, closest) def main(argv: list[str] | None = None) -> int: parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) parser.add_argument("--site-dir", type=Path, required=True, help="Root of the built docs site (e.g. dist/)") parser.add_argument("--base", type=str, required=True, help='URL base path the site is served from (e.g. "/PyRIT")') args = parser.parse_args(argv) site_dir: Path = args.site_dir.resolve() base: str = args.base.rstrip("/") if not site_dir.is_dir(): print(f"error: --site-dir {site_dir} does not exist", file=sys.stderr) return 1 picker_js = _load_picker_js() html_files = list(site_dir.rglob("*.html")) modified = 0 skipped = 0 for path in html_files: try: html = path.read_text(encoding="utf-8") except UnicodeDecodeError: skipped += 1 continue new_html, did_change = _inject(html, base, picker_js) if did_change: path.write_text(new_html, encoding="utf-8") modified += 1 else: skipped += 1 print(f"[inject_version_picker] modified={modified} skipped={skipped} total={len(html_files)} base={base}") return 0 if __name__ == "__main__": raise SystemExit(main())