Format tests/ (#12760)

Author: AA-Turner

tests/conftest.py

@@ -19,7 +19,8 @@
 
 
 def _init_console(
-    locale_dir: str | None = sphinx.locale._LOCALE_DIR, catalog: str = 'sphinx',
+    locale_dir: str | None = sphinx.locale._LOCALE_DIR,
+    catalog: str = 'sphinx',
 ) -> tuple[gettext.NullTranslations, bool]:
     """Monkeypatch ``init_console`` to skip its action.
 
@@ -46,9 +47,9 @@ def rootdir() -> Path:
 
 
 def pytest_report_header(config: pytest.Config) -> str:
-    header = f"libraries: Sphinx-{sphinx.__display_version__}, docutils-{docutils.__version__}"
+    header = f'libraries: Sphinx-{sphinx.__display_version__}, docutils-{docutils.__version__}'
     if hasattr(config, '_tmp_path_factory'):
-        header += f"\nbase tmp_path: {config._tmp_path_factory.getbasetemp()}"
+        header += f'\nbase tmp_path: {config._tmp_path_factory.getbasetemp()}'
     return header
 
 

tests/roots/test-ext-autodoc/target/abstractmethods.py

@@ -1,7 +1,7 @@
 from abc import abstractmethod
 
 
-class Base():
+class Base:
     def meth(self):
         pass
 

tests/roots/test-ext-autodoc/target/callable.py

@@ -1,4 +1,4 @@
-class Callable():
+class Callable:
     """A callable object that behaves like a function."""
 
     def __call__(self, arg1, arg2, **kwargs):

tests/roots/test-ext-autodoc/target/methods.py

@@ -1,7 +1,7 @@
 from functools import partialmethod
 
 
-class Base():
+class Base:
     def meth(self):
         pass
 

tests/roots/test-ext-autosummary/autosummary_class_module.py

@@ -1,2 +1,2 @@
-class Class():
+class Class:
   pass

tests/test_application.py

@@ -1,4 +1,5 @@
 """Test the Sphinx class."""
+
 from __future__ import annotations
 
 import shutil
@@ -51,26 +52,27 @@ def test_instantiation(
 def test_events(app):
     def empty():
         pass
+
     with pytest.raises(ExtensionError) as excinfo:
-        app.connect("invalid", empty)
-    assert "Unknown event name: invalid" in str(excinfo.value)
+        app.connect('invalid', empty)
+    assert 'Unknown event name: invalid' in str(excinfo.value)
 
-    app.add_event("my_event")
+    app.add_event('my_event')
     with pytest.raises(ExtensionError) as excinfo:
-        app.add_event("my_event")
+        app.add_event('my_event')
     assert "Event 'my_event' already present" in str(excinfo.value)
 
     def mock_callback(a_app, *args):
         assert a_app is app
         assert emit_args == args
-        return "ret"
-    emit_args = (1, 3, "string")
-    listener_id = app.connect("my_event", mock_callback)
-    assert app.emit("my_event", *emit_args) == ["ret"], "Callback not called"
+        return 'ret'
+
+    emit_args = (1, 3, 'string')
+    listener_id = app.connect('my_event', mock_callback)
+    assert app.emit('my_event', *emit_args) == ['ret'], 'Callback not called'
 
     app.disconnect(listener_id)
-    assert app.emit("my_event", *emit_args) == [], \
-        "Callback called when disconnected"
+    assert app.emit('my_event', *emit_args) == [], 'Callback called when disconnected'
 
 
 def test_emit_with_nonascii_name_node(app):
@@ -121,14 +123,18 @@ def test_add_is_parallel_allowed(app):
     app.setup_extension('write_parallel')
     assert app.is_parallel_allowed('read') is False
     assert app.is_parallel_allowed('write') is True
-    assert ("the write_parallel extension does not declare if it is safe "
-            "for parallel reading, assuming it isn't - please ") in app.warning.getvalue()
+    assert (
+        'the write_parallel extension does not declare if it is safe '
+        "for parallel reading, assuming it isn't - please "
+    ) in app.warning.getvalue()
     app.extensions.pop('write_parallel')
     app.warning.truncate(0)  # reset warnings
 
     app.setup_extension('read_serial')
     assert app.is_parallel_allowed('read') is False
-    assert "the read_serial extension is not safe for parallel reading" in app.warning.getvalue()
+    assert (
+        'the read_serial extension is not safe for parallel reading'
+    ) in app.warning.getvalue()
     app.warning.truncate(0)  # reset warnings
     assert app.is_parallel_allowed('write') is True
     assert app.warning.getvalue() == ''
@@ -137,26 +143,32 @@ def test_add_is_parallel_allowed(app):
     app.setup_extension('write_serial')
     assert app.is_parallel_allowed('read') is False
     assert app.is_parallel_allowed('write') is False
-    assert ("the write_serial extension does not declare if it is safe "
-            "for parallel reading, assuming it isn't - please ") in app.warning.getvalue()
+    assert (
+        'the write_serial extension does not declare if it is safe '
+        "for parallel reading, assuming it isn't - please "
+    ) in app.warning.getvalue()
     app.extensions.pop('write_serial')
     app.warning.truncate(0)  # reset warnings
 
 
 @pytest.mark.sphinx('dummy', testroot='root')
 def test_build_specific(app):
     app.builder.build = Mock()
-    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
-                 app.srcdir / 'subdir',                         # directory
-                 app.srcdir / 'subdir/includes.txt',            # file on subdir
-                 app.srcdir / 'subdir/../subdir/excluded.txt']  # not normalized
+    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
+        app.srcdir / 'subdir',                         # directory
+        app.srcdir / 'subdir/includes.txt',            # file on subdir
+        app.srcdir / 'subdir/../subdir/excluded.txt',  # not normalized
+    ]  # fmt: skip
     app.build(False, filenames)
 
     expected = ['index', 'subdir/includes', 'subdir/excluded']
-    app.builder.build.assert_called_with(expected,
-                                         method='specific',
-                                         summary='3 source files given on command line')
+    app.builder.build.assert_called_with(
+        expected,
+        method='specific',
+        summary='3 source files given on command line',
+    )

tests/test_builders/test_build.py

@@ -31,67 +31,76 @@ def nonascii_srcdir(request, rootdir, sphinx_test_tempdir):
         shutil.copytree(rootdir / 'test-root', srcdir)
 
     # add a doc with a non-ASCII file name to the source dir
-    (srcdir / (test_name + '.txt')).write_text("""
+    (srcdir / (test_name + '.txt')).write_text(
+        """
 nonascii file name page
 =======================
-""", encoding='utf8')
+""",
+        encoding='utf8',
+    )
 
     root_doc = srcdir / 'index.txt'
-    root_doc.write_text(root_doc.read_text(encoding='utf8') + f"""
+    root_doc.write_text(
+        root_doc.read_text(encoding='utf8')
+        + f"""
 .. toctree::
 
 {test_name}/{test_name}
-""", encoding='utf8')
+""",
+        encoding='utf8',
+    )
     return srcdir
 
 
 # note: this test skips building docs for some builders because they have independent testcase.
 #       (html, changes, epub, latex, texinfo and manpage)
 @pytest.mark.parametrize(
-    "buildername",
+    'buildername',
     ['dirhtml', 'singlehtml', 'text', 'xml', 'pseudoxml', 'linkcheck'],
 )
-@mock.patch('sphinx.builders.linkcheck.requests.head',
-            side_effect=request_session_head)
+@mock.patch(
+    'sphinx.builders.linkcheck.requests.head',
+    side_effect=request_session_head,
+)
 def test_build_all(requests_head, make_app, nonascii_srcdir, buildername):
     app = make_app(buildername, srcdir=nonascii_srcdir)
     app.build()
 
 
 def test_root_doc_not_found(tmp_path, make_app):
-    (tmp_path / 'conf.py').write_text('', encoding='utf8')
+    (tmp_path / 'conf.py').touch()
     assert os.listdir(tmp_path) == ['conf.py']
 
     app = make_app('dummy', srcdir=tmp_path)
     with pytest.raises(SphinxError):
         app.build(force_all=True)  # no index.rst
 
 
-@pytest.mark.sphinx(buildername='text', testroot='circular')
+@pytest.mark.sphinx('text', testroot='circular')
 def test_circular_toctree(app):
     app.build(force_all=True)
     warnings = app.warning.getvalue()
     assert (
-        'circular toctree references detected, ignoring: '
-        'sub <- index <- sub') in warnings
+        'circular toctree references detected, ignoring: sub <- index <- sub'
+    ) in warnings
     assert (
-        'circular toctree references detected, ignoring: '
-        'index <- sub <- index') in warnings
+        'circular toctree references detected, ignoring: index <- sub <- index'
+    ) in warnings
 
 
-@pytest.mark.sphinx(buildername='text', testroot='numbered-circular')
+@pytest.mark.sphinx('text', testroot='numbered-circular')
 def test_numbered_circular_toctree(app):
     app.build(force_all=True)
     warnings = app.warning.getvalue()
     assert (
-        'circular toctree references detected, ignoring: '
-        'sub <- index <- sub') in warnings
+        'circular toctree references detected, ignoring: sub <- index <- sub'
+    ) in warnings
     assert (
-        'circular toctree references detected, ignoring: '
-        'index <- sub <- index') in warnings
+        'circular toctree references detected, ignoring: index <- sub <- index'
+    ) in warnings
 
 
-@pytest.mark.sphinx(buildername='dummy', testroot='images')
+@pytest.mark.sphinx('dummy', testroot='images')
 def test_image_glob(app):
     app.build(force_all=True)
 
@@ -108,16 +117,20 @@ def test_image_glob(app):
     assert doctree[0][2][0]['uri'] == 'rimg.png'
 
     assert isinstance(doctree[0][3], nodes.image)
-    assert doctree[0][3]['candidates'] == {'application/pdf': 'img.pdf',
-                                           'image/gif': 'img.gif',
-                                           'image/png': 'img.png'}
+    assert doctree[0][3]['candidates'] == {
+        'application/pdf': 'img.pdf',
+        'image/gif': 'img.gif',
+        'image/png': 'img.png',
+    }
     assert doctree[0][3]['uri'] == 'img.*'
 
     assert isinstance(doctree[0][4], nodes.figure)
     assert isinstance(doctree[0][4][0], nodes.image)
-    assert doctree[0][4][0]['candidates'] == {'application/pdf': 'img.pdf',
-                                              'image/gif': 'img.gif',
-                                              'image/png': 'img.png'}
+    assert doctree[0][4][0]['candidates'] == {
+        'application/pdf': 'img.pdf',
+        'image/gif': 'img.gif',
+        'image/png': 'img.png',
+    }
     assert doctree[0][4][0]['uri'] == 'img.*'
 
     # subdir/index.rst
@@ -128,14 +141,18 @@ def test_image_glob(app):
     assert doctree[0][1]['uri'] == 'subdir/rimg.png'
 
     assert isinstance(doctree[0][2], nodes.image)
-    assert doctree[0][2]['candidates'] == {'application/pdf': 'subdir/svgimg.pdf',
-                                           'image/svg+xml': 'subdir/svgimg.svg'}
+    assert doctree[0][2]['candidates'] == {
+        'application/pdf': 'subdir/svgimg.pdf',
+        'image/svg+xml': 'subdir/svgimg.svg',
+    }
     assert doctree[0][2]['uri'] == 'subdir/svgimg.*'
 
     assert isinstance(doctree[0][3], nodes.figure)
     assert isinstance(doctree[0][3][0], nodes.image)
-    assert doctree[0][3][0]['candidates'] == {'application/pdf': 'subdir/svgimg.pdf',
-                                              'image/svg+xml': 'subdir/svgimg.svg'}
+    assert doctree[0][3][0]['candidates'] == {
+        'application/pdf': 'subdir/svgimg.pdf',
+        'image/svg+xml': 'subdir/svgimg.svg',
+    }
     assert doctree[0][3][0]['uri'] == 'subdir/svgimg.*'
 
 

tests/test_builders/test_build_changes.py

@@ -15,18 +15,23 @@ def test_build(app):
 
     path_html = (
         '<b>Path</b>: <i>deprecated:</i> Deprecated since version 0.6:'
-        ' So, that was a bad idea it turns out.')
+        ' So, that was a bad idea it turns out.'
+    )
     assert path_html in htmltext
 
     malloc_html = (
         '<b>void *Test_Malloc(size_t n)</b>: <i>changed:</i> Changed in version 0.6:'
-        ' Can now be replaced with a different allocator.</a>')
+        ' Can now be replaced with a different allocator.</a>'
+    )
     assert malloc_html in htmltext
 
 
 @pytest.mark.sphinx(
-    'changes', testroot='changes', srcdir='changes-none',
-    confoverrides={'version': '0.7', 'release': '0.7b1'})
+    'changes',
+    testroot='changes',
+    srcdir='changes-none',
+    confoverrides={'version': '0.7', 'release': '0.7b1'},
+)
 def test_no_changes(app):
     app.build()
 

tests/test_builders/test_build_dirhtml.py

@@ -7,7 +7,7 @@
 from sphinx.util.inventory import InventoryFile
 
 
-@pytest.mark.sphinx(buildername='dirhtml', testroot='builder-dirhtml')
+@pytest.mark.sphinx('dirhtml', testroot='builder-dirhtml')
 def test_dirhtml(app):
     app.build()
 
@@ -31,10 +31,25 @@ def test_dirhtml(app):
     assert invdata['std:doc']['index'] == ('Project name not set', '', 'path/to/', '-')
 
     assert 'foo/index' in invdata.get('std:doc', {})
-    assert invdata['std:doc']['foo/index'] == ('Project name not set', '', 'path/to/foo/', '-')
+    assert invdata['std:doc']['foo/index'] == (
+        'Project name not set',
+        '',
+        'path/to/foo/',
+        '-',
+    )
 
     assert 'index' in invdata.get('std:label', {})
-    assert invdata['std:label']['index'] == ('Project name not set', '', 'path/to/#index', '-')
+    assert invdata['std:label']['index'] == (
+        'Project name not set',
+        '',
+        'path/to/#index',
+        '-',
+    )
 
     assert 'foo' in invdata.get('std:label', {})
-    assert invdata['std:label']['foo'] == ('Project name not set', '', 'path/to/foo/#foo', 'foo/index')
+    assert invdata['std:label']['foo'] == (
+        'Project name not set',
+        '',
+        'path/to/foo/#foo',
+        'foo/index',
+    )