Skip to content
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

Jump to bottom

autodoc: check whether __slots__ is a str #8338

Merged
merged 2 commits into from Oct 25, 2020
Merged

autodoc: check whether __slots__ is a str #8338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da4f091
autodoc: check whether __slots__ is a str
mgeier Oct 24, 2020
82c83ed
autodoc: Add test for single-string __slots__
mgeier Oct 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion sphinx/ext/autodoc/importer.py
View file
Open in desktop
Expand Up @@ -206,7 +206,10 @@ def get_object_members(subject: Any, objpath: List[str], attrgetter: Callable,
if isclass(subject) and getattr(subject, '__slots__', None) is not None:
from sphinx.ext.autodoc import SLOTSATTR

for name in subject.__slots__:
slots = subject.__slots__
if isinstance(slots, str):
slots = [slots]
for name in slots:
members[name] = Attribute(name, True, SLOTSATTR)

# other members
Expand Down
4 changes: 4 additions & 0 deletions tests/roots/test-ext-autodoc/target/slots.py
View file
Open in desktop
Expand Up @@ -2,6 +2,10 @@ class Foo:
__slots__ = ['attr']


class FooSingleString:
__slots__ = 'attr'


class Bar:
__slots__ = {'attr1': 'docstring of attr1',
'attr2': 'docstring of attr2',
Expand Down
8 changes: 8 additions & 0 deletions tests/test_ext_autodoc.py
View file
Open in desktop
Expand Up @@ -1205,6 +1205,14 @@ def test_slots(app):
' .. py:attribute:: Foo.attr',
' :module: target.slots',
'',
'',
'.. py:class:: FooSingleString()',
' :module: target.slots',
'',
'',
' .. py:attribute:: FooSingleString.attr',
' :module: target.slots',
'',
]


Expand Down