Appease mypy

Author: domdfcoding

tests/conftest.py

@@ -7,7 +7,7 @@
 # 3rd party
 import pytest
 import sphinx
-from bs4 import BeautifulSoup  # type: ignore[import-untyped]
+from bs4 import BeautifulSoup
 from sphinx.application import Sphinx
 
 if sys.version_info >= (3, 10):

tests/test_autoenum.py

@@ -11,7 +11,7 @@
 # 3rd party
 import pytest
 import sphinx
-from bs4 import BeautifulSoup, NavigableString  # type: ignore[import-untyped]
+from bs4 import BeautifulSoup, NavigableString, Tag
 from sphinx.application import Sphinx
 from sphinx_toolbox.testing import HTMLRegressionFixture
 
@@ -67,19 +67,19 @@ def preprocess_soup(soup: BeautifulSoup) -> None:
 
 	if sphinx.version_info >= (3, 5):  # pragma: no cover
 		for em in soup.select("em.property"):
-			child = ''.join(c.string for c in em.contents)
+			child = ''.join(c.string for c in em.contents)  # type: ignore[attr-defined]
 			for c in em.children:
 				c.extract()
 			em.contents = []
 			em.insert(0, child)
 
 		for dl in soup.select("dl.py.method dt"):  # .sig.sig-object.py
 			if return_arrow in dl.contents:
-				arrow_idx = dl.contents.index(return_arrow)
-				dl.contents[arrow_idx] = NavigableString(
-						dl.contents[arrow_idx] + dl.contents[arrow_idx + 1].contents[0]
-						)
-				dl.contents[arrow_idx + 1].extract()
+				arrow_idx = dl.contents.index(return_arrow)  # type: ignore[arg-type]
+				contents = dl.contents
+				string = contents[arrow_idx] + contents[arrow_idx + 1].contents[0]  # type: ignore[attr-defined]
+				contents[arrow_idx] = NavigableString(string)
+				contents[arrow_idx + 1].extract()
 
 	for dt in soup.select("span.pre"):
 		dt.replace_with_children()
@@ -88,9 +88,9 @@ def preprocess_soup(soup: BeautifulSoup) -> None:
 		dt.replace_with(NavigableString(dt.get_text()))
 
 	for div in soup.find_all("script"):
-		if div.get("src"):
-			div["src"] = div["src"].split("?v=")[0]
-			print(div["src"])
+		if cast(Tag, div).get("src"):
+			div["src"] = div["src"].split("?v=")[0]  # type: ignore[union-attr,index]
+			print(div["src"])  # type: ignore[index]
 
 	for meta in cast(List[Dict], soup.find_all("meta")):
 		if meta.get("content", '') == "width=device-width, initial-scale=0.9, maximum-scale=0.9":
@@ -109,7 +109,7 @@ def preprocess_soup(soup: BeautifulSoup) -> None:
 		)
 def test_index(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 	# Make sure the page title is what you expect
-	title = page.find("h1").contents[0].strip()
+	title = page.find("h1").contents[0].strip()  # type: ignore[union-attr]
 	assert "autoenum Demo" == title
 
 	preprocess_soup(page)
@@ -121,24 +121,26 @@ def test_index(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 	class_count = 0
 
 	for class_ in page.find_all("dl"):
-		if "enum" not in class_["class"]:
+		if "enum" not in class_["class"]:  # type: ignore[index]
 			continue
 
+		dd = class_.find("dd")  # type: ignore[union-attr]
 		if class_count == 0:
-			assert class_.find("dt")["id"] == "enum_tools.demo.People"
-			assert class_.find("dd").find_all('p')[0].contents[0] == "An enumeration of people."
+			assert class_.find("dt")["id"] == "enum_tools.demo.People"  # type: ignore[union-attr,index]
+			assert dd.find_all('p')[0].contents[0] == "An enumeration of people."  # type: ignore[union-attr]
 		elif class_count == 1:
-			assert class_.find("dt")["id"] == "enum_tools.demo.NoMethods"
-			assert class_.find("dd").find_all('p'
-												)[0].contents[0] == "An enumeration of people without any methods."
+			assert class_.find("dt")["id"] == "enum_tools.demo.NoMethods"  # type: ignore[union-attr,index]
+			expected = "An enumeration of people without any methods."
+			assert dd.find_all('p')[0].contents[0] == expected  # type: ignore[union-attr]
 
 		tag = '<code class="xref py py-class docutils literal notranslate">int</code>'
-		assert str(class_.find("dd").find_all('p')[1].contents[0]) == tag
-		assert class_.find("dd").find_all('p')[2].contents[0] == "Valid values are as follows:"
+		assert str(dd.find_all('p')[1].contents[0]) == tag  # type: ignore[union-attr]
+		assert dd.find_all('p')[2].contents[0] == "Valid values are as follows:"  # type: ignore[union-attr]
 
 		attr_count = 0
 
-		for attr in class_.find_all("dl"):
+		for attr in class_.find_all("dl"):  # type: ignore[union-attr]
+			attr = cast(Tag, attr)
 			if "attribute" not in attr["class"]:
 				continue
 
@@ -147,50 +149,53 @@ def test_index(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 			else:
 				class_name = "NoMethods"
 
+			dt = attr.find("dt")
+			dd = attr.find("dd")
 			if attr_count == 0:
-				assert attr.find("dt")["id"] == f"enum_tools.demo.{class_name}.Bob"
+				assert dt["id"] == f"enum_tools.demo.{class_name}.Bob"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == f" = {class_name}.Bob"
+					assert dt.em.contents[0] == f" = {class_name}.Bob"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == f" = <{class_name}.Bob: 1>"
+					assert dt.em.contents[0] == f" = <{class_name}.Bob: 1>"  # type: ignore[union-attr]
 
-				assert str(attr.find("dd").contents[0]) == "<p>A person called Bob</p>"
+				assert str(dd.contents[0]) == "<p>A person called Bob</p>"  # type: ignore[union-attr]
 
 			elif attr_count == 1:
-				assert attr.find("dt")["id"] == f"enum_tools.demo.{class_name}.Alice"
+				assert dt["id"] == f"enum_tools.demo.{class_name}.Alice"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == f" = {class_name}.Alice"
+					assert dt.em.contents[0] == f" = {class_name}.Alice"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == f" = <{class_name}.Alice: 2>"
+					assert dt.em.contents[0] == f" = <{class_name}.Alice: 2>"  # type: ignore[union-attr]
 
-				assert str(attr.find("dd").contents[0]) == "<p>A person called Alice</p>"
+				assert str(dd.contents[0]) == "<p>A person called Alice</p>"  # type: ignore[union-attr]
 
 			elif attr_count == 2:
-				assert attr.find("dt")["id"] == f"enum_tools.demo.{class_name}.Carol"
+				assert dt["id"] == f"enum_tools.demo.{class_name}.Carol"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == f" = {class_name}.Carol"
+					assert dt.em.contents[0] == f" = {class_name}.Carol"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == f" = <{class_name}.Carol: 3>"
+					assert dt.em.contents[0] == f" = <{class_name}.Carol: 3>"  # type: ignore[union-attr]
 
 				if class_count == 0:
-					assert str(attr.find("dd").contents[0]) == "<p>A person called Carol.</p>"
-					assert str(attr.find("dd").contents[1]) == '\n'
-					assert str(attr.find("dd").contents[2]) == "<p>This is a multiline docstring.</p>"
+					contents = dd.contents  # type: ignore[union-attr]
+					assert str(contents[0]) == "<p>A person called Carol.</p>"
+					assert str(contents[1]) == '\n'
+					assert str(contents[2]) == "<p>This is a multiline docstring.</p>"
 				else:
-					assert str(attr.find("dd").contents[0]) == "<p>A person called Carol</p>"
+					assert str(dd.contents[0]) == "<p>A person called Carol</p>"  # type: ignore[union-attr]
 
 			elif attr_count == 3:
-				assert attr.find("dt")["id"] == f"enum_tools.demo.{class_name}.Dennis"
+				assert dt["id"] == f"enum_tools.demo.{class_name}.Dennis"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == f" = {class_name}.Dennis"
+					assert dt.em.contents[0] == f" = {class_name}.Dennis"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == f" = <{class_name}.Dennis: 4>"
+					assert dt.em.contents[0] == f" = <{class_name}.Dennis: 4>"  # type: ignore[union-attr]
 
-				assert str(attr.find("dd").contents[0]) == "<p>A person called Dennis</p>"
+				assert str(dd.contents[0]) == "<p>A person called Dennis</p>"  # type: ignore[union-attr]
 
 			attr_count += 1
 
@@ -202,14 +207,10 @@ def test_index(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 
 
 @xfail_312
-@pytest.mark.parametrize(
-		"page", [
-				"flag.html",
-				], indirect=True
-		)
+@pytest.mark.parametrize("page", ["flag.html"], indirect=True)
 def test_flag(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 	# Make sure the page title is what you expect
-	title = page.find("h1").contents[0].strip()
+	title = page.find("h1").contents[0].strip()  # type: ignore[union-attr]
 	assert "autoenum Demo - Flag" == title
 
 	preprocess_soup(page)
@@ -221,62 +222,66 @@ def test_flag(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 	class_count = 0
 
 	for class_ in page.find_all("dl"):
-		if "flag" not in class_["class"]:
+		if "flag" not in class_["class"]:  # type: ignore[index]
 			continue
 
 		if class_count == 0:
-			assert class_.find("dt")["id"] == "enum_tools.demo.StatusFlags"
+			assert class_.find("dt")["id"] == "enum_tools.demo.StatusFlags"  # type: ignore[union-attr,index]
 		elif class_count == 1:
-			assert class_.find("dt")["id"] == "id0"
+			assert class_.find("dt")["id"] == "id0"  # type: ignore[union-attr,index]
 
-		assert class_.find("dd").find_all('p')[0].contents[0] == "An enumeration of status codes."
+		ps = class_.find("dd").find_all('p')  # type: ignore[union-attr]
+		assert ps[0].contents[0] == "An enumeration of status codes."
 
 		tag = '<code class="xref py py-class docutils literal notranslate">int</code>'
-		assert str(class_.find("dd").find_all('p')[1].contents[0]) == tag
-		assert class_.find("dd").find_all('p')[2].contents[0] == "Valid values are as follows:"
+		assert str(ps[1].contents[0]) == tag
+		assert ps[2].contents[0] == "Valid values are as follows:"
 
 		attr_count = 0
 
-		for attr in class_.find_all("dl"):
+		for attr in class_.find_all("dl"):  # type: ignore[union-attr]
+			attr = cast(Tag, attr)
 			if "attribute" not in attr["class"]:
 				continue
 
+			dt = attr.find("dt")
+			dd = attr.find("dd")
 			if attr_count == 0:
 				if class_count == 0:
-					assert attr.find("dt")["id"] == "enum_tools.demo.StatusFlags.Running"
+					assert dt["id"] == "enum_tools.demo.StatusFlags.Running"  # type: ignore[index]
 				elif class_count == 1:
-					assert attr.find("dt")["id"] == "id1"
+					assert dt["id"] == "id1"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == " = StatusFlags.Running"
+					assert dt.em.contents[0] == " = StatusFlags.Running"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == " = <StatusFlags.Running: 1>"
+					assert dt.em.contents[0] == " = <StatusFlags.Running: 1>"  # type: ignore[union-attr]
 
-				assert str(attr.find("dd").contents[0]) == "<p>The system is running.</p>"
+				assert str(dd.contents[0]) == "<p>The system is running.</p>"  # type: ignore[union-attr]
 			elif attr_count == 1:
 				if class_count == 0:
-					assert attr.find("dt")["id"] == "enum_tools.demo.StatusFlags.Stopped"
+					assert dt["id"] == "enum_tools.demo.StatusFlags.Stopped"  # type: ignore[index]
 				elif class_count == 1:
-					assert attr.find("dt")["id"] == "id2"
+					assert dt["id"] == "id2"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == " = StatusFlags.Stopped"
+					assert dt.em.contents[0] == " = StatusFlags.Stopped"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == " = <StatusFlags.Stopped: 2>"
+					assert dt.em.contents[0] == " = <StatusFlags.Stopped: 2>"  # type: ignore[union-attr]
 
-				assert str(attr.find("dd").contents[0]) == "<p>The system has stopped.</p>"
+				assert str(dd.contents[0]) == "<p>The system has stopped.</p>"  # type: ignore[union-attr]
 			elif attr_count == 2:
 				if class_count == 0:
-					assert attr.find("dt")["id"] == "enum_tools.demo.StatusFlags.Error"
+					assert dt["id"] == "enum_tools.demo.StatusFlags.Error"  # type: ignore[index]
 				elif class_count == 1:
-					assert attr.find("dt")["id"] == "id3"
+					assert dt["id"] == "id3"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == " = StatusFlags.Error"
+					assert dt.em.contents[0] == " = StatusFlags.Error"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == " = <StatusFlags.Error: 4>"
+					assert dt.em.contents[0] == " = <StatusFlags.Error: 4>"  # type: ignore[union-attr]
 
-				assert str(attr.find("dd").contents[0]) == "<p>An error has occurred.</p>"
+				assert str(dd.contents[0]) == "<p>An error has occurred.</p>"  # type: ignore[union-attr]
 
 			attr_count += 1
 
@@ -288,14 +293,10 @@ def test_flag(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 
 
 @xfail_312
-@pytest.mark.parametrize(
-		"page", [
-				"no-member-doc.html",
-				], indirect=True
-		)
+@pytest.mark.parametrize("page", ["no-member-doc.html"], indirect=True)
 def test_no_member_doc(page: BeautifulSoup, html_regression: HTMLRegressionFixture):
 	# Make sure the page title is what you expect
-	title = page.find("h1").contents[0].strip()
+	title = page.find("h1").contents[0].strip()  # type: ignore[union-attr]
 	assert "autoenum Demo - Members without docstrings" == title
 
 	preprocess_soup(page)
@@ -307,62 +308,65 @@ def test_no_member_doc(page: BeautifulSoup, html_regression: HTMLRegressionFixtu
 	class_count = 0
 
 	for class_ in page.find_all("dl"):
-		if "enum" not in class_["class"]:
+		if "enum" not in class_["class"]:  # type: ignore[index]
 			continue
 
-		assert class_.find("dt")["id"] == "enum_tools.demo.NoMemberDoc"
-		assert class_.find("dd").find_all('p')[0].contents[
-				0] == "An enumeration of people without any member docstrings."
+		dd = class_.find("dd")  # type: ignore[union-attr]
+		assert class_.find("dt")["id"] == "enum_tools.demo.NoMemberDoc"  # type: ignore[union-attr,index]
+		expected = "An enumeration of people without any member docstrings."
+		assert dd.find_all('p')[0].contents[0] == expected  # type: ignore[union-attr]
 
 		if class_count == 0:
 			tag = '<code class="xref py py-class docutils literal notranslate">int</code>'
-			assert str(class_.find("dd").find_all('p')[1].contents[0]) == tag
-			assert class_.find("dd").find_all('p')[2].contents[0] == "Valid values are as follows:"
+			assert str(dd.find_all('p')[1].contents[0]) == tag  # type: ignore[union-attr]
+			assert dd.find_all('p')[2].contents[0] == "Valid values are as follows:"  # type: ignore[union-attr]
 		else:
-			assert class_.find("dd").find_all('p')[1].contents[0] == "Valid values are as follows:"
+			assert dd.find_all('p')[1].contents[0] == "Valid values are as follows:"  # type: ignore[union-attr]
 
 		attr_count = 0
 
-		for attr in class_.find_all("dl"):
+		for attr in class_.find_all("dl"):  # type: ignore[union-attr]
+			attr = cast(Tag, attr)
 			if "attribute" not in attr["class"]:
 				continue
 
+			dt = attr.find("dt")
 			if attr_count == 0:
 				if class_count == 0:
-					assert attr.find("dt")["id"] == "enum_tools.demo.NoMemberDoc.Bob"
+					assert dt["id"] == "enum_tools.demo.NoMemberDoc.Bob"  # type: ignore[index]
 				elif class_count == 1:
-					assert attr.find("dt")["id"] == "id1"
+					assert dt["id"] == "id1"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == " = NoMemberDoc.Bob"
+					assert dt.em.contents[0] == " = NoMemberDoc.Bob"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == " = <NoMemberDoc.Bob: 1>"
+					assert dt.em.contents[0] == " = <NoMemberDoc.Bob: 1>"  # type: ignore[union-attr]
 
-				assert not attr.find("dd").contents
+				assert not attr.find("dd").contents  # type: ignore[union-attr]
 			elif attr_count == 1:
 				if class_count == 0:
-					assert attr.find("dt")["id"] == "enum_tools.demo.NoMemberDoc.Alice"
+					assert dt["id"] == "enum_tools.demo.NoMemberDoc.Alice"  # type: ignore[index]
 				elif class_count == 1:
-					assert attr.find("dt")["id"] == "id2"
+					assert dt["id"] == "id2"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == " = NoMemberDoc.Alice"
+					assert dt.em.contents[0] == " = NoMemberDoc.Alice"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == " = <NoMemberDoc.Alice: 2>"
+					assert dt.em.contents[0] == " = <NoMemberDoc.Alice: 2>"  # type: ignore[union-attr]
 
-				assert not attr.find("dd").contents
+				assert not attr.find("dd").contents  # type: ignore[union-attr]
 			elif attr_count == 2:
 				if class_count == 0:
-					assert attr.find("dt")["id"] == "enum_tools.demo.NoMemberDoc.Carol"
+					assert dt["id"] == "enum_tools.demo.NoMemberDoc.Carol"  # type: ignore[index]
 				elif class_count == 1:
-					assert attr.find("dt")["id"] == "id3"
+					assert dt["id"] == "id3"  # type: ignore[index]
 
 				if NEW_ENUM_REPR:
-					assert attr.find("dt").em.contents[0] == " = NoMemberDoc.Carol"
+					assert dt.em.contents[0] == " = NoMemberDoc.Carol"  # type: ignore[union-attr]
 				else:
-					assert attr.find("dt").em.contents[0] == " = <NoMemberDoc.Carol: 3>"
+					assert dt.em.contents[0] == " = <NoMemberDoc.Carol: 3>"  # type: ignore[union-attr]
 
-				assert not attr.find("dd").contents
+				assert not attr.find("dd").contents  # type: ignore[union-attr]
 
 			attr_count += 1