Merge pull request #7966 from tk0miya/7469_additional_testcase

autosummary: Add testcase for module constants (refs: #7469)
sphinx-doc · Jul 19, 2020 · f30284e · f30284e
2 parents 5850d6b + b6bf2b8
commit f30284e
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 15 deletions.
diff --git a/sphinx/pycode/__init__.py b/sphinx/pycode/__init__.py
@@ -11,6 +11,7 @@
 import re
 import tokenize
 import warnings
+from collections import OrderedDict
 from importlib import import_module
 from inspect import Signature
 from io import StringIO
@@ -156,7 +157,7 @@ def parse(self) -> None:
             parser = Parser(self.code, self._encoding)
             parser.parse()
 
-            self.attr_docs = {}
+            self.attr_docs = OrderedDict()
             for (scope, comment) in parser.comments.items():
                 if comment:
                     self.attr_docs[scope] = comment.splitlines() + ['']

diff --git a/sphinx/pycode/parser.py b/sphinx/pycode/parser.py
@@ -12,6 +12,7 @@
 import re
 import sys
 import tokenize
+from collections import OrderedDict
 from inspect import Signature
 from token import NAME, NEWLINE, INDENT, DEDENT, NUMBER, OP, STRING
 from tokenize import COMMENT, NL
@@ -228,7 +229,7 @@ def __init__(self, buffers: List[str], encoding: str) -> None:
         self.context = []               # type: List[str]
         self.current_classes = []       # type: List[str]
         self.current_function = None    # type: ast.FunctionDef
-        self.comments = {}              # type: Dict[Tuple[str, str], str]
+        self.comments = OrderedDict()   # type: Dict[Tuple[str, str], str]
         self.annotations = {}           # type: Dict[Tuple[str, str], str]
         self.previous = None            # type: ast.AST
         self.deforders = {}             # type: Dict[str, int]

diff --git a/tests/roots/test-ext-autosummary/autosummary_dummy_module.py b/tests/roots/test-ext-autosummary/autosummary_dummy_module.py
@@ -2,7 +2,16 @@
 from typing import Union
 
 
+#: module variable
+CONSTANT1 = None
+CONSTANT2 = None
+
+
 class Foo:
+    #: class variable
+    CONSTANT3 = None
+    CONSTANT4 = None
+
     class Bar:
         pass
 

diff --git a/tests/test_ext_autosummary.py b/tests/test_ext_autosummary.py
@@ -208,17 +208,17 @@ def test_autosummary_generate_content_for_module(app):
     assert template.render.call_args[0][0] == 'module'
 
     context = template.render.call_args[0][1]
-    assert context['members'] == ['Exc', 'Foo', '_Baz', '_Exc', '__builtins__',
-                                  '__cached__', '__doc__', '__file__', '__name__',
-                                  '__package__', '_quux', 'bar', 'qux']
+    assert context['members'] == ['CONSTANT1', 'CONSTANT2', 'Exc', 'Foo', '_Baz', '_Exc',
+                                  '__builtins__', '__cached__', '__doc__', '__file__',
+                                  '__name__', '__package__', '_quux', 'bar', 'qux']
     assert context['functions'] == ['bar']
     assert context['all_functions'] == ['_quux', 'bar']
     assert context['classes'] == ['Foo']
     assert context['all_classes'] == ['Foo', '_Baz']
     assert context['exceptions'] == ['Exc']
     assert context['all_exceptions'] == ['Exc', '_Exc']
-    assert context['attributes'] == ['qux']
-    assert context['all_attributes'] == ['qux']
+    assert context['attributes'] == ['CONSTANT1', 'qux']
+    assert context['all_attributes'] == ['CONSTANT1', 'qux']
     assert context['fullname'] == 'autosummary_dummy_module'
     assert context['module'] == 'autosummary_dummy_module'
     assert context['objname'] == ''
@@ -239,8 +239,9 @@ def skip_member(app, what, name, obj, skip, options):
     generate_autosummary_content('autosummary_dummy_module', autosummary_dummy_module, None,
                                  template, None, False, app, False, {})
     context = template.render.call_args[0][1]
-    assert context['members'] == ['_Baz', '_Exc', '__builtins__', '__cached__', '__doc__',
-                                  '__file__', '__name__', '__package__', '_quux', 'qux']
+    assert context['members'] == ['CONSTANT1', 'CONSTANT2', '_Baz', '_Exc', '__builtins__',
+                                  '__cached__', '__doc__', '__file__', '__name__',
+                                  '__package__', '_quux', 'qux']
     assert context['functions'] == []
     assert context['classes'] == []
     assert context['exceptions'] == []
@@ -256,18 +257,18 @@ def test_autosummary_generate_content_for_module_imported_members(app):
     assert template.render.call_args[0][0] == 'module'
 
     context = template.render.call_args[0][1]
-    assert context['members'] == ['Exc', 'Foo', 'Union', '_Baz', '_Exc', '__builtins__',
-                                  '__cached__', '__doc__', '__file__', '__loader__',
-                                  '__name__', '__package__', '__spec__', '_quux',
-                                  'bar', 'path', 'qux']
+    assert context['members'] == ['CONSTANT1', 'CONSTANT2', 'Exc', 'Foo', 'Union', '_Baz',
+                                  '_Exc', '__builtins__', '__cached__', '__doc__',
+                                  '__file__', '__loader__', '__name__', '__package__',
+                                  '__spec__', '_quux', 'bar', 'path', 'qux']
     assert context['functions'] == ['bar']
     assert context['all_functions'] == ['_quux', 'bar']
     assert context['classes'] == ['Foo']
     assert context['all_classes'] == ['Foo', '_Baz']
     assert context['exceptions'] == ['Exc']
     assert context['all_exceptions'] == ['Exc', '_Exc']
-    assert context['attributes'] == ['qux']
-    assert context['all_attributes'] == ['qux']
+    assert context['attributes'] == ['CONSTANT1', 'qux']
+    assert context['all_attributes'] == ['CONSTANT1', 'qux']
     assert context['fullname'] == 'autosummary_dummy_module'
     assert context['module'] == 'autosummary_dummy_module'
     assert context['objname'] == ''
@@ -307,6 +308,11 @@ def test_autosummary_generate(app, status, warning):
             '   \n'
             '      Foo\n'
             '   \n' in module)
+    assert ('   .. autosummary::\n'
+            '   \n'
+            '      CONSTANT1\n'
+            '      qux\n'
+            '   \n' in module)
 
     Foo = (app.srcdir / 'generated' / 'autosummary_dummy_module.Foo.rst').read_text()
     assert '.. automethod:: __init__' in Foo
@@ -317,6 +323,8 @@ def test_autosummary_generate(app, status, warning):
             '   \n' in Foo)
     assert ('   .. autosummary::\n'
             '   \n'
+            '      ~Foo.CONSTANT3\n'
+            '      ~Foo.CONSTANT4\n'
             '      ~Foo.baz\n'
             '   \n' in Foo)