Skip to content

Improve type annotations for versions and languages #253

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 11, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions build_docs.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
import sys
from argparse import ArgumentParser, Namespace
from bisect import bisect_left as bisect
from collections.abc import Iterable, Sequence
from contextlib import contextmanager, suppress
from dataclasses import dataclass
from datetime import datetime as dt, timezone
Expand All @@ -42,14 +41,21 @@
from pathlib import Path
from string import Template
from time import perf_counter, sleep
from typing import Literal
from urllib.parse import urljoin

import jinja2
import tomlkit
import urllib3
import zc.lockfile

TYPE_CHECKING = False
if TYPE_CHECKING:
from collections.abc import Sequence
from typing import Literal, TypeAlias

Versions: TypeAlias = Sequence["Version"]
Languages: TypeAlias = Sequence["Language"]

try:
from os import EX_OK, EX_SOFTWARE as EX_FAILURE
except ImportError:
Expand Down Expand Up @@ -170,7 +176,7 @@ def picker_label(self):
return f"pre ({self.name})"
return self.name

def setup_indexsidebar(self, versions: Sequence[Version], dest_path: Path):
def setup_indexsidebar(self, versions: Versions, dest_path: Path):
"""Build indexsidebar.html for Sphinx."""
template_path = HERE / "templates" / "indexsidebar.html"
template = jinja2.Template(template_path.read_text(encoding="UTF-8"))
Expand Down Expand Up @@ -388,9 +394,7 @@ def edit(file: Path):
temporary.rename(file)


def setup_switchers(
versions: Sequence[Version], languages: Sequence[Language], html_root: Path
):
def setup_switchers(versions: Versions, languages: Languages, html_root: Path):
"""Setup cross-links between CPython versions:
- Cross-link various languages in a language switcher
- Cross-link various versions in a version switcher
Expand Down Expand Up @@ -462,9 +466,9 @@ class DocBuilder:
"""Builder for a CPython version and a language."""

version: Version
versions: Sequence[Version]
versions: Versions
language: Language
languages: Sequence[Language]
languages: Languages
cpython_repo: Repository
build_root: Path
www_root: Path
Expand Down Expand Up @@ -1070,7 +1074,7 @@ def build_docs(args) -> bool:
return all_built_successfully


def parse_versions_from_devguide(http: urllib3.PoolManager) -> list[Version]:
def parse_versions_from_devguide(http: urllib3.PoolManager) -> Versions:
releases = http.request(
"GET",
"https://raw.githubusercontent.com/"
Expand All @@ -1082,7 +1086,7 @@ def parse_versions_from_devguide(http: urllib3.PoolManager) -> list[Version]:
return versions


def parse_languages_from_config() -> list[Language]:
def parse_languages_from_config() -> Languages:
"""Read config.toml to discover languages to build."""
config = tomlkit.parse((HERE / "config.toml").read_text(encoding="UTF-8"))
defaults = config["defaults"]
Expand All @@ -1103,9 +1107,7 @@ def parse_languages_from_config() -> list[Language]:
]


def build_sitemap(
versions: Iterable[Version], languages: Iterable[Language], www_root: Path, group
):
def build_sitemap(versions: Versions, languages: Languages, www_root: Path, group):
"""Build a sitemap with all live versions and translations."""
if not www_root.exists():
logging.info("Skipping sitemap generation (www root does not even exist).")
Expand Down Expand Up @@ -1155,8 +1157,8 @@ def copy_robots_txt(
def major_symlinks(
www_root: Path,
group: str,
versions: Iterable[Version],
languages: Iterable[Language],
versions: Versions,
languages: Languages,
skip_cache_invalidation: bool,
http: urllib3.PoolManager,
) -> None:
Expand Down