--- Doc/Makefile | 8 +-- Doc/conf.py | 16 ++++++- Doc/tools/check-warnings.py | 5 +- Doc/tools/extensions/audit_events.py | 54 +++++++++++++------------- Doc/tools/extensions/availability.py | 15 +++---- Doc/tools/extensions/c_annotations.py | 45 +++++++++++++-------- Doc/tools/extensions/changes.py | 8 +-- Doc/tools/extensions/glossary_search.py | 10 +--- Doc/tools/extensions/implementation_detail.py | 22 +++------- Doc/tools/extensions/issue_role.py | 16 ++----- Doc/tools/extensions/misc_news.py | 14 ++---- Doc/tools/extensions/patchlevel.py | 9 ++-- Doc/tools/extensions/pydoc_topics.py | 22 +++++----- 13 files changed, 126 insertions(+), 118 deletions(-) Index: Python-3.12.10/Doc/Makefile =================================================================== --- Python-3.12.10.orig/Doc/Makefile 2025-04-29 22:11:50.013198738 +0200 +++ Python-3.12.10/Doc/Makefile 2025-04-29 22:11:52.047098026 +0200 @@ -14,15 +14,15 @@ SOURCES = DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py) REQUIREMENTS = requirements.txt -SPHINXERRORHANDLING = --fail-on-warning +SPHINXERRORHANDLING = -W # Internal variables. PAPEROPT_a4 = --define latex_elements.papersize=a4paper PAPEROPT_letter = --define latex_elements.papersize=letterpaper -ALLSPHINXOPTS = --builder $(BUILDER) \ - --doctree-dir build/doctrees \ - --jobs $(JOBS) \ +ALLSPHINXOPTS = -b $(BUILDER) \ + -d build/doctrees \ + -j $(JOBS) \ $(PAPEROPT_$(PAPER)) \ $(SPHINXOPTS) $(SPHINXERRORHANDLING) \ . build/$(BUILDER) $(SOURCES) Index: Python-3.12.10/Doc/conf.py =================================================================== --- Python-3.12.10.orig/Doc/conf.py 2025-04-29 22:11:46.161835452 +0200 +++ Python-3.12.10/Doc/conf.py 2025-04-29 22:11:52.047459667 +0200 @@ -11,6 +11,8 @@ from importlib import import_module from importlib.util import find_spec +from sphinx import version_info + # Make our custom extensions available to Sphinx sys.path.append(os.path.abspath('tools/extensions')) sys.path.append(os.path.abspath('includes')) @@ -87,7 +89,7 @@ # Minimum version of sphinx required # Keep this version in sync with ``Doc/requirements.txt``. -needs_sphinx = '8.2.0' +needs_sphinx = '4.2.0' # Create table of contents entries for domain objects (e.g. functions, classes, # attributes, etc.). Default is True. @@ -342,7 +344,7 @@ # (See .readthedocs.yml and https://docs.readthedocs.io/en/stable/reference/environment-variables.html) is_deployment_preview = os.getenv("READTHEDOCS_VERSION_TYPE") == "external" repository_url = os.getenv("READTHEDOCS_GIT_CLONE_URL", "") -repository_url = repository_url.removesuffix(".git") +repository_url = repository_url[:-len(".git")] html_context = { "is_deployment_preview": is_deployment_preview, "repository_url": repository_url or None, @@ -588,6 +590,16 @@ } extlinks_detect_hardcoded_links = True +if version_info[:2] < (8, 1): + # Sphinx 8.1 has in-built CVE and CWE roles. + extlinks.update({ + "cve": ( + "https://www.cve.org/CVERecord?id=CVE-%s", + "CVE-%s", + ), + "cwe": ("https://cwe.mitre.org/data/definitions/%s.html", "CWE-%s"), + }) + # Options for c_annotations extension # ----------------------------------- Index: Python-3.12.10/Doc/tools/check-warnings.py =================================================================== --- Python-3.12.10.orig/Doc/tools/check-warnings.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/check-warnings.py 2025-04-29 22:11:52.047704324 +0200 @@ -228,7 +228,8 @@ print(filename) for warning in warnings: if filename in warning: - if match := WARNING_PATTERN.fullmatch(warning): + match = WARNING_PATTERN.fullmatch(warning) + if match: print(" {line}: {msg}".format_map(match)) return -1 return 0 @@ -316,7 +317,7 @@ cwd = str(Path.cwd()) + os.path.sep files_with_nits = { - warning.removeprefix(cwd).split(":")[0] + (warning[len(cwd):].split(":")[0] if warning.startswith(cwd) else warning.split(":")[0]) for warning in warnings if "Doc/" in warning } Index: Python-3.12.10/Doc/tools/extensions/audit_events.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/audit_events.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/audit_events.py 2025-04-29 22:11:52.047967558 +0200 @@ -1,9 +1,6 @@ """Support for documenting audit events.""" -from __future__ import annotations - import re -from typing import TYPE_CHECKING from docutils import nodes from sphinx.errors import NoUri @@ -12,12 +9,11 @@ from sphinx.util import logging from sphinx.util.docutils import SphinxDirective -if TYPE_CHECKING: - from collections.abc import Iterator +from typing import Any, List, Tuple - from sphinx.application import Sphinx - from sphinx.builders import Builder - from sphinx.environment import BuildEnvironment +from sphinx.application import Sphinx +from sphinx.builders import Builder +from sphinx.environment import BuildEnvironment logger = logging.getLogger(__name__) @@ -32,16 +28,16 @@ class AuditEvents: def __init__(self) -> None: - self.events: dict[str, list[str]] = {} - self.sources: dict[str, list[tuple[str, str]]] = {} + self.events: dict[str, List[str]] = {} + self.sources: dict[str, List[Tuple[str, str]]] = {} - def __iter__(self) -> Iterator[tuple[str, list[str], tuple[str, str]]]: + def __iter__(self) -> Any: for name, args in self.events.items(): for source in self.sources[name]: yield name, args, source def add_event( - self, name, args: list[str], source: tuple[str, str] + self, name, args: List[str], source: Tuple[str, str] ) -> None: if name in self.events: self._check_args_match(name, args) @@ -49,7 +45,7 @@ self.events[name] = args self.sources.setdefault(name, []).append(source) - def _check_args_match(self, name: str, args: list[str]) -> None: + def _check_args_match(self, name: str, args: List[str]) -> None: current_args = self.events[name] msg = ( f"Mismatched arguments for audit-event {name}: " @@ -60,7 +56,7 @@ if len(current_args) != len(args): logger.warning(msg) return - for a1, a2 in zip(current_args, args, strict=False): + for a1, a2 in zip(current_args, args): if a1 == a2: continue if any(a1 in s and a2 in s for s in _SYNONYMS): @@ -73,7 +69,7 @@ name_clean = re.sub(r"\W", "_", name) return f"audit_event_{name_clean}_{source_count}" - def rows(self) -> Iterator[tuple[str, list[str], list[tuple[str, str]]]]: + def rows(self) -> Any: for name in sorted(self.events.keys()): yield name, self.events[name], self.sources[name] @@ -97,7 +93,7 @@ def audit_events_merge( app: Sphinx, env: BuildEnvironment, - docnames: list[str], + docnames: List[str], other: BuildEnvironment, ) -> None: """In Sphinx parallel builds, this merges audit_events from subprocesses.""" @@ -126,14 +122,16 @@ ), ] - def run(self) -> list[nodes.paragraph]: + def run(self) -> List[nodes.paragraph]: + def _no_walrus_op(args): + for arg in args.strip("'\"").split(","): + aarg = arg.strip() + if aarg: + yield aarg + name = self.arguments[0] if len(self.arguments) >= 2 and self.arguments[1]: - args = [ - arg - for argument in self.arguments[1].strip("'\"").split(",") - if (arg := argument.strip()) - ] + args = list(_no_walrus_op(self.arguments[1])) else: args = [] ids = [] @@ -169,7 +167,7 @@ class AuditEventListDirective(SphinxDirective): - def run(self) -> list[audit_event_list]: + def run(self) -> List[audit_event_list]: return [audit_event_list()] @@ -181,7 +179,11 @@ return table = self._make_table(self.app.builder, self.env.docname) - for node in self.document.findall(audit_event_list): + try: + findall = self.document.findall + except AttributeError: + findall = self.document.traverse + for node in findall(audit_event_list): node.replace_self(table) def _make_table(self, builder: Builder, docname: str) -> nodes.table: @@ -217,8 +219,8 @@ builder: Builder, docname: str, name: str, - args: list[str], - sources: list[tuple[str, str]], + args: List[str], + sources: List[Tuple[str, str]], ) -> nodes.row: row = nodes.row() name_node = nodes.paragraph("", nodes.Text(name)) Index: Python-3.12.10/Doc/tools/extensions/availability.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/availability.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/availability.py 2025-04-29 22:11:52.048206976 +0200 @@ -1,8 +1,6 @@ """Support for documenting platform availability""" -from __future__ import annotations - -from typing import TYPE_CHECKING +from typing import Dict, List, TYPE_CHECKING, Union from docutils import nodes from sphinx import addnodes @@ -53,7 +51,7 @@ optional_arguments = 0 final_argument_whitespace = True - def run(self) -> list[nodes.container]: + def run(self) -> List[nodes.container]: title = sphinx_gettext("Availability") refnode = addnodes.pending_xref( title, @@ -77,7 +75,7 @@ return [cnode] - def parse_platforms(self) -> dict[str, str | bool]: + def parse_platforms(self) -> Dict[str, Union[str, bool]]: """Parse platform information from arguments Arguments is a comma-separated string of platforms. A platform may @@ -96,12 +94,13 @@ platform, _, version = arg.partition(" >= ") if platform.startswith("not "): version = False - platform = platform.removeprefix("not ") + platform = platform[len("not "):] elif not version: version = True platforms[platform] = version - if unknown := set(platforms).difference(KNOWN_PLATFORMS): + unknown = set(platforms).difference(KNOWN_PLATFORMS) + if unknown: logger.warning( "Unknown platform%s or syntax '%s' in '.. availability:: %s', " "see %s:KNOWN_PLATFORMS for a set of known platforms.", @@ -114,7 +113,7 @@ return platforms -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app): app.add_directive("availability", Availability) return { Index: Python-3.12.10/Doc/tools/extensions/c_annotations.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/c_annotations.py 2025-04-29 22:11:52.033400629 +0200 +++ Python-3.12.10/Doc/tools/extensions/c_annotations.py 2025-04-29 22:11:52.048411194 +0200 @@ -9,22 +9,18 @@ * Set ``stable_abi_file`` to the path to stable ABI list. """ -from __future__ import annotations - import csv import dataclasses from pathlib import Path -from typing import TYPE_CHECKING +from typing import Any, Dict, List, TYPE_CHECKING, Union from docutils import nodes from docutils.statemachine import StringList -from sphinx import addnodes +from sphinx import addnodes, version_info from sphinx.locale import _ as sphinx_gettext from sphinx.util.docutils import SphinxDirective -if TYPE_CHECKING: - from sphinx.application import Sphinx - from sphinx.util.typing import ExtensionMetadata +from sphinx.application import Sphinx ROLE_TO_OBJECT_TYPE = { "func": "function", @@ -35,20 +31,20 @@ } -@dataclasses.dataclass(slots=True) +@dataclasses.dataclass() class RefCountEntry: # Name of the function. name: str # List of (argument name, type, refcount effect) tuples. # (Currently not used. If it was, a dataclass might work better.) - args: list = dataclasses.field(default_factory=list) + args: List = dataclasses.field(default_factory=list) # Return type of the function. result_type: str = "" # Reference count effect for the return value. - result_refs: int | None = None + result_refs: Union[int, None] = None -@dataclasses.dataclass(frozen=True, slots=True) +@dataclasses.dataclass(frozen=True) class StableABIEntry: # Role of the object. # Source: Each [item_kind] in stable_abi.toml is mapped to a C Domain role. @@ -67,7 +63,7 @@ struct_abi_kind: str -def read_refcount_data(refcount_filename: Path) -> dict[str, RefCountEntry]: +def read_refcount_data(refcount_filename: Path) -> Dict[str, RefCountEntry]: refcount_data = {} refcounts = refcount_filename.read_text(encoding="utf8") for line in refcounts.splitlines(): @@ -103,7 +99,7 @@ return refcount_data -def read_stable_abi_data(stable_abi_file: Path) -> dict[str, StableABIEntry]: +def read_stable_abi_data(stable_abi_file: Path) -> Dict[str, StableABIEntry]: stable_abi_data = {} with open(stable_abi_file, encoding="utf8") as fp: for record in csv.DictReader(fp): @@ -127,11 +123,14 @@ continue if not par[0].get("ids", None): continue - name = par[0]["ids"][0].removeprefix("c.") + name = par[0]["ids"][0] + if name.startswith("c."): + name = name[len("c."):] objtype = par["objtype"] # Stable ABI annotation. - if record := stable_abi_data.get(name): + record = stable_abi_data.get(name) + if record: if ROLE_TO_OBJECT_TYPE[record.role] != objtype: msg = ( f"Object type mismatch in limited API annotation for {name}: " @@ -238,7 +237,7 @@ ) -def _return_value_annotation(result_refs: int | None) -> nodes.emphasis: +def _return_value_annotation(result_refs: Union[int, None]) -> nodes.emphasis: classes = ["refcount"] if result_refs is None: rc = sphinx_gettext("Return value: Always NULL.") @@ -258,7 +257,7 @@ optional_arguments = 0 final_argument_whitespace = True - def run(self) -> list[nodes.Node]: + def run(self) -> List[nodes.Node]: state = self.env.domaindata["c_annotations"] content = [ f"* :c:{record.role}:`{record.name}`" @@ -281,13 +280,23 @@ ) -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: Sphinx) -> Any: app.add_config_value("refcount_file", "", "env", types={str}) app.add_config_value("stable_abi_file", "", "env", types={str}) app.add_directive("limited-api-list", LimitedAPIList) app.connect("builder-inited", init_annotations) app.connect("doctree-read", add_annotations) + if version_info[:2] < (7, 2): + from docutils.parsers.rst import directives + from sphinx.domains.c import CObject + + # monkey-patch C object... + CObject.option_spec.update({ + "no-index-entry": directives.flag, + "no-contents-entry": directives.flag, + }) + return { "version": "1.0", "parallel_read_safe": True, Index: Python-3.12.10/Doc/tools/extensions/changes.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/changes.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/changes.py 2025-04-29 22:11:52.048619113 +0200 @@ -1,7 +1,5 @@ """Support for documenting version of changes, additions, deprecations.""" -from __future__ import annotations - from typing import TYPE_CHECKING from sphinx.domains.changeset import ( @@ -25,7 +23,7 @@ class PyVersionChange(VersionChange): - def run(self) -> list[Node]: + def run(self) -> "list[Node]": # Replace the 'next' special token with the current development version self.arguments[0] = expand_version_arg( self.arguments[0], self.config.release @@ -43,7 +41,7 @@ "Deprecated since version %s, removed in version %s" ) - def run(self) -> list[Node]: + def run(self) -> "list[Node]": # Replace the first two arguments (deprecated version and removed version) # with a single tuple of both versions. version_deprecated = expand_version_arg( @@ -73,7 +71,7 @@ versionlabel_classes[self.name] = "" -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: "Sphinx") -> "ExtensionMetadata": # Override Sphinx's directives with support for 'next' app.add_directive("versionadded", PyVersionChange, override=True) app.add_directive("versionchanged", PyVersionChange, override=True) Index: Python-3.12.10/Doc/tools/extensions/glossary_search.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/glossary_search.py 2025-04-29 22:11:52.033722879 +0200 +++ Python-3.12.10/Doc/tools/extensions/glossary_search.py 2025-04-29 22:11:52.048797629 +0200 @@ -1,18 +1,14 @@ """Feature search results for glossary items prominently.""" -from __future__ import annotations - import json from pathlib import Path -from typing import TYPE_CHECKING +from typing import Any, TYPE_CHECKING from docutils import nodes from sphinx.addnodes import glossary from sphinx.util import logging -if TYPE_CHECKING: - from sphinx.application import Sphinx - from sphinx.util.typing import ExtensionMetadata +from sphinx.application import Sphinx logger = logging.getLogger(__name__) @@ -60,7 +56,7 @@ dest.write_text(json.dumps(app.env.glossary_terms), encoding='utf-8') -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: Sphinx) -> Any: app.connect('doctree-resolved', process_glossary_nodes) app.connect('build-finished', write_glossary_json) Index: Python-3.12.10/Doc/tools/extensions/implementation_detail.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/implementation_detail.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/implementation_detail.py 2025-04-29 22:48:23.397548211 +0200 @@ -1,17 +1,10 @@ """Support for marking up implementation details.""" -from __future__ import annotations - -from typing import TYPE_CHECKING - from docutils import nodes from sphinx.locale import _ as sphinx_gettext from sphinx.util.docutils import SphinxDirective -if TYPE_CHECKING: - from sphinx.application import Sphinx - from sphinx.util.typing import ExtensionMetadata - +from sphinx.application import Sphinx class ImplementationDetail(SphinxDirective): has_content = True @@ -21,23 +14,24 @@ label_text = sphinx_gettext("CPython implementation detail:") def run(self): - self.assert_has_content() - content_nodes = self.parse_content_to_nodes() + container_node = nodes.container() + container_node.document = self.state.document # Ensure node has document context + self.state.nested_parse(self.content, self.content_offset, container_node) + parsed_nodes = container_node.children # insert our prefix at the start of the first paragraph - first_node = content_nodes[0] + first_node = parsed_nodes[0] first_node[:0] = [ nodes.strong(self.label_text, self.label_text), nodes.Text(" "), ] - # create a new compound container node - cnode = nodes.compound("", *content_nodes, classes=["impl-detail"]) + cnode = nodes.compound("", *parsed_nodes, classes=["impl-detail"]) self.set_source_info(cnode) return [cnode] -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: Sphinx): app.add_directive("impl-detail", ImplementationDetail) return { Index: Python-3.12.10/Doc/tools/extensions/issue_role.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/issue_role.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/issue_role.py 2025-04-29 22:21:55.278961032 +0200 @@ -1,22 +1,18 @@ """Support for referencing issues in the tracker.""" -from __future__ import annotations - -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, List, Tuple from docutils import nodes from sphinx.util.docutils import SphinxRole -if TYPE_CHECKING: - from docutils.nodes import Element - from sphinx.application import Sphinx - from sphinx.util.typing import ExtensionMetadata +from docutils.nodes import Element +from sphinx.application import Sphinx class BPOIssue(SphinxRole): ISSUE_URI = "https://bugs.python.org/issue?@action=redirect&bpo={0}" - def run(self) -> tuple[list[Element], list[nodes.system_message]]: + def run(self) -> Tuple[List[Element], List[nodes.system_message]]: issue = self.text # sanity check: there are no bpo issues within these two values @@ -38,7 +34,7 @@ class GitHubIssue(SphinxRole): ISSUE_URI = "https://github.com/python/cpython/issues/{0}" - def run(self) -> tuple[list[Element], list[nodes.system_message]]: + def run(self) -> Tuple[List[Element], List[nodes.system_message]]: issue = self.text # sanity check: all GitHub issues have ID >= 32426 @@ -58,7 +54,7 @@ return [refnode], [] -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: Sphinx) -> "ExtensionMetadata": app.add_role("issue", BPOIssue()) app.add_role("gh", GitHubIssue()) Index: Python-3.12.10/Doc/tools/extensions/misc_news.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/misc_news.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/misc_news.py 2025-04-29 22:11:52.049046825 +0200 @@ -1,7 +1,5 @@ """Support for including Misc/NEWS.""" -from __future__ import annotations - import re from pathlib import Path from typing import TYPE_CHECKING @@ -24,13 +22,13 @@ +++++++++++ """ -bpo_issue_re: Final[re.Pattern[str]] = re.compile( +bpo_issue_re: "Final[re.Pattern[str]]" = re.compile( "(?:issue #|bpo-)([0-9]+)", re.ASCII ) -gh_issue_re: Final[re.Pattern[str]] = re.compile( +gh_issue_re: "Final[re.Pattern[str]]" = re.compile( "gh-(?:issue-)?([0-9]+)", re.ASCII | re.IGNORECASE ) -whatsnew_re: Final[re.Pattern[str]] = re.compile( +whatsnew_re: "Final[re.Pattern[str]]" = re.compile( r"^what's new in (.*?)\??$", re.ASCII | re.IGNORECASE | re.MULTILINE ) @@ -42,7 +40,7 @@ final_argument_whitespace = False option_spec = {} - def run(self) -> list[Node]: + def run(self) -> "list[Node]": # Get content of NEWS file source, _ = self.get_source_info() news_file = Path(source).resolve().parent / self.arguments[0] @@ -54,7 +52,7 @@ return [nodes.strong(text, text)] # remove first 3 lines as they are the main heading - news_text = news_text.removeprefix(BLURB_HEADER) + news_text = news_text[len(BLURB_HEADER):] if news_text.startswith(BLURB_HEADER) else news_text news_text = bpo_issue_re.sub(r":issue:`\1`", news_text) # Fallback handling for GitHub issues @@ -65,7 +63,7 @@ return [] -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: "Sphinx") -> "ExtensionMetadata": app.add_directive("miscnews", MiscNews) return { Index: Python-3.12.10/Doc/tools/extensions/patchlevel.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/patchlevel.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/patchlevel.py 2025-04-29 22:11:52.049253068 +0200 @@ -3,7 +3,7 @@ import re import sys from pathlib import Path -from typing import Literal, NamedTuple +from typing import NamedTuple, Tuple CPYTHON_ROOT = Path( __file__, # cpython/Doc/tools/extensions/patchlevel.py @@ -26,7 +26,7 @@ major: int #: Major release number minor: int #: Minor release number micro: int #: Patch release number - releaselevel: Literal["alpha", "beta", "candidate", "final"] + releaselevel: str serial: int #: Serial release number @@ -37,7 +37,8 @@ defines = {} patchlevel_h = PATCHLEVEL_H.read_text(encoding="utf-8") for line in patchlevel_h.splitlines(): - if (m := pat.match(line)) is not None: + m = pat.match(line) + if m is not None: name, value = m.groups() defines[name] = value @@ -50,7 +51,7 @@ ) -def format_version_info(info: version_info) -> tuple[str, str]: +def format_version_info(info: version_info) -> Tuple[str, str]: version = f"{info.major}.{info.minor}" release = f"{info.major}.{info.minor}.{info.micro}" if info.releaselevel != "final": Index: Python-3.12.10/Doc/tools/extensions/pydoc_topics.py =================================================================== --- Python-3.12.10.orig/Doc/tools/extensions/pydoc_topics.py 2025-04-08 13:35:47.000000000 +0200 +++ Python-3.12.10/Doc/tools/extensions/pydoc_topics.py 2025-04-29 22:33:59.916893510 +0200 @@ -1,21 +1,23 @@ """Support for building "topic help" for pydoc.""" -from __future__ import annotations - from time import asctime -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Tuple from sphinx.builders.text import TextBuilder from sphinx.util import logging -from sphinx.util.display import status_iterator +try: + from sphinx.util.display import status_iterator +except ModuleNotFoundError: + from sphinx.util import status_iterator from sphinx.util.docutils import new_document from sphinx.writers.text import TextTranslator -if TYPE_CHECKING: +try: + from typing import Sequence, Set +except ModuleNotFoundError: from collections.abc import Sequence, Set - from sphinx.application import Sphinx - from sphinx.util.typing import ExtensionMetadata +from sphinx.application import Sphinx logger = logging.getLogger(__name__) @@ -161,7 +163,7 @@ self.outdir.joinpath("topics.py").write_text(topics, encoding="utf-8") -def _display_labels(item: tuple[str, Sequence[tuple[str, str]]]) -> str: +def _display_labels(item: Tuple[str, Sequence[Tuple[str, str]]]) -> str: _docname, label_ids = item labels = [name for name, _id in label_ids] if len(labels) > 4: @@ -169,7 +171,7 @@ return ", ".join(labels) -def _repr(text: str, /) -> str: +def _repr(text: str) -> str: """Return a triple-single-quoted representation of text.""" if "'''" not in text: return f"r'''{text}'''" @@ -177,7 +179,7 @@ return f"'''{text}'''" -def setup(app: Sphinx) -> ExtensionMetadata: +def setup(app: Sphinx) -> "ExtensionMetadata": app.add_builder(PydocTopicsBuilder) return {