Add annotations to several single-argument ('app') test functions

Author: AA-Turner

tests/test_application.py

@@ -49,7 +49,7 @@ def test_instantiation(
 
 
 @pytest.mark.sphinx('html', testroot='root')
-def test_events(app):
+def test_events(app: SphinxTestApp) -> None:
     def empty():
         pass
 
@@ -76,27 +76,27 @@ def mock_callback(a_app, *args):
 
 
 @pytest.mark.sphinx('html', testroot='root')
-def test_emit_with_nonascii_name_node(app):
+def test_emit_with_nonascii_name_node(app: SphinxTestApp) -> None:
     node = nodes.section(names=['\u65e5\u672c\u8a9e'])
     app.emit('my_event', node)
 
 
 @pytest.mark.sphinx('html', testroot='root')
-def test_extensions(app):
+def test_extensions(app: SphinxTestApp) -> None:
     app.setup_extension('shutil')
     warning = strip_escape_sequences(app.warning.getvalue())
     assert "extension 'shutil' has no setup() function" in warning
 
 
 @pytest.mark.sphinx('html', testroot='root')
-def test_extension_in_blacklist(app):
+def test_extension_in_blacklist(app: SphinxTestApp) -> None:
     app.setup_extension('sphinxjp.themecore')
     msg = strip_escape_sequences(app.warning.getvalue())
     assert msg.startswith("WARNING: the extension 'sphinxjp.themecore' was")
 
 
 @pytest.mark.sphinx('html', testroot='add_source_parser')
-def test_add_source_parser(app):
+def test_add_source_parser(app: SphinxTestApp) -> None:
     assert set(app.config.source_suffix) == {'.rst', '.test'}
 
     # .rst; only in :confval:`source_suffix`
@@ -110,7 +110,7 @@ def test_add_source_parser(app):
 
 
 @pytest.mark.sphinx('html', testroot='extensions')
-def test_add_is_parallel_allowed(app):
+def test_add_is_parallel_allowed(app: SphinxTestApp) -> None:
     logging.setup(app, app.status, app.warning)
 
     assert app.is_parallel_allowed('read') is True
@@ -155,14 +155,14 @@ def test_add_is_parallel_allowed(app):
 
 
 @pytest.mark.sphinx('dummy', testroot='root')
-def test_build_specific(app):
-    app.builder.build = Mock()
+def test_build_specific(app: SphinxTestApp) -> None:
+    app.builder.build = Mock()  # type: ignore[method-assign,misc]
     filenames = [
         app.srcdir / 'index.txt',                      # normal
         app.srcdir / 'images',                         # without suffix
         app.srcdir / 'notfound.txt',                   # not found
         app.srcdir / 'img.png',                        # unknown suffix
-        '/index.txt',                                  # external file
+        Path('/index.txt'),                            # external file
         app.srcdir / 'subdir',                         # directory
         app.srcdir / 'subdir/includes.txt',            # file on subdir
         app.srcdir / 'subdir/../subdir/excluded.txt',  # not normalized

tests/test_builders/test_build.py

@@ -2,11 +2,16 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 import pytest
 from docutils import nodes
 
 from sphinx.errors import SphinxError
 
+if TYPE_CHECKING:
+    from sphinx.testing.util import SphinxTestApp
+
 
 def test_root_doc_not_found(tmp_path, make_app):
     (tmp_path / 'conf.py').touch()
@@ -18,7 +23,7 @@ def test_root_doc_not_found(tmp_path, make_app):
 
 
 @pytest.mark.sphinx('text', testroot='circular')
-def test_circular_toctree(app):
+def test_circular_toctree(app: SphinxTestApp) -> None:
     app.build(force_all=True)
     warnings = app.warning.getvalue()
     assert (
@@ -30,7 +35,7 @@ def test_circular_toctree(app):
 
 
 @pytest.mark.sphinx('text', testroot='numbered-circular')
-def test_numbered_circular_toctree(app):
+def test_numbered_circular_toctree(app: SphinxTestApp) -> None:
     app.build(force_all=True)
     warnings = app.warning.getvalue()
     assert (
@@ -42,7 +47,7 @@ def test_numbered_circular_toctree(app):
 
 
 @pytest.mark.sphinx('text', testroot='toctree-multiple-parents')
-def test_multiple_parents_toctree(app):
+def test_multiple_parents_toctree(app: SphinxTestApp) -> None:
     app.build(force_all=True)
     assert (
         "document is referenced in multiple toctrees: ['bravo', 'delta'], selecting: delta <- charlie"

tests/test_builders/test_build_all.py

@@ -12,6 +12,8 @@
 
 import pytest
 
+from sphinx.testing.util import SphinxTestApp
+
 if TYPE_CHECKING:
     from collections.abc import Callable
     from pathlib import Path

tests/test_builders/test_build_changes.py

@@ -2,11 +2,16 @@
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING
+
 import pytest
 
+if TYPE_CHECKING:
+    from sphinx.testing.util import SphinxTestApp
+
 
 @pytest.mark.sphinx('changes', testroot='changes')
-def test_build(app):
+def test_build(app: SphinxTestApp) -> None:
     app.build()
 
     # TODO: Use better checking of html content
@@ -34,7 +39,7 @@ def test_build(app):
     srcdir='changes-none',
     confoverrides={'version': '0.7', 'release': '0.7b1'},
 )
-def test_no_changes(app):
+def test_no_changes(app: SphinxTestApp) -> None:
     app.build()
 
     assert 'no changes in version 0.7.' in app.status.getvalue()

tests/test_builders/test_build_dirhtml.py

@@ -3,14 +3,18 @@
 from __future__ import annotations
 
 import posixpath
+from typing import TYPE_CHECKING
 
 import pytest
 
 from sphinx.util.inventory import InventoryFile, _InventoryItem
 
+if TYPE_CHECKING:
+    from sphinx.testing.util import SphinxTestApp
+
 
 @pytest.mark.sphinx('dirhtml', testroot='builder-dirhtml')
-def test_dirhtml(app):
+def test_dirhtml(app: SphinxTestApp) -> None:
     app.build()
 
     assert (app.outdir / 'index.html').exists()

tests/test_builders/test_build_epub.py

@@ -12,6 +12,7 @@
 import pytest
 
 from sphinx.builders.epub3 import _XML_NAME_PATTERN
+from sphinx.testing.util import SphinxTestApp
 
 if TYPE_CHECKING:
     from collections.abc import Iterator

tests/test_builders/test_build_gettext.py

@@ -13,6 +13,7 @@
 import pytest
 
 from sphinx.builders.gettext import Catalog, MsgOrigin
+from sphinx.testing.util import SphinxTestApp
 
 if TYPE_CHECKING:
     from sphinx.testing.util import SphinxTestApp