Implement get_or_create_index method and add tests

Author: eskombro

meilisearch/client.py

@@ -1,6 +1,7 @@
 from meilisearch.index import Index
 from meilisearch.config import Config
 from meilisearch._httprequests import HttpRequests
+from meilisearch.errors import MeiliSearchApiError
 
 class Client():
     """
@@ -80,6 +81,34 @@ def get_index(self, uid):
         """
         return Index.get_index(self.config, uid=uid)
 
+    def get_or_create_index(self, uid, options=None):
+        """Get an index, or create it if it doesn't exist.
+
+        Parameters
+        ----------
+        uid: str
+            UID of the index
+        options: dict, optional
+            Options passed during index creation (ex: primaryKey)
+
+        Returns
+        -------
+        index : Index
+            an instance of Index containing the information of the retrieved or newly created index
+        Raises
+        ------
+        HTTPError
+            In case of any other error found here https://docs.meilisearch.com/references/#errors-status-code
+        """
+        try:
+            index = Index(self.config, uid)
+            index.create(self.config, uid, options)
+        except MeiliSearchApiError as e:
+            if e.message != 'index already exists':
+                raise e
+            index = self.get_index(uid)
+        return index
+
     def get_all_stats(self):
         """Get all stats of MeiliSearch
 

meilisearch/tests/index/test_index.py

@@ -56,6 +56,23 @@ def test_get_index_with_none_uid(self):
         with pytest.raises(Exception):
             self.client.get_index(uid=None)
 
+    def test_get_or_create_index(self):
+        """Test get_or_create_index method"""
+        index_1 = self.client.get_or_create_index('book_id')
+        index_2 = self.client.get_or_create_index('book_id')
+        index_3 = self.client.get_or_create_index('book_id')
+        assert index_1.uid == index_2.uid == index_3.uid == 'book_id'
+        update = index_1.add_documents([{
+            'id': 1,
+            'name': "Some book"
+        }])
+        index_1.wait_for_pending_update(update['updateId'])
+        documents = index_2.get_documents()
+        assert len(documents) == 1
+        index_2.delete()
+        with pytest.raises(Exception):
+            self.client.get_index(index_3).info()
+
     def test_index_info(self):
         """Tests getting an index's info"""
         index = self.client.get_index(uid=self.index_uid)