Skip to content

gh-161415: Remove nonexistent related help topics in pydoc #161417

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

Open
andresdelfino wants to merge 4 commits into
base: main
Choose a base branch
from
+18 −2
Open

gh-161415: Remove nonexistent related help topics in pydoc #161417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7dcb98b
gh-161415: Remove nonexistent related help topics in pydoc
andresdelfino Nov 5, 2026
92a8174
Check related help topics through help() output
andresdelfino Nov 5, 2026
7931892
Merge branch 'main' into gh-161415-pydoc-related-topics
andresdelfino Nov 5, 2026
65767db
Also check the targets of help topic aliases
andresdelfino Nov 7, 2026
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
4 changes: 2 additions & 2 deletions Lib/pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2028,12 +2028,12 @@ class Helper:

topics = {
'TYPES': ('types', 'STRINGS UNICODE NUMBERS SEQUENCES MAPPINGS '
'FUNCTIONS CLASSES MODULES FILES inspect'),
'FUNCTIONS CLASSES MODULES inspect'),
'STRINGS': ('strings', 'str UNICODE SEQUENCES STRINGMETHODS '
'FORMATTING TYPES'),
'STRINGMETHODS': ('string-methods', 'STRINGS FORMATTING'),
'FORMATTING': ('formatstrings', 'OPERATORS'),
'UNICODE': ('strings', 'encodings unicode SEQUENCES STRINGMETHODS '
'UNICODE': ('strings', 'encodings SEQUENCES STRINGMETHODS '
'FORMATTING TYPES'),
'NUMBERS': ('numbers', 'INTEGER FLOAT COMPLEX TYPES'),
'INTEGER': ('integers', 'int range'),
Expand Down
13 changes: 13 additions & 0 deletions Lib/test/test_pydoc/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2294,6 +2294,19 @@ def test_keywords(self):
self.assertEqual(sorted(pydoc.Helper.keywords),
sorted(keyword.kwlist + ['case', 'match', 'lazy']))

def test_related_topics(self):
# Every related help topic and alias must be something help() can
# document.
for name, target in (*pydoc.Helper.topics.items(),
*pydoc.Helper.keywords.items()):
if isinstance(target, str):
target = ('', target)
for xref in target[1].split():
with self.subTest(topic=name, xref=xref):
Comment thread
sobolevn marked this conversation as resolved.
Resolved
buf = StringIO()
pydoc.Helper(output=buf).help(xref)
self.assertNotIn('No help entry found', buf.getvalue())

def test_symbols(self):
# gh-161414
for symbol in pydoc.Helper.symbols:
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2026-11-05-12-00-24.gh-issue-161415.NJhrAR.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Remove ``FILES`` and ``unicode`` from the related help topics listed by
:func:`help` for the ``TYPES`` and ``UNICODE`` topics. Neither exists in
Python 3, so asking for help on them failed.
Loading