Add type hints for the get_unused_code function and the fields of Item.

tests/test_mypy.py

@@ -0,0 +1,21 @@
+import mypy.api
+
+
+def test_mypy():
+    result = mypy.api.run(
+        [
+            "--check-untyped-defs",
+            "--ignore-missing-imports",
+            "--disable-error-code",
+            "truthy-function",
+            "--disable-error-code",
+            "no-redef",
+            "--disable-error-code",
+            "attr-defined",
+            "--disable-error-code",
+            "misc",
+            "./vulture",
+        ]
+    )
+    assert result[0].startswith("Success: no issues found in ")
+    assert result[1:] == ("", 0)

tox.ini

@@ -15,6 +15,7 @@ deps =
   pint  # Use latest version to catch API changes.
   pytest==7.4.2
   pytest-cov==4.0.0
+  mypy==1.11.0
 commands =
   pytest {posargs}
 # Install package as wheel in all envs (https://hynek.me/articles/turbo-charge-tox/).

vulture/core.py

@@ -5,6 +5,7 @@
 import re
 import string
 import sys
+from typing import List
 
 from vulture import lines
 from vulture import noqa
@@ -139,13 +140,13 @@ def __init__(
         message="",
         confidence=DEFAULT_CONFIDENCE,
     ):
-        self.name = name
-        self.typ = typ
-        self.filename = filename
-        self.first_lineno = first_lineno
-        self.last_lineno = last_lineno
-        self.message = message or f"unused {typ} '{name}'"
-        self.confidence = confidence
+        self.name: str = name
+        self.typ: str = typ
+        self.filename: Path = filename
+        self.first_lineno: int = first_lineno
+        self.last_lineno: int = last_lineno
+        self.message: str = message or f"unused {typ} '{name}'"
+        self.confidence: int = confidence
 
     @property
     def size(self):
@@ -300,10 +301,13 @@ def exclude_path(path):
                 except OSError:
                     # Most imported modules don't have a whitelist.
                     continue
+                assert module_data is not None
                 module_string = module_data.decode("utf-8")
                 self.scan(module_string, filename=path)
 
-    def get_unused_code(self, min_confidence=0, sort_by_size=False):
+    def get_unused_code(
+        self, min_confidence=0, sort_by_size=False
+    ) -> List[Item]:
         """
         Return ordered list of unused Item objects.
         """