Progress towards satisfying vulture

Author: adamtheturtle

.pre-commit-config.yaml

@@ -101,9 +101,10 @@ repos:
 
     - id: vulture
       name: vulture
-      entry: python -m vulture
+      entry: python -m vulture .
       language: system
       types_or: [python]
+      pass_filenames: false
 
     - id: pyroma
       name: pyroma

conftest.py

@@ -26,8 +26,8 @@ def pytest_collection_modifyitems(items: list[pytest.Item]) -> None:
             item.obj = beartype(obj=item.obj)
 
 
-@pytest.fixture
-def make_image_file(
+@pytest.fixture(name="make_image_file")
+def fixture_make_image_file(
     high_quality_image: io.BytesIO,
 ) -> Generator[None, None, None]:
     """
@@ -41,8 +41,8 @@ def make_image_file(
     new_image.unlink()
 
 
-@pytest.fixture
-def mock_vws() -> Generator[None, None, None]:
+@pytest.fixture(name="mock_vws")
+def fixture_mock_vws() -> Generator[None, None, None]:
     """
     Yield a mock VWS.
 

docs/source/conf.py

@@ -62,12 +62,7 @@
     "python": ("https://docs.python.org/3.12", None),
 }
 nitpicky = True
-nitpick_ignore = (
-    ("py:class", "BytesIO"),
-    ("py:class", "BufferedRandom"),
-    ("py:class", "_io.BytesIO"),
-    ("py:class", "_io.BufferedRandom"),
-)
+nitpick_ignore = (("py:class", "_io.BytesIO"),)
 warning_is_error = True
 
 autoclass_content = "both"

pyproject.toml

@@ -342,3 +342,45 @@ ignore_path = [
     "./src/*.egg-info/",
     "./src/*/_setuptools_scm_version.txt",
 ]
+
+[tool.vulture]
+# Ideally we would limit the paths to the source code where we want to ignore names,
+# but Vulture does not enable this.
+ignore_names = [
+    # pytest configuration
+    "pytest_collect_file",
+    "pytest_collection_modifyitems",
+    "pytest_plugins",
+    # pytest fixtures - we name fixtures like this for this purpose
+    "fixture_*",
+    # Sphinx
+    "autoclass_content",
+    "autoclass_content",
+    "autodoc_member_order",
+    "copybutton_exclude",
+    "extensions",
+    "html_show_copyright",
+    "html_show_sourcelink",
+    "html_show_sphinx",
+    "html_theme",
+    "html_theme_options",
+    "html_title",
+    "htmlhelp_basename",
+    "intersphinx_mapping",
+    "language",
+    "linkcheck_ignore",
+    "linkcheck_retries",
+    "master_doc",
+    "nitpicky",
+    "nitpick_ignore",
+    "project_copyright",
+    "pygments_style",
+    "rst_prolog",
+    "source_suffix",
+    "spelling_word_list_filename",
+    "templates_path",
+    "warning_is_error",
+]
+
+# Duplicate some of .gitignore
+exclude = [".venv"]

tests/conftest.py

@@ -15,7 +15,7 @@
 
 
 @pytest.fixture(name="_mock_database")
-def mock_database() -> Generator[VuforiaDatabase, None, None]:
+def fixture_mock_database() -> Generator[VuforiaDatabase, None, None]:
     """
     Yield a mock ``VuforiaDatabase``.
     """