Skip to content

GH-121970: Extract pydoc_topics into a new extension #129116

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.

Sign up for GitHub

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
AA-Turner merged 8 commits into from
Jan 21, 2025
Merged

GH-121970: Extract pydoc_topics into a new extension #129116

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
192eac8
Extract ``pydoc_topics`` into a new extension
AA-Turner Jan 21, 2025
d44ad65
Initial refactor (format, lint, type annotations, pathlib)
AA-Turner Jan 21, 2025
c78578b
Second stage refactor
AA-Turner Jan 21, 2025
fe0a5dc
Third stage refactor (use TextTranslator directly)
AA-Turner Jan 21, 2025
371755d
Fourth stage refactor (aggregate documents)
AA-Turner Jan 21, 2025
e27c60a
double quotes
AA-Turner Jan 21, 2025
1d278ae
Use a triple single quote representation
AA-Turner Jan 21, 2025
5ac0ac4
Update ``Lib/pydoc_data/topics.py``
AA-Turner Jan 21, 2025
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
Prev Previous commit
Next Next commit
Use a triple single quote representation
  • Loading branch information
@AA-Turner
AA-Turner committed Jan 21, 2025
commit 1d278ae35abbb2b0d7bd559bc1027858a6b5bff7
17 changes: 15 additions & 2 deletions Doc/tools/extensions/pydoc_topics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

from __future__ import annotations

from pprint import pformat
from time import asctime
from typing import TYPE_CHECKING

Expand Down Expand Up @@ -147,11 +146,17 @@ def write_documents(self, _docnames: Set[str]) -> None:
self.topics[topic_label] = visitor.body

def finish(self) -> None:
topics_repr = "\n".join(
f" '{topic}': {_repr(self.topics[topic])},"
for topic in sorted(self.topics)
)
topics = f"""\
# Autogenerated by Sphinx on {asctime()}
# as part of the release process.

topics = {pformat(dict(sorted(self.topics.items())))}
topics = {{
{topics_repr}
}}
"""
self.outdir.joinpath("topics.py").write_text(topics, encoding="utf-8")

Expand All @@ -164,6 +169,14 @@ def _display_labels(item: tuple[str, Sequence[tuple[str, str]]]) -> str:
return ", ".join(labels)


def _repr(text: str, /) -> str:
"""Return a triple-single-quoted representation of text."""
if "'''" not in text:
return f"r'''{text}'''"
text = text.replace("\\", "\\\\").replace("'''", r"\'\'\'")
return f"'''{text}'''"


def setup(app: Sphinx) -> ExtensionMetadata:
app.add_builder(PydocTopicsBuilder)

Expand Down