Add version information for the version picker.

Author: JulienPalard

build_docs.py

@@ -10,9 +10,9 @@
                 [--languages [fr [fr ...]]]
 
 
-Without any arguments builds docs for all branches configured in the
-global BRANCHES value and all languages configured in LANGUAGES,
-ignoring the -d flag as it's given in the BRANCHES configuration.
+Without any arguments builds docs for all active versions configured in the
+global VERSIONS list and all languages configured in the LANGUAGES list,
+ignoring the -d flag as it's given in the VERSIONS configuration.
 
 -q selects "quick build", which means to build only HTML.
 
@@ -58,20 +58,24 @@
 
 VERSION = "19.0"
 
-BRANCHES = [
-    # version, git branch, isdev
-    ("3.6", "3.6", False),
-    ("3.7", "3.7", False),
-    ("3.8", "3.8", False),
-    ("3.9", "3.9", True),
-    ("3.10", "master", True),
-]
-
-
+# status in {"EOL", "security", "stable", "pre-release", "in development"}
+Version = namedtuple("Version", ["name", "branch", "status"])
 Language = namedtuple(
     "Language", ["tag", "iso639_tag", "name", "in_prod", "sphinxopts"]
 )
 
+# EOL and security are not automatically built, no need to remove them
+# from the list.
+VERSIONS = [
+    Version("2.7", "2.7", "EOL"),
+    Version("3.5", "3.5", "security"),
+    Version("3.6", "3.6", "security"),
+    Version("3.7", "3.7", "stable"),
+    Version("3.8", "3.8", "stable"),
+    Version("3.9", "3.9", "pre-release"),
+    Version("3.10", "master", "in development"),
+]
+
 XELATEX_DEFAULT = (
     "-D latex_engine=xelatex",
     "-D latex_elements.inputenc=",
@@ -299,32 +303,26 @@ def setup_switchers(html_root):
 
 
 def build_one(
-    version,
-    git_branch,
-    isdev,
-    quick,
-    venv,
-    build_root,
-    group,
-    log_directory,
-    language: Language,
+    version, quick, venv, build_root, group, log_directory, language: Language,
 ):
     checkout = os.path.join(
-        build_root, version, "cpython-{lang}".format(lang=language.tag)
+        build_root, version.name, "cpython-{lang}".format(lang=language.tag)
+    )
+    logging.info(
+        "Build start for version: %s, language: %s", version.name, language.tag
     )
-    logging.info("Build start for version: %s, language: %s", version, language.tag)
     sphinxopts = list(language.sphinxopts)
     sphinxopts.extend(["-q"])
     if language.tag != "en":
-        locale_dirs = os.path.join(build_root, version, "locale")
+        locale_dirs = os.path.join(build_root, version.name, "locale")
         locale_clone_dir = os.path.join(locale_dirs, language.iso639_tag, "LC_MESSAGES")
         locale_repo = "https://github.com/python/python-docs-{}.git".format(
             language.tag
         )
         git_clone(
             locale_repo,
             locale_clone_dir,
-            translation_branch(locale_repo, locale_clone_dir, version),
+            translation_branch(locale_repo, locale_clone_dir, version.name),
         )
         sphinxopts.extend(
             (
@@ -333,12 +331,16 @@ def build_one(
                 "-D gettext_compact=0",
             )
         )
-    git_clone("https://github.com/python/cpython.git", checkout, git_branch)
+    git_clone("https://github.com/python/cpython.git", checkout, version.branch)
     maketarget = (
-        "autobuild-" + ("dev" if isdev else "stable") + ("-html" if quick else "")
+        "autobuild-"
+        + ("dev" if version.status == "in development" else "stable")
+        + ("-html" if quick else "")
     )
     logging.info("Running make %s", maketarget)
-    logname = "cpython-{lang}-{version}.log".format(lang=language.tag, version=version)
+    logname = "cpython-{lang}-{version}.log".format(
+        lang=language.tag, version=version.name
+    )
     python = os.path.join(venv, "bin/python")
     sphinxbuild = os.path.join(venv, "bin/sphinx-build")
     blurb = os.path.join(venv, "bin/blurb")
@@ -368,7 +370,7 @@ def build_one(
     )
     shell_out(["chgrp", "-R", group, log_directory])
     setup_switchers(os.path.join(checkout, "Doc", "build", "html"))
-    logging.info("Build done for version: %s, language: %s", version, language.tag)
+    logging.info("Build done for version: %s, language: %s", version.name, language.tag)
 
 
 def copy_build_to_webroot(
@@ -603,13 +605,17 @@ def main():
     setup_logging(args.log_directory)
     venv = os.path.join(args.build_root, "venv")
     if args.branch:
-        branches_to_do = [
-            branch
-            for branch in BRANCHES
-            if str(branch[0]) == args.branch or branch[1] == args.branch
+        versions_to_build = [
+            version
+            for version in VERSIONS
+            if version.name == args.branch or version.branch == args.branch
         ]
     else:
-        branches_to_do = BRANCHES
+        versions_to_build = [
+            version
+            for version in VERSIONS
+            if version.status != "EOL" and version.status != "security"
+        ]
     if args.languages:
         languages = [languages_dict[tag] for tag in args.languages]
     else:
@@ -619,17 +625,15 @@ def main():
         languages = [
             language for language in LANGUAGES if language.tag in DEFAULT_LANGUAGES_SET
         ]
-    for version, git_branch, devel in branches_to_do:
+    for version in versions_to_build:
         for language in languages:
             if sentry_sdk:
                 with sentry_sdk.configure_scope() as scope:
-                    scope.set_tag("version", version)
+                    scope.set_tag("version", version.name)
                     scope.set_tag("language", language.tag)
             try:
                 build_one(
                     version,
-                    git_branch,
-                    devel,
                     args.quick,
                     venv,
                     args.build_root,
@@ -650,7 +654,7 @@ def main():
                 logging.error(
                     "Exception while building %s version %s: %s",
                     language.tag,
-                    version,
+                    version.name,
                     err,
                 )
                 if sentry_sdk: