From ed8a25a8ea39e835554233380ff9a1c0b8a1dfc8 Mon Sep 17 00:00:00 2001
From: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Date: Sat, 12 Apr 2025 18:55:54 +0100
Subject: [PATCH] Extract ``switchers.js`` rendering into a new function.
Previously, identical content for ``switchers.js`` was rendered for each
version-language pair. This commit pre-renders the content of the file,
then writing it to disk for each version-language pair.
---
build_docs.py | 40 +++++++++++++++++++++++++---------------
1 file changed, 25 insertions(+), 15 deletions(-)
diff --git a/build_docs.py b/build_docs.py
index 1efdabf..08f457e 100755
--- a/build_docs.py
+++ b/build_docs.py
@@ -467,23 +467,13 @@ def edit(file: Path):
temporary.rename(file)
-def setup_switchers(versions: Versions, languages: Languages, html_root: Path) -> None:
+def setup_switchers(script_content: bytes, html_root: Path) -> None:
"""Setup cross-links between CPython versions:
- Cross-link various languages in a language switcher
- Cross-link various versions in a version switcher
"""
- language_pairs = sorted((l.tag, l.switcher_label) for l in languages if l.in_prod) # NoQA: E741
- version_pairs = [(v.name, v.picker_label) for v in reversed(versions)]
-
- switchers_template_file = HERE / "templates" / "switchers.js"
switchers_path = html_root / "_static" / "switchers.js"
-
- template = Template(switchers_template_file.read_text(encoding="UTF-8"))
- rendered_template = template.safe_substitute(
- LANGUAGES=json.dumps(language_pairs),
- VERSIONS=json.dumps(version_pairs),
- )
- switchers_path.write_text(rendered_template, encoding="UTF-8")
+ switchers_path.write_text(script_content, encoding="UTF-8")
for file in html_root.glob("**/*.html"):
depth = len(file.relative_to(html_root).parts) - 1
@@ -541,8 +531,8 @@ class DocBuilder:
version: Version
versions: Versions
language: Language
- languages: Languages
cpython_repo: Repository
+ switchers_content: bytes
build_root: Path
www_root: Path
select_output: Literal["no-html", "only-html", "only-html-en"] | None
@@ -697,7 +687,7 @@ def build(self) -> None:
run(["chgrp", "-R", self.group, self.log_directory])
if self.includes_html:
setup_switchers(
- self.versions, self.languages, self.checkout / "Doc" / "build" / "html"
+ self.switchers_content, self.checkout / "Doc" / "build" / "html"
)
logging.info("Build done (%s).", format_seconds(perf_counter() - start_time))
@@ -1108,6 +1098,8 @@ def build_docs(args: argparse.Namespace) -> bool:
force_build = args.force
del args.force
+ switchers_content = render_switchers(versions, languages)
+
build_succeeded = set()
build_failed = set()
cpython_repo = Repository(
@@ -1127,7 +1119,12 @@ def build_docs(args: argparse.Namespace) -> bool:
scope.set_tag("language", language.tag)
cpython_repo.update()
builder = DocBuilder(
- version, versions, language, languages, cpython_repo, **vars(args)
+ version,
+ versions,
+ language,
+ cpython_repo,
+ switchers_content,
+ **vars(args),
)
built_successfully = builder.run(http, force_build=force_build)
if built_successfully:
@@ -1179,6 +1176,19 @@ def parse_languages_from_config() -> Languages:
return Languages.from_json(config["defaults"], config["languages"])
+def render_switchers(versions: Versions, languages: Languages) -> bytes:
+ language_pairs = sorted((l.tag, l.switcher_label) for l in languages if l.in_prod) # NoQA: E741
+ version_pairs = [(v.name, v.picker_label) for v in reversed(versions)]
+
+ switchers_template_file = HERE / "templates" / "switchers.js"
+ template = Template(switchers_template_file.read_text(encoding="UTF-8"))
+ rendered_template = template.safe_substitute(
+ LANGUAGES=json.dumps(language_pairs),
+ VERSIONS=json.dumps(version_pairs),
+ )
+ return rendered_template.encode("UTF-8")
+
+
def build_sitemap(
versions: Versions, languages: Languages, www_root: Path, group: str
) -> None:
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy