Correctly setup extensions

Author: flying-sheep

scanpydoc/__init__.py

@@ -32,16 +32,8 @@ def _setup_sig(fn):
 @_setup_sig
 def setup(app: Sphinx) -> Dict[str, Any]:
     """Set up all included extensions!"""
-    from . import (
-        autosummary_generate_imported,
-        definition_list_typed_field,
-        elegant_typehints,
-        rtd_github_links,
-    )
-
-    autosummary_generate_imported.setup(app)
-    definition_list_typed_field.setup(app)
-    elegant_typehints.setup(app)
-    rtd_github_links.setup(app)
-
+    app.setup_extension("scanpydoc.autosummary_generate_imported")
+    app.setup_extension("scanpydoc.definition_list_typed_field")
+    app.setup_extension("scanpydoc.elegant_typehints")
+    app.setup_extension("scanpydoc.rtd_github_links")
     return metadata

tests/conftest.py

@@ -13,9 +13,12 @@
 
 
 @pytest.fixture
-def app_no_setup(make_app, tmp_path) -> Sphinx:
-    (tmp_path / "conf.py").write_text("")
-    return make_app(srcdir=STP(tmp_path))
+def make_app_no_setup(make_app, tmp_path) -> Callable[[], Sphinx]:
+    def make_app_no_setup() -> Sphinx:
+        (tmp_path / "conf.py").write_text("")
+        return make_app(srcdir=STP(tmp_path))
+
+    return make_app_no_setup
 
 
 @pytest.fixture

tests/test_base.py

@@ -5,7 +5,7 @@
 import scanpydoc
 
 
-def test_all_get_installed(monkeypatch, app_no_setup):
+def test_all_get_installed(monkeypatch, make_app_no_setup):
     setups_seen = set()
     setups_called = {}
     for finder, mod_name, _ in pkgutil.walk_packages(
@@ -15,8 +15,9 @@ def test_all_get_installed(monkeypatch, app_no_setup):
         setups_seen.add(mod_name)
         monkeypatch.setattr(mod, "setup", partial(setups_called.__setitem__, mod_name))
 
-    scanpydoc.setup(app_no_setup)
+    app = make_app_no_setup()
+    app.setup_extension("scanpydoc")
 
     assert setups_called.keys() == setups_seen
     for mod_name, app2 in setups_called.items():
-        assert app_no_setup is app2
+        assert app is app2

tests/test_definition_list_typed_field.py

@@ -1,16 +1,15 @@
 import pytest
 from sphinx.application import Sphinx
 from sphinx.builders.html import StandaloneHTMLBuilder
-from sphinx.writers.html import HTMLTranslator, HTMLWriter
+from sphinx.writers.html import HTMLTranslator
 from sphinx.writers.html5 import HTML5Translator
 
-from scanpydoc import definition_list_typed_field
-
 
 @pytest.fixture
-def app(app_no_setup) -> Sphinx:
-    definition_list_typed_field.setup(app_no_setup)
-    return app_no_setup
+def app(make_app_no_setup) -> Sphinx:
+    app = make_app_no_setup()
+    app.setup_extension("scanpydoc.definition_list_typed_field")
+    return app
 
 
 # Avoid :class: to not get pending_xref. TODO: fix
@@ -31,6 +30,13 @@ def app(app_no_setup) -> Sphinx:
 """
 
 
+def test_apps_separate(app, make_app_no_setup):
+    app_no_setup = make_app_no_setup()
+    assert app is not make_app_no_setup
+    assert "scanpydoc.definition_list_typed_field" in app.extensions
+    assert "scanpydoc.definition_list_typed_field" not in app_no_setup.extensions
+
+
 @pytest.mark.parametrize("code,n", [(params_code, 2), (params_code_single, 1)])
 def test_convert_params(app, parse, code, n):
     # the directive class is PyModuleLevel → PyObject → ObjectDescription
@@ -41,6 +47,7 @@ def test_convert_params(app, parse, code, n):
     # )
 
     doc = parse(app, code)
+    assert doc[1].tagname == "desc"
     assert doc[1]["desctype"] == "function"
     assert doc[1][1].tagname == "desc_content"
     assert doc[1][1][0].tagname == "field_list"

tests/test_elegant_typehints.py

@@ -3,14 +3,14 @@
 import pytest
 from sphinx.application import Sphinx
 
-from scanpydoc import elegant_typehints
 from scanpydoc.elegant_typehints import format_annotation, _format_terse, _format_full
 
 
 @pytest.fixture
-def app(app_no_setup) -> Sphinx:
-    elegant_typehints.setup(app_no_setup)
-    return app_no_setup
+def app(make_app_no_setup) -> Sphinx:
+    app = make_app_no_setup()
+    app.setup_extension("scanpydoc.elegant_typehints")
+    return app
 
 
 def test_default(app):