summaryrefslogtreecommitdiffstats
path: root/tests/test_extensions/test_ext_viewcode.py
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_extensions/test_ext_viewcode.py')
-rw-r--r--tests/test_extensions/test_ext_viewcode.py137
1 files changed, 137 insertions, 0 deletions
diff --git a/tests/test_extensions/test_ext_viewcode.py b/tests/test_extensions/test_ext_viewcode.py
new file mode 100644
index 0000000..b2c6fc0
--- /dev/null
+++ b/tests/test_extensions/test_ext_viewcode.py
@@ -0,0 +1,137 @@
+"""Test sphinx.ext.viewcode extension."""
+
+import re
+import shutil
+
+import pytest
+
+
+def check_viewcode_output(app, warning):
+ warnings = re.sub(r'\\+', '/', warning.getvalue())
+ assert re.findall(
+ r"index.rst:\d+: WARNING: Object named 'func1' not found in include " +
+ r"file .*/spam/__init__.py'",
+ warnings,
+ )
+
+ result = (app.outdir / 'index.html').read_text(encoding='utf8')
+ assert result.count('href="_modules/spam/mod1.html#func1"') == 2
+ assert result.count('href="_modules/spam/mod2.html#func2"') == 2
+ assert result.count('href="_modules/spam/mod1.html#Class1"') == 2
+ assert result.count('href="_modules/spam/mod2.html#Class2"') == 2
+ assert result.count('@decorator') == 1
+
+ # test that the class attribute is correctly documented
+ assert result.count('this is Class3') == 2
+ assert 'this is the class attribute class_attr' in result
+ # the next assert fails, until the autodoc bug gets fixed
+ assert result.count('this is the class attribute class_attr') == 2
+
+ result = (app.outdir / '_modules/spam/mod1.html').read_text(encoding='utf8')
+ result = re.sub('<span class="[^"]{,2}">', '<span>', result) # filter pygments classes
+ assert ('<div class="viewcode-block" id="Class1">\n'
+ '<a class="viewcode-back" href="../../index.html#spam.Class1">[docs]</a>\n') in result
+ assert '<span>@decorator</span>\n' in result
+ assert '<span>class</span> <span>Class1</span><span>:</span>\n' in result
+ assert '<span> </span><span>&quot;&quot;&quot;</span>\n' in result
+ assert '<span> this is Class1</span>\n' in result
+ assert '<span> &quot;&quot;&quot;</span>\n' in result
+
+ return result
+
+
+@pytest.mark.sphinx(testroot='ext-viewcode', freshenv=True,
+ confoverrides={"viewcode_line_numbers": True})
+def test_viewcode_linenos(app, warning):
+ shutil.rmtree(app.outdir / '_modules', ignore_errors=True)
+ app.build(force_all=True)
+
+ result = check_viewcode_output(app, warning)
+ assert '<span class="linenos"> 1</span>' in result
+
+
+@pytest.mark.sphinx(testroot='ext-viewcode', freshenv=True,
+ confoverrides={"viewcode_line_numbers": False})
+def test_viewcode(app, warning):
+ shutil.rmtree(app.outdir / '_modules', ignore_errors=True)
+ app.build(force_all=True)
+
+ result = check_viewcode_output(app, warning)
+ assert 'class="linenos">' not in result
+
+
+@pytest.mark.sphinx('epub', testroot='ext-viewcode')
+def test_viewcode_epub_default(app, status, warning):
+ shutil.rmtree(app.outdir)
+ app.build(force_all=True)
+
+ assert not (app.outdir / '_modules/spam/mod1.xhtml').exists()
+
+ result = (app.outdir / 'index.xhtml').read_text(encoding='utf8')
+ assert result.count('href="_modules/spam/mod1.xhtml#func1"') == 0
+
+
+@pytest.mark.sphinx('epub', testroot='ext-viewcode',
+ confoverrides={'viewcode_enable_epub': True})
+def test_viewcode_epub_enabled(app, status, warning):
+ app.build(force_all=True)
+
+ assert (app.outdir / '_modules/spam/mod1.xhtml').exists()
+
+ result = (app.outdir / 'index.xhtml').read_text(encoding='utf8')
+ assert result.count('href="_modules/spam/mod1.xhtml#func1"') == 2
+
+
+@pytest.mark.sphinx(testroot='ext-viewcode', tags=['test_linkcode'])
+def test_linkcode(app, status, warning):
+ app.build(filenames=[app.srcdir / 'objects.rst'])
+
+ stuff = (app.outdir / 'objects.html').read_text(encoding='utf8')
+
+ assert 'https://foobar/source/foolib.py' in stuff
+ assert 'https://foobar/js/' in stuff
+ assert 'https://foobar/c/' in stuff
+ assert 'https://foobar/cpp/' in stuff
+
+
+@pytest.mark.sphinx(testroot='ext-viewcode-find', freshenv=True)
+def test_local_source_files(app, status, warning):
+ def find_source(app, modname):
+ if modname == 'not_a_package':
+ source = (app.srcdir / 'not_a_package/__init__.py').read_text(encoding='utf8')
+ tags = {
+ 'func1': ('def', 1, 1),
+ 'Class1': ('class', 1, 1),
+ 'not_a_package.submodule.func1': ('def', 1, 1),
+ 'not_a_package.submodule.Class1': ('class', 1, 1),
+ }
+ else:
+ source = (app.srcdir / 'not_a_package/submodule.py').read_text(encoding='utf8')
+ tags = {
+ 'not_a_package.submodule.func1': ('def', 11, 15),
+ 'Class1': ('class', 19, 22),
+ 'not_a_package.submodule.Class1': ('class', 19, 22),
+ 'Class3': ('class', 25, 30),
+ 'not_a_package.submodule.Class3.class_attr': ('other', 29, 29),
+ }
+ return (source, tags)
+
+ app.connect('viewcode-find-source', find_source)
+ app.build(force_all=True)
+
+ warnings = re.sub(r'\\+', '/', warning.getvalue())
+ assert re.findall(
+ r"index.rst:\d+: WARNING: Object named 'func1' not found in include " +
+ r"file .*/not_a_package/__init__.py'",
+ warnings,
+ )
+
+ result = (app.outdir / 'index.html').read_text(encoding='utf8')
+ assert result.count('href="_modules/not_a_package.html#func1"') == 1
+ assert result.count('href="_modules/not_a_package.html#not_a_package.submodule.func1"') == 1
+ assert result.count('href="_modules/not_a_package/submodule.html#Class1"') == 1
+ assert result.count('href="_modules/not_a_package/submodule.html#Class3"') == 1
+ assert result.count('href="_modules/not_a_package/submodule.html#not_a_package.submodule.Class1"') == 1
+
+ assert result.count('href="_modules/not_a_package/submodule.html#not_a_package.submodule.Class3.class_attr"') == 1
+ assert result.count('This is the class attribute class_attr') == 1