Merge pull request #598 from meilisearch/add_delete_task_api_for_v0.30.0

Add delete task api for v0.30.0

Author: alallema

meilisearch/client.py

@@ -14,7 +14,7 @@
 from meilisearch.errors import MeiliSearchError
 from meilisearch.index import Index
 from meilisearch.models.task import TaskInfo
-from meilisearch.task import cancel_tasks, get_task, get_tasks, wait_for_task
+from meilisearch.task import cancel_tasks, delete_tasks, get_task, get_tasks, wait_for_task
 
 
 class Client:
@@ -463,6 +463,25 @@ def cancel_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
         """
         return cancel_tasks(self.config, parameters=parameters)
 
+    def delete_tasks(self, parameters: dict[str, Any]) -> TaskInfo:
+        """Delete a list of finished tasks.
+
+        Parameters
+        ----------
+        parameters (optional):
+            parameters accepted by the delete tasks route:https://docs.meilisearch.com/reference/api/tasks.html#delete-task.
+        Returns
+        -------
+        task_info:
+            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 delete_tasks(self.config, parameters=parameters)
+
     def wait_for_task(
         self,
         uid: int,

meilisearch/task.py

@@ -99,6 +99,34 @@ def cancel_tasks(config: Config, parameters: dict[str, Any]) -> TaskInfo:
     return TaskInfo(**response)
 
 
+def delete_tasks(config: Config, parameters: dict[str, Any] | None = None) -> TaskInfo:
+    """Delete a list of enqueued or processing tasks.
+    Parameters
+    ----------
+    config:
+        Config object containing permission and location of Meilisearch.
+    parameters (optional):
+        parameters accepted by the delete tasks route:https://docs.meilisearch.com/reference/api/tasks.html#delete-task.
+    Returns
+    -------
+    task_info:
+        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
+    """
+    http = HttpRequests(config)
+    if parameters is None:
+        parameters = {}
+    for param in parameters:
+        if isinstance(parameters[param], list):
+            parameters[param] = ",".join(parameters[param])
+    response = http.delete(f"{config.paths.task}?{parse.urlencode(parameters)}")
+    return TaskInfo(**response)
+
+
 def wait_for_task(
     config: Config,
     uid: int,

tests/client/test_client_task_meilisearch.py

@@ -45,7 +45,7 @@ def test_get_tasks_with_all_plural_parameters(client, empty_index):
         {"indexUids": [common.INDEX_UID], "statuses": ["succeeded"], "types": ["indexCreation"]}
     )
     assert isinstance(tasks, dict)
-    assert len(tasks["results"]) > 1
+    assert len(tasks["results"]) >= 1
 
 
 def test_get_tasks_with_date_parameters(client, empty_index):
@@ -131,3 +131,39 @@ def test_cancel_every_task(client):
     assert task.index_uid is None
     assert task.type == "taskCancelation"
     assert "statuses=enqueued%2Cprocessing" in tasks["results"][0]["details"]["originalFilter"]
+
+
+def test_delete_tasks_by_uid(client, empty_index, small_movies):
+    """Tests getting a task of an inexistent operation."""
+    index = empty_index()
+    task_addition = index.add_documents(small_movies)
+    task_deleted = client.delete_tasks({"uids": task_addition.task_uid})
+    client.wait_for_task(task_deleted.task_uid)
+    with pytest.raises(Exception):
+        client.get_task(task_addition.task_uid)
+    task = client.get_task(task_deleted.task_uid)
+
+    assert isinstance(task_deleted, TaskInfo)
+    assert task_deleted.task_uid is not None
+    assert task_deleted.index_uid is None
+    assert task_deleted.type == "taskDeletion"
+    assert "uids" in task["details"]["originalFilter"]
+    assert f"uids={task_addition.task_uid}" in task["details"]["originalFilter"]
+
+
+def test_delete_all_tasks(client):
+    tasks_before = client.get_tasks()
+    task = client.delete_tasks({"statuses": ["succeeded", "failed", "canceled"]})
+    client.wait_for_task(task.task_uid)
+    tasks_after = client.get_tasks()
+
+    assert isinstance(task, TaskInfo)
+    assert task.task_uid is not None
+    assert task.index_uid is None
+    assert task.type == "taskDeletion"
+    assert len(tasks_after["results"]) == 1
+    assert len(tasks_before["results"]) == len(tasks_after["results"])
+    assert (
+        "statuses=succeeded%2Cfailed%2Ccanceled"
+        in tasks_after["results"][0]["details"]["originalFilter"]
+    )

tests/conftest.py

@@ -29,6 +29,15 @@ def clear_indexes(client):
         client.wait_for_task(task["taskUid"])
 
 
+@fixture(autouse=True)
+def clear_all_tasks(client):
+    """
+    Auto-clears the tasks after each test function run.
+    Makes all the test functions independent.
+    """
+    client.delete_tasks({"statuses": ["succeeded", "failed", "canceled"]})
+
+
 @fixture(scope="function")
 def indexes_sample(client):
     indexes = []