Chore(mypy): Annotate None returns for typing improvements (#11213)

src/paperless_ai/client.py

@@ -16,7 +16,7 @@ class AIClient:
     A client for interacting with an LLM backend.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         self.settings = AIConfig()
         self.llm = self.get_llm()
 

src/paperless_ai/tests/test_ai_indexing.py

@@ -60,7 +60,7 @@ class FakeEmbedding(BaseEmbedding):
 
 
 @pytest.mark.django_db
-def test_build_document_node(real_document):
+def test_build_document_node(real_document) -> None:
     nodes = indexing.build_document_node(real_document)
     assert len(nodes) > 0
     assert nodes[0].metadata["document_id"] == str(real_document.id)
@@ -71,7 +71,7 @@ def test_update_llm_index(
     temp_llm_index_dir,
     real_document,
     mock_embed_model,
-):
+) -> None:
     with patch("documents.models.Document.objects.all") as mock_all:
         mock_queryset = MagicMock()
         mock_queryset.exists.return_value = True
@@ -87,7 +87,7 @@ def test_update_llm_index_removes_meta(
     temp_llm_index_dir,
     real_document,
     mock_embed_model,
-):
+) -> None:
     # Pre-create a meta.json with incorrect data
     (temp_llm_index_dir / "meta.json").write_text(
         json.dumps({"embedding_model": "old", "dim": 1}),
@@ -117,7 +117,7 @@ def test_update_llm_index_partial_update(
     temp_llm_index_dir,
     real_document,
     mock_embed_model,
-):
+) -> None:
     doc2 = Document.objects.create(
         title="Test Document 2",
         content="This is some test content 2.",
@@ -166,7 +166,7 @@ def test_update_llm_index_partial_update(
 def test_get_or_create_storage_context_raises_exception(
     temp_llm_index_dir,
     mock_embed_model,
-):
+) -> None:
     with pytest.raises(Exception):
         indexing.get_or_create_storage_context(rebuild=False)
 
@@ -178,7 +178,7 @@ def test_load_or_build_index_builds_when_nodes_given(
     temp_llm_index_dir,
     real_document,
     mock_embed_model,
-):
+) -> None:
     with (
         patch(
             "paperless_ai.indexing.load_index_from_storage",
@@ -203,7 +203,7 @@ def test_load_or_build_index_builds_when_nodes_given(
 def test_load_or_build_index_raises_exception_when_no_nodes(
     temp_llm_index_dir,
     mock_embed_model,
-):
+) -> None:
     with (
         patch(
             "paperless_ai.indexing.load_index_from_storage",
@@ -222,7 +222,7 @@ def test_load_or_build_index_raises_exception_when_no_nodes(
 def test_load_or_build_index_succeeds_when_nodes_given(
     temp_llm_index_dir,
     mock_embed_model,
-):
+) -> None:
     with (
         patch(
             "paperless_ai.indexing.load_index_from_storage",
@@ -249,7 +249,7 @@ def test_add_or_update_document_updates_existing_entry(
     temp_llm_index_dir,
     real_document,
     mock_embed_model,
-):
+) -> None:
     indexing.update_llm_index(rebuild=True)
     indexing.llm_index_add_or_update_document(real_document)
 
@@ -261,7 +261,7 @@ def test_remove_document_deletes_node_from_docstore(
     temp_llm_index_dir,
     real_document,
     mock_embed_model,
-):
+) -> None:
     indexing.update_llm_index(rebuild=True)
     index = indexing.load_or_build_index()
     assert len(index.docstore.docs) == 1
@@ -275,7 +275,7 @@ def test_remove_document_deletes_node_from_docstore(
 def test_update_llm_index_no_documents(
     temp_llm_index_dir,
     mock_embed_model,
-):
+) -> None:
     with patch("documents.models.Document.objects.all") as mock_all:
         mock_queryset = MagicMock()
         mock_queryset.exists.return_value = False
@@ -291,7 +291,7 @@ def test_update_llm_index_no_documents(
 
 
 @pytest.mark.django_db
-def test_queue_llm_index_update_if_needed_enqueues_when_idle_or_skips_recent():
+def test_queue_llm_index_update_if_needed_enqueues_when_idle_or_skips_recent() -> None:
     # No existing tasks
     with patch("documents.tasks.llmindex_index") as mock_task:
         result = indexing.queue_llm_index_update_if_needed(
@@ -327,7 +327,7 @@ def test_queue_llm_index_update_if_needed_enqueues_when_idle_or_skips_recent():
 def test_query_similar_documents(
     temp_llm_index_dir,
     real_document,
-):
+) -> None:
     with (
         patch("paperless_ai.indexing.get_or_create_storage_context") as mock_storage,
         patch("paperless_ai.indexing.load_or_build_index") as mock_load_or_build_index,
@@ -374,7 +374,7 @@ def test_query_similar_documents(
 def test_query_similar_documents_triggers_update_when_index_missing(
     temp_llm_index_dir,
     real_document,
-):
+) -> None:
     with (
         patch(
             "paperless_ai.indexing.vector_store_file_exists",

src/paperless_ai/tests/test_chat.py

@@ -40,7 +40,7 @@ def mock_document():
     return doc
 
 
-def test_stream_chat_with_one_document_full_content(mock_document):
+def test_stream_chat_with_one_document_full_content(mock_document) -> None:
     with (
         patch("paperless_ai.chat.AIClient") as mock_client_cls,
         patch("paperless_ai.chat.load_or_build_index") as mock_load_index,
@@ -71,7 +71,7 @@ def test_stream_chat_with_one_document_full_content(mock_document):
         assert output == ["chunk1", "chunk2"]
 
 
-def test_stream_chat_with_multiple_documents_retrieval(patch_embed_nodes):
+def test_stream_chat_with_multiple_documents_retrieval(patch_embed_nodes) -> None:
     with (
         patch("paperless_ai.chat.AIClient") as mock_client_cls,
         patch("paperless_ai.chat.load_or_build_index") as mock_load_index,
@@ -121,7 +121,7 @@ def test_stream_chat_with_multiple_documents_retrieval(patch_embed_nodes):
         assert output == ["chunk1", "chunk2"]
 
 
-def test_stream_chat_no_matching_nodes():
+def test_stream_chat_no_matching_nodes() -> None:
     with (
         patch("paperless_ai.chat.AIClient") as mock_client_cls,
         patch("paperless_ai.chat.load_or_build_index") as mock_load_index,

src/paperless_ai/tests/test_matching.py

@@ -14,7 +14,7 @@ from paperless_ai.matching import match_tags_by_name
 
 
 class TestAIMatching(TestCase):
-    def setUp(self):
+    def setUp(self) -> None:
         # Create test data for Tag
         self.tag1 = Tag.objects.create(name="Test Tag 1")
         self.tag2 = Tag.objects.create(name="Test Tag 2")
@@ -32,7 +32,7 @@ class TestAIMatching(TestCase):
         self.storage_path2 = StoragePath.objects.create(name="Test Storage Path 2")
 
     @patch("paperless_ai.matching.get_objects_for_user_owner_aware")
-    def test_match_tags_by_name(self, mock_get_objects):
+    def test_match_tags_by_name(self, mock_get_objects) -> None:
         mock_get_objects.return_value = Tag.objects.all()
         names = ["Test Tag 1", "Nonexistent Tag"]
         result = match_tags_by_name(names, user=None)
@@ -40,7 +40,7 @@ class TestAIMatching(TestCase):
         self.assertEqual(result[0].name, "Test Tag 1")
 
     @patch("paperless_ai.matching.get_objects_for_user_owner_aware")
-    def test_match_correspondents_by_name(self, mock_get_objects):
+    def test_match_correspondents_by_name(self, mock_get_objects) -> None:
         mock_get_objects.return_value = Correspondent.objects.all()
         names = ["Test Correspondent 1", "Nonexistent Correspondent"]
         result = match_correspondents_by_name(names, user=None)
@@ -48,7 +48,7 @@ class TestAIMatching(TestCase):
         self.assertEqual(result[0].name, "Test Correspondent 1")
 
     @patch("paperless_ai.matching.get_objects_for_user_owner_aware")
-    def test_match_document_types_by_name(self, mock_get_objects):
+    def test_match_document_types_by_name(self, mock_get_objects) -> None:
         mock_get_objects.return_value = DocumentType.objects.all()
         names = ["Test Document Type 1", "Nonexistent Document Type"]
         result = match_document_types_by_name(names, user=None)
@@ -56,28 +56,28 @@ class TestAIMatching(TestCase):
         self.assertEqual(result[0].name, "Test Document Type 1")
 
     @patch("paperless_ai.matching.get_objects_for_user_owner_aware")
-    def test_match_storage_paths_by_name(self, mock_get_objects):
+    def test_match_storage_paths_by_name(self, mock_get_objects) -> None:
         mock_get_objects.return_value = StoragePath.objects.all()
         names = ["Test Storage Path 1", "Nonexistent Storage Path"]
         result = match_storage_paths_by_name(names, user=None)
         self.assertEqual(len(result), 1)
         self.assertEqual(result[0].name, "Test Storage Path 1")
 
-    def test_extract_unmatched_names(self):
+    def test_extract_unmatched_names(self) -> None:
         llm_names = ["Test Tag 1", "Nonexistent Tag"]
         matched_objects = [self.tag1]
         unmatched_names = extract_unmatched_names(llm_names, matched_objects)
         self.assertEqual(unmatched_names, ["Nonexistent Tag"])
 
     @patch("paperless_ai.matching.get_objects_for_user_owner_aware")
-    def test_match_tags_by_name_with_empty_names(self, mock_get_objects):
+    def test_match_tags_by_name_with_empty_names(self, mock_get_objects) -> None:
         mock_get_objects.return_value = Tag.objects.all()
         names = [None, "", "   "]
         result = match_tags_by_name(names, user=None)
         self.assertEqual(result, [])
 
     @patch("paperless_ai.matching.get_objects_for_user_owner_aware")
-    def test_match_tags_with_fuzzy_matching(self, mock_get_objects):
+    def test_match_tags_with_fuzzy_matching(self, mock_get_objects) -> None:
         mock_get_objects.return_value = Tag.objects.all()
         names = ["Test Taag 1", "Teest Tag 2"]
         result = match_tags_by_name(names, user=None)