Merge #268

268: Adding delete if exists methods r=alallema a=sanders41

Relates to meilisearch/integration-guides#107

Co-authored-by: Paul Sanders <[email protected]>

Author: bors[bot]

meilisearch/client.py

@@ -50,6 +50,32 @@ def create_index(self, uid: str, options: Optional[Dict[str, Any]] = None) -> In
         """
         return Index.create(self.config, uid, options)
 
+    def delete_index_if_exists(self, uid: str) -> bool:
+        """Deletes an index if it already exists
+
+        Parameters
+        ----------
+        uid:
+            UID of the index.
+
+        Returns
+        --------
+        Returns True if an index was deleted or False if not
+
+        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
+        """
+
+        try:
+            self.http.delete(f'{self.config.paths.index}/{uid}')
+            return True
+        except MeiliSearchApiError as error:
+            if error.error_code != "index_not_found":
+                raise error
+            return False
+
     def get_indexes(self) -> List[Index]:
         """Get all indexes.
 

meilisearch/index.py

@@ -5,6 +5,7 @@
 
 from requests import Response
 
+from meilisearch.errors import MeiliSearchApiError
 from meilisearch._httprequests import HttpRequests
 from meilisearch.config import Config
 from meilisearch.errors import MeiliSearchTimeoutError
@@ -54,6 +55,25 @@ def delete(self) -> Response:
 
         return self.http.delete(f'{self.config.paths.index}/{self.uid}')
 
+    def delete_if_exists(self) -> bool:
+        """Deletes the index if it already exists
+
+        Returns
+        --------
+        Returns True if an index was deleted or False if not
+
+        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
+        """
+        try:
+            self.delete()
+            return True
+        except MeiliSearchApiError as error:
+            if error.error_code != "index_not_found":
+                raise error
+            return False
+
     def update(self, **body: Dict[str, Any]) -> 'Index':
         """Update the index primary-key.
 

meilisearch/tests/index/test_index.py

@@ -3,8 +3,10 @@
 from datetime import datetime
 
 import pytest
+from meilisearch.client import Client
+from meilisearch.errors import MeiliSearchApiError
 from meilisearch.index import Index
-from meilisearch.tests import common
+from meilisearch.tests import BASE_URL, common, MASTER_KEY
 
 def test_create_index(client):
     """Tests creating an index."""
@@ -184,3 +186,33 @@ def test_delete_index(client):
     with pytest.raises(Exception):
         client.get_index(uid=common.INDEX_UID3)
     assert len(client.get_indexes()) == 0
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_delete_if_exists(client):
+    assert client.get_index(uid=common.INDEX_UID)
+    deleted = Client(BASE_URL, MASTER_KEY).index(common.INDEX_UID).delete_if_exists()
+    assert deleted is True
+    with pytest.raises(MeiliSearchApiError):
+        client.get_index(uid=common.INDEX_UID)
+
+def test_delete_if_exists_no_delete(client):
+    with pytest.raises(MeiliSearchApiError):
+        client.get_index(uid="none")
+
+    deleted = Client(BASE_URL, MASTER_KEY).index("none").delete_if_exists()
+    assert deleted is False
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_delete_index_if_exists(client):
+    assert client.get_index(uid=common.INDEX_UID)
+    deleted = client.delete_index_if_exists(common.INDEX_UID)
+    assert deleted is True
+    with pytest.raises(MeiliSearchApiError):
+        client.get_index(uid=common.INDEX_UID)
+
+def test_delete_index_if_exists_no_delete(client):
+    with pytest.raises(MeiliSearchApiError):
+        client.get_index(uid="none")
+
+    deleted = client.delete_index_if_exists("none")
+    assert deleted is False