IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8338 from mgeier/autodoc-slots-str

Browse Source 
autodoc: check whether __slots__ is a str
This commit is contained in:
Takeshi KOMIYA 2020-10-25 18:58:07 +09:00 committed by GitHub
commit 9188cba1c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
sphinx/ext/autodoc/importer.py
View File

@ -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: if isclass(subject) and getattr(subject, '__slots__', None) is not None:
from sphinx.ext.autodoc import SLOTSATTR 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) members[name] = Attribute(name, True, SLOTSATTR)
# other members # other members

4
tests/roots/test-ext-autodoc/target/slots.py
View File

@ -2,6 +2,10 @@ class Foo:
__slots__ = ['attr'] __slots__ = ['attr']
class FooSingleString:
__slots__ = 'attr'
class Bar: class Bar:
__slots__ = {'attr1': 'docstring of attr1', __slots__ = {'attr1': 'docstring of attr1',
'attr2': 'docstring of attr2', 'attr2': 'docstring of attr2',

8
tests/test_ext_autodoc.py
View File

@ -1205,6 +1205,14 @@ def test_slots(app):
' .. py:attribute:: Foo.attr', ' .. py:attribute:: Foo.attr',
' :module: target.slots', ' :module: target.slots',
'', '',
'',
'.. py:class:: FooSingleString()',
' :module: target.slots',
'',
'',
' .. py:attribute:: FooSingleString.attr',
' :module: target.slots',
'',
] ]