index: delete_document routes return

Author: elamc-2

meilisearch/index.py

@@ -593,7 +593,7 @@ def delete_document(self, document_id: str) -> TaskInfo:
         )
         return TaskInfo(**response)
 
-    def delete_documents(self, ids: List[str]) -> Dict[str, int]:
+    def delete_documents(self, ids: List[str]) -> TaskInfo:
         """Delete multiple documents from the index.
 
         Parameters
@@ -603,37 +603,39 @@ def delete_documents(self, ids: List[str]) -> Dict[str, int]:
 
         Returns
         -------
-        task:
-            Dictionary containing a task to track the informations about the progress of an asynchronous process.
+        TaskInfo:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
             https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
 
         Raises
         ------
         MeiliSearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
-        return self.http.post(
+        response = self.http.post(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/delete-batch',
             ids
         )
+        return TaskInfo(**response)
 
-    def delete_all_documents(self) -> Dict[str, int]:
+    def delete_all_documents(self) -> TaskInfo:
         """Delete all documents from the index.
 
         Returns
         -------
-        task:
-            Dictionary containing a task to track the informations about the progress of an asynchronous process.
+        TaskInfo:
+            TaskInfo instance containing information about a task to track the progress of an asynchronous process.
             https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
 
         Raises
         ------
         MeiliSearchApiError
             An error containing details about why Meilisearch can't process your request. Meilisearch error codes are described here: https://docs.meilisearch.com/errors/#meilisearch-errors
         """
-        return self.http.delete(
+        response = self.http.delete(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}'
         )
+        return TaskInfo(**response)
 
     # GENERAL SETTINGS ROUTES
 

tests/index/test_index_document_meilisearch.py

@@ -140,9 +140,9 @@ def test_delete_documents(index_with_documents):
     to_delete = ['522681', '450465', '329996']
     index = index_with_documents()
     response = index.delete_documents(to_delete)
-    assert isinstance(response, dict)
-    assert 'taskUid' in response
-    index.wait_for_task(response['taskUid'])
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid != None
+    index.wait_for_task(response.task_uid)
     for document in to_delete:
         with pytest.raises(Exception):
             index.get_document(document)
@@ -151,9 +151,9 @@ def test_delete_all_documents(index_with_documents):
     """Tests deleting all the documents in the index."""
     index = index_with_documents()
     response = index.delete_all_documents()
-    assert isinstance(response, dict)
-    assert 'taskUid' in response
-    index.wait_for_task(response['taskUid'])
+    assert isinstance(response, TaskInfo)
+    assert response.task_uid != None
+    index.wait_for_task(response.task_uid)
     response = index.get_documents()
     assert isinstance(response.results, list)
     assert response.results == []