Skip to content

bpo-35614: Fix pydoc help() on metaclasses #11357

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
ncoghlan merged 1 commit into from
Dec 31, 2018
Merged

bpo-35614: Fix pydoc help() on metaclasses #11357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Lib/pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1255,7 +1255,7 @@ def makename(c, m=object.__module__):

# List the built-in subclasses, if any:
subclasses = sorted(
(str(cls.__name__) for cls in object.__subclasses__()
(str(cls.__name__) for cls in type.__subclasses__(object)
if not cls.__name__.startswith("_") and cls.__module__ == "builtins"),
key=str.lower
)
Expand Down
11 changes: 11 additions & 0 deletions Lib/test/test_pydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -636,6 +636,17 @@ class ZeroDivisionError(ArithmeticError)
# Testing that the subclasses section does not appear
self.assertNotIn('Built-in subclasses', text)

def test_builtin_on_metaclasses(self):
"""Tests help on metaclasses.

When running help() on a metaclasses such as type, it
should not contain any "Built-in subclasses" section.
"""
doc = pydoc.TextDoc()
text = doc.docclass(type)
# Testing that the subclasses section does not appear
self.assertNotIn('Built-in subclasses', text)

@unittest.skipIf(sys.flags.optimize >= 2,
'Docstrings are omitted with -O2 and above')
@unittest.skipIf(hasattr(sys, 'gettrace') and sys.gettrace(),
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Library/2018-12-30-01-10-50.bpo-35614.cnkM4f.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed help() on metaclasses. Patch by Sanyam Khurana.