Lint

Author: domdfcoding

sphinx_highlights/__init__.py

@@ -41,7 +41,7 @@
 import sys
 from importlib import import_module
 from types import FunctionType
-from typing import Iterable, Iterator, List, Optional, TypeVar, Union, get_type_hints
+from typing import Iterable, Iterator, List, Optional, Set, TypeVar, Union, get_type_hints
 
 # 3rd party
 import dict2css
@@ -59,6 +59,7 @@
 
 # 3rd party
 from sphinx.application import Sphinx
+from sphinx.environment import BuildEnvironment
 from sphinx.util.docutils import SphinxDirective
 from sphinx_toolbox.more_autodoc.typehints import format_annotation
 from sphinx_toolbox.utils import Purger, SphinxExtMetadata
@@ -261,7 +262,7 @@ def run_html(self) -> List[nodes.Node]:
 
 		view = ViewList(content)
 		body_node = nodes.paragraph(rawsource=str(content))
-		self.state.nested_parse(view, self.content_offset, body_node)  # type: ignore
+		self.state.nested_parse(view, self.content_offset, body_node)  # type: ignore[arg-type]
 
 		sphinx_highlights_purger.add_node(self.env, body_node, targetnode, self.lineno)
 
@@ -302,7 +303,7 @@ def run_generic(self) -> List[nodes.Node]:
 
 		view = ViewList(content)
 		body_node = nodes.container(rawsource=str(content))
-		self.state.nested_parse(view, self.content_offset, body_node)  # type: ignore
+		self.state.nested_parse(view, self.content_offset, body_node)  # type: ignore[arg-type]
 
 		sphinx_highlights_purger.add_node(self.env, body_node, targetnode, self.lineno)
 
@@ -361,7 +362,13 @@ def copy_assets(app: Sphinx, exception: Optional[Exception] = None) -> None:
 	dict2css.dump(style, css_dir / "sphinx_highlights.css")
 
 
-def env_get_outdated(app, env, added, changed, removed):
+def env_get_outdated(
+		app: Sphinx,
+		env: BuildEnvironment,
+		added: Set[str],
+		changed: Set[str],
+		removed: Set[str],
+		) -> List[str]:
 	return [node["docname"] for node in getattr(env, sphinx_highlights_purger.attr_name, ())]
 
 

sphinx_highlights/_eval_type.py

@@ -43,7 +43,7 @@
 
 if sys.version_info >= (3, 9):  # pragma: no cover (<py39)
 
-	def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
+	def _eval_type(t, globalns, localns, recursive_guard=frozenset()):  # noqa: MAN001,MAN002
 		"""
 		Evaluate all forward references in the given type t.
 
@@ -78,7 +78,7 @@ def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
 
 elif sys.version_info >= (3, 7):  # pragma: no cover (py39+ or <py37)
 
-	def _eval_type(t, globalns, localns):
+	def _eval_type(t, globalns, localns):  # noqa: MAN001,MAN002
 		"""
 		Evaluate all forward references in the given type t.
 
@@ -110,7 +110,7 @@ def _eval_type(t, globalns, localns):
 
 
 @contextlib.contextmanager
-def monkeypatcher():
+def monkeypatcher() -> typing.Iterator[None]:
 	"""
 	Use the modified version of ``typing._eval_type`` for the scope of the :keyword:`with` block.
 	"""

tests/test_output/conftest.py

@@ -34,6 +34,7 @@
 import pytest
 from bs4 import BeautifulSoup
 from domdf_python_tools.paths import PathPlus
+from sphinx.application import Sphinx
 from sphinx.testing.fixtures import app, make_app, shared_result, sphinx_test_tempdir, test_params
 from sphinx.testing.path import path
 
@@ -48,7 +49,7 @@
 		]
 
 
-def pytest_configure(config):
+def pytest_configure(config) -> None:  # noqa: MAN001
 	# register custom markers
 	for marker in DEFAULT_ENABLED_MARKERS:
 		config.addinivalue_line("markers", marker)
@@ -60,7 +61,7 @@ class AppParams(NamedTuple):
 
 
 @pytest.fixture(scope="session")
-def rootdir():
+def rootdir() -> path:
 	rdir = PathPlus(__file__).parent.absolute() / "doc-test"
 	(rdir / "test-root").maybe_make(parents=True)
 	return path(rdir)
@@ -107,7 +108,7 @@ def app_params(
 
 
 @pytest.fixture()
-def page(app, request, monkeypatch) -> Iterator[BeautifulSoup]:
+def page(app: Sphinx, request, monkeypatch) -> Iterator[BeautifulSoup]:
 	random.seed("5678")
 
 	app.build(force_all=True)

tests/test_output/test_output.py

@@ -7,10 +7,11 @@
 from bs4 import BeautifulSoup
 from domdf_python_tools.paths import PathPlus
 from domdf_python_tools.stringlist import StringList
+from sphinx.application import Sphinx
 from sphinx_toolbox.testing import HTMLRegressionFixture, LaTeXRegressionFixture
 
 
-def test_build_example(app):
+def test_build_example(app: Sphinx):
 	app.build()
 	app.build()
 
@@ -35,15 +36,16 @@ def test_html_output(page: BeautifulSoup, html_regression: HTMLRegressionFixture
 
 @pytest.mark.sphinx("latex", srcdir="test-root")
 def test_latex_output(
-		app,
+		app: Sphinx,
 		latex_regression: LaTeXRegressionFixture,
 		):
 	random.seed("5678")
 
+	assert app.builder is not None
 	assert app.builder.name.lower() == "latex"
 	app.build()
 
-	output_file = PathPlus(app.outdir / "sphinx-highlights-demo.tex")
+	output_file = PathPlus(app.outdir) / "sphinx-highlights-demo.tex"
 	content = str(StringList(output_file.read_lines())).replace("\\sphinxAtStartPar\n", '')
 	latex_regression.check(
 			# re.sub(r"\\date{.*}", r"\\date{Mar 11, 2021}", content),