Complete test suite overhaul.

* rename a few test modules to make the names more consistent * do not copy/use Sphinx from build/ (unnecessary without 2to3) * use a temporary dir for *all* test projects, the source tree will stay pristine that way (default is tests/build) * speed up tests by ~3x by splitting up test projects and avoiding rebuilds
2026-09-03 20:52:55 -05:00 · 2014-09-21 17:17:02 +02:00
parent c5dfd5c732
commit d47a7587f9
83 changed files with 1476 additions and 1757 deletions
@@ -0,0 +1,97 @@
+# -*- coding: utf-8 -*-
+"""
+    test_autosummary
+    ~~~~~~~~~~~~~~~~
+
+    Test the autosummary extension.
+
+    :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+from six import iteritems, StringIO
+
+from sphinx.ext.autosummary import mangle_signature
+
+from util import with_app
+
+html_warnfile = StringIO()
+
+
+default_kw = {
+    'testroot': 'autosummary',
+    'confoverrides': {
+        'extensions': ['sphinx.ext.autosummary'],
+        'autosummary_generate': True,
+        'source_suffix': '.rst'
+    }
+}
+
+
+def test_mangle_signature():
+    TEST = """
+    () :: ()
+    (a, b, c, d, e) :: (a, b, c, d, e)
+    (a, b, c=1, d=2, e=3) :: (a, b[, c, d, e])
+    (a, b, aaa=1, bbb=1, ccc=1, eee=1, fff=1, ggg=1, hhh=1, iii=1, jjj=1)\
+    :: (a, b[, aaa, bbb, ccc, ...])
+    (a, b, c=(), d=<foo>) :: (a, b[, c, d])
+    (a, b, c='foobar()', d=123) :: (a, b[, c, d])
+    (a, b[, c]) :: (a, b[, c])
+    (a, b[, cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx]) :: (a, b[, ...)
+    (a, b='c=d, e=f, g=h', c=3) :: (a[, b, c])
+    (a, b='c=d, \\'e=f,\\' g=h', c=3) :: (a[, b, c])
+    (a, b='c=d, ', e='\\\\' g=h, c=3) :: (a[, b, e, c])
+    (a, b={'c=d, ': 3, '\\\\': 3}) :: (a[, b])
+    (a=1, b=2, c=3) :: ([a, b, c])
+    (a=1, b=<SomeClass: a, b, c>, c=3) :: ([a, b, c])
+    """
+
+    TEST = [[y.strip() for y in x.split("::")] for x in TEST.split("\n")
+            if '::' in x]
+    for inp, outp in TEST:
+        res = mangle_signature(inp).strip().replace(u"\u00a0", " ")
+        assert res == outp, (u"'%s' -> '%s' != '%s'" % (inp, res, outp))
+
+
+@with_app(buildername='html', **default_kw)
+def test_get_items_summary(app, status, warning):
+    # monkey-patch Autosummary.get_items so we can easily get access to it's
+    # results..
+    import sphinx.ext.autosummary
+    orig_get_items = sphinx.ext.autosummary.Autosummary.get_items
+
+    autosummary_items = {}
+
+    def new_get_items(self, names, *args, **kwargs):
+        results = orig_get_items(self, names, *args, **kwargs)
+        for name, result in zip(names, results):
+            autosummary_items[name] = result
+        return results
+
+    def handler(app, what, name, obj, options, lines):
+        assert isinstance(lines, list)
+    app.connect('autodoc-process-docstring', handler)
+
+    sphinx.ext.autosummary.Autosummary.get_items = new_get_items
+    try:
+        app.builder.build_all()
+    finally:
+        sphinx.ext.autosummary.Autosummary.get_items = orig_get_items
+
+    html_warnings = warning.getvalue()
+    assert html_warnings == ''
+
+    expected_values = {
+        'withSentence': 'I have a sentence which spans multiple lines.',
+        'noSentence': "this doesn't start with a",
+        'emptyLine': "This is the real summary",
+        'module_attr': 'This is a module attribute',
+        'C.class_attr': 'This is a class attribute',
+        'C.prop_attr1': 'This is a function docstring',
+        'C.prop_attr2': 'This is a attribute docstring',
+        'C.C2': 'This is a nested inner class docstring',
+    }
+    for key, expected in iteritems(expected_values):
+        assert autosummary_items[key][2] == expected, 'Summary for %s was %r -'\
+            ' expected %r' % (key, autosummary_items[key], expected)