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

autodoc: check whether __slots__ is a str
sphinx-doc · Oct 25, 2020 · 9188cba · 9188cba
2 parents 746842f + 82c83ed
commit 9188cba
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/sphinx/ext/autodoc/importer.py b/sphinx/ext/autodoc/importer.py
@@ -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

diff --git a/tests/roots/test-ext-autodoc/target/slots.py b/tests/roots/test-ext-autodoc/target/slots.py
@@ -2,6 +2,10 @@ class Foo:
     __slots__ = ['attr']
 
 
+class FooSingleString:
+    __slots__ = 'attr'
+
+
 class Bar:
     __slots__ = {'attr1': 'docstring of attr1',
                  'attr2': 'docstring of attr2',

diff --git a/tests/test_ext_autodoc.py b/tests/test_ext_autodoc.py
@@ -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',
+        '',
     ]