Merge #372

372: Redesign update API to task API r=alallema a=alallema

### Breaking Changes
All the actions on indexes are now asynchronous:
- `create_index()`, `update_index()`, `delete_index()` return a `task` response instead of an `Index`.
- `index.create` and `index.delete` from index return a `task`.
- `wait_for_pending_update()`
    - is renamed into `wait_for_task`
    - the current `index.wait_for_task()` method call `/tasks/:uid`
- `index.get_update_status` is renamed `index.get_task`
- `index.get_all_update_status` is renamed `index.get_tasks`

**Notes:** The only two methods that now return an `Index` are `client.index()` and `client.get_index()`

### Enhancements
- new method `client.wait_for_task()` call `/tasks/:uid`
- new method `client.get_tasks` that calls `/tasks`
- new method `client.get_task` that calls `/tasks/:uid`

### Misc
- `delete_if_exists` and `get_or_create_index` are commented since we don't know yet if we will remove them or not.


Co-authored-by: alallema <[email protected]>
Co-authored-by: Amélie <[email protected]>

Author: bors[bot]

README.md

@@ -90,7 +90,7 @@ documents = [
 index.add_documents(documents) # => { "updateId": 0 }
 ```
 
-With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+With the task `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task endpoint](https://docs.meilisearch.com/reference/api/tasks.html#get-one-task).
 
 #### Basic Search <!-- omit in toc -->
 

meilisearch/client.py

@@ -2,8 +2,9 @@
 
 from meilisearch.index import Index
 from meilisearch.config import Config
+from meilisearch.task import get_task, get_tasks, wait_for_task
 from meilisearch._httprequests import HttpRequests
-from meilisearch.errors import MeiliSearchApiError, MeiliSearchError
+from meilisearch.errors import MeiliSearchError
 
 class Client():
     """
@@ -28,7 +29,7 @@ def __init__(
 
         self.http = HttpRequests(self.config)
 
-    def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> Index:
+    def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Create an index.
 
         Parameters
@@ -40,8 +41,9 @@ def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> In
 
         Returns
         -------
-        index : Index
-            An instance of Index containing the information of the newly created index.
+        task:
+            Dictionary containing a task to track the informations about the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
 
         Raises
         ------
@@ -59,8 +61,10 @@ def delete_index(self, uid: str) -> Dict[str, Any]:
             UID of the index.
 
         Returns
-        --------
-        Returns True if an index was deleted or False if not
+        -------
+        task:
+            Dictionary containing a task to track the informations about the progress of an asynchronous process.
+            https://docs.meilisearch.com/reference/api/tasks.html#get-one-task
 
         Raises
         ------
@@ -299,3 +303,66 @@ def get_dump_status(self, uid: str) -> Dict[str, str]:
         return self.http.get(
             self.config.paths.dumps + '/' + str(uid) + '/status'
         )
+
+    def get_tasks(self) -> Dict[str, List[Dict[str, Any]]]:
+        """Get all tasks.
+
+        Returns
+        -------
+        task:
+            Dictionary containing a list of all enqueued, processing, succeeded or failed tasks.
+
+        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 get_tasks(self.config)
+
+    def get_task(self, uid: int) -> Dict[str, Any]:
+        """Get one task.
+
+        Parameters
+        ----------
+        uid:
+            Identifier of the task.
+
+        Returns
+        -------
+        task:
+            Dictionary containing information about the processed asynchronous 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 get_task(self.config, uid)
+
+    def wait_for_task(
+        self, uid: int,
+        timeout_in_ms: int = 5000,
+        interval_in_ms: int = 50,
+    ) -> Dict[str, Any]:
+        """Wait until MeiliSearch processes a task until it fails or succeeds.
+
+        Parameters
+        ----------
+        uid:
+            Identifier of the task to wait for being processed.
+        timeout_in_ms (optional):
+            Time the method should wait before raising a MeiliSearchTimeoutError
+        interval_in_ms (optional):
+            Time interval the method should wait (sleep) between requests
+
+        Returns
+        -------
+        task:
+            Dictionary containing information about the processed asynchronous task.
+
+        Raises
+        ------
+        MeiliSearchTimeoutError
+            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 wait_for_task(self.config, uid, timeout_in_ms, interval_in_ms)

meilisearch/config.py

@@ -11,7 +11,7 @@ class Paths():
         keys = 'keys'
         version = 'version'
         index = 'indexes'
-        update = 'updates'
+        task = 'tasks'
         stat = 'stats'
         search = 'search'
         document = 'documents'