Lint

Author: domdfcoding

seed_intersphinx_mapping/__init__.py

@@ -47,7 +47,7 @@
 
 # this package
 from seed_intersphinx_mapping.cache import cache
-from seed_intersphinx_mapping.extension import setup
+from seed_intersphinx_mapping.extension import setup  # noqa: F401
 
 __author__: str = "Dominic Davis-Foster"
 __copyright__: str = "2020 Dominic Davis-Foster"

seed_intersphinx_mapping/__main__.py

@@ -35,7 +35,7 @@
 __all__ = ["clear_cache"]
 
 
-def clear_cache():
+def clear_cache() -> int:
 	"""
 	Clear any cached URLs.
 	"""

tests/conftest.py

@@ -4,6 +4,7 @@
 
 # 3rd party
 import pytest
+from sphinx.application import Sphinx
 from sphinx.testing.path import path
 
 if sys.version_info >= (3, 10):
@@ -15,13 +16,13 @@
 
 
 @pytest.fixture(scope="session")
-def rootdir():
+def rootdir() -> path:
 	rdir = pathlib.Path(__file__).parent.absolute() / "doc-test"
 	if not (rdir / "test-root").is_dir():
 		(rdir / "test-root").mkdir(parents=True)
 	return path(rdir)
 
 
 @pytest.fixture()
-def the_app(app):
+def the_app(app: Sphinx) -> Sphinx:
 	return app

tests/test_integration.py

@@ -1,6 +1,7 @@
 # 3rd party
 import pytest
 from domdf_python_tools.paths import PathPlus
+from sphinx.application import Sphinx
 
 
 @pytest.fixture()
@@ -17,7 +18,7 @@ def requirements(tmp_pathplus: PathPlus) -> None:
 
 
 @pytest.mark.usefixtures("requirements")
-def test_integration(the_app):
+def test_integration(the_app: Sphinx):
 	# app is a Sphinx application object for default sphinx project (`tests/doc-test/test-root`).
 	the_app.build()
 

tests/test_main.py

@@ -1,6 +1,6 @@
 def test_importable():
 	# this package
-	import seed_intersphinx_mapping.__main__
+	import seed_intersphinx_mapping.__main__  # noqa: F401
 
 
 # TODO: test the clear cache function

tests/test_setup.py

@@ -16,13 +16,13 @@ def __init__(self):
 		self.directives = []
 		self.connections = []
 
-	def add_config_value(self, *args, **kwargs):
+	def add_config_value(self, *args, **kwargs) -> None:
 		self.config_values.append(args)
 
-	def add_directive(self, *args, **kwargs):
+	def add_directive(self, *args, **kwargs) -> None:
 		self.directives.append(args)
 
-	def connect(self, *args, **kwargs):
+	def connect(self, *args, **kwargs) -> None:
 		self.connections.append(args)