Skip to content

shrink mypy whitelist for 'tests.test_directives.test_directive_other' module #14244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danieleades wants to merge 1 commit into
base: master
Choose a base branch
from
Open

shrink mypy whitelist for 'tests.test_directives.test_directive_other' module #14244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,6 @@ module = [
"tests.test_search",
# tests/test_config
"tests.test_config.test_config",
# tests/test_directives
"tests.test_directives.test_directive_other",
# tests/test_domains
"tests.test_domains.test_domain_c",
"tests.test_domains.test_domain_cpp",
Expand Down
29 changes: 17 additions & 12 deletions tests/test_directives/test_directive_other.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,12 @@
from tests.utils import extract_node

if TYPE_CHECKING:
from sphinx.application import Sphinx
from sphinx.testing.util import SphinxTestApp


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_toctree(app):
def test_toctree(app: SphinxTestApp) -> None:
text = '.. toctree::\n\n foo\n bar/index\n baz\n'

app.env.find_files(app.config, app.builder)
Expand All @@ -33,7 +34,7 @@ def test_toctree(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_relative_toctree(app):
def test_relative_toctree(app: SphinxTestApp) -> None:
text = '.. toctree::\n\n bar_1\n bar_2\n bar_3\n ../quux\n'

app.env.find_files(app.config, app.builder)
Expand All @@ -52,7 +53,7 @@ def test_relative_toctree(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_toctree_urls_and_titles(app):
def test_toctree_urls_and_titles(app: SphinxTestApp) -> None:
text = (
'.. toctree::\n'
'\n'
Expand All @@ -76,7 +77,7 @@ def test_toctree_urls_and_titles(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_toctree_glob(app):
def test_toctree_glob(app: SphinxTestApp) -> None:
text = '.. toctree::\n :glob:\n\n *\n'

app.env.find_files(app.config, app.builder)
Expand Down Expand Up @@ -114,7 +115,7 @@ def test_toctree_glob(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_toctree_glob_and_url(app):
def test_toctree_glob_and_url(app: SphinxTestApp) -> None:
text = '.. toctree::\n :glob:\n\n https://example.com/?q=sphinx\n'

app.env.find_files(app.config, app.builder)
Expand All @@ -128,7 +129,7 @@ def test_toctree_glob_and_url(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_reversed_toctree(app):
def test_reversed_toctree(app: SphinxTestApp) -> None:
text = '.. toctree::\n :reversed:\n\n foo\n bar/index\n baz\n'

app.env.find_files(app.config, app.builder)
Expand All @@ -142,7 +143,7 @@ def test_reversed_toctree(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_toctree_class(app):
def test_toctree_class(app: SphinxTestApp) -> None:
text = '.. toctree::\n :class: custom-toc\n\n foo\n'
app.env.find_files(app.config, app.builder)
doctree = restructuredtext.parse(app, text, 'index')
Expand All @@ -152,7 +153,7 @@ def test_toctree_class(app):


@pytest.mark.sphinx('html', testroot='toctree-glob')
def test_toctree_twice(app):
def test_toctree_twice(app: SphinxTestApp) -> None:
text = '.. toctree::\n\n foo\n foo\n'

app.env.find_files(app.config, app.builder)
Expand All @@ -169,7 +170,9 @@ def test_toctree_twice(app):
def test_include_include_read_event(app: SphinxTestApp) -> None:
sources_reported = []

def source_read_handler(_app, relative_path, parent_docname, source):
def source_read_handler(
_app: Sphinx, relative_path: Path, parent_docname: str, source: list[str]
) -> None:
sources_reported.append((relative_path, parent_docname, source[0]))

app.connect('include-read', source_read_handler)
Expand Down Expand Up @@ -199,16 +202,18 @@ def source_read_handler(_app, relative_path, parent_docname, source):


@pytest.mark.sphinx('html', testroot='directive-include')
def test_include_include_read_event_nested_includes(app):
def source_read_handler(_app, _relative_path, _parent_docname, source):
def test_include_include_read_event_nested_includes(app: SphinxTestApp) -> None:
def source_read_handler(
_app: Sphinx, _relative_path: Path, _parent_docname: str, source: list[str]
) -> None:
text = source[0].replace('#magical', 'amazing')
source[0] = text

app.connect('include-read', source_read_handler)
text = '.. include:: baz/baz.rst\n'
app.env.find_files(app.config, app.builder)
doctree = restructuredtext.parse(app, text, 'index')
assert_node(doctree, addnodes.document)
assert_node(doctree, nodes.document)
assert len(doctree.children) == 3
assert isinstance(doctree.children[1], nodes.paragraph)
assert doctree.children[1].rawsource == 'The amazing foo.'
Loading
Loading