Add index method and make the get_index method do an HTTP call

Author: curquiza

meilisearch/client.py

@@ -29,9 +29,6 @@ def __init__(self, url, apiKey=None):
     def create_index(self, uid, options=None):
         """Create an index.
 
-        If the argument `uid` isn't passed in, it will be generated
-        by MeiliSearch.
-
         Parameters
         ----------
         uid: str
@@ -42,15 +39,14 @@ def create_index(self, uid, options=None):
         Returns
         -------
         index : Index
-            an instance of Index containing the information of the newly created index
+            An instance of Index containing the information of the newly created index
         Raises
         ------
         HTTPError
             In case of any other error found here https://docs.meilisearch.com/references/#errors-status-code
         """
-        index = Index(self.config, uid)
-        index.create(self.config, uid, options)
-        return index
+        index_dict = Index.create(self.config, uid, options)
+        return Index(self.config, index_dict['uid'], index_dict['primaryKey'])
 
     def get_indexes(self):
         """Get all indexes.
@@ -64,11 +60,11 @@ def get_indexes(self):
         list
             List of indexes in dictionnary format. (e.g [{ 'uid': 'movies' 'primaryKey': 'objectID' }])
         """
-        return Index.get_indexes(self.config)
-
+        return Index.list_all(self.config)
 
     def get_index(self, uid):
-        """Get an index.
+        """Get the index.
+        This index should already exist.
 
         Raises
         ------
@@ -77,9 +73,23 @@ def get_index(self, uid):
         Returns
         -------
         index : Index
-            an instance of Index containing the information of the index found
+            An Index instance containing the information the fetched index
+        """
+        index_dict = Index(self.config, uid).fetch_info()
+        return Index(self.config, index_dict['uid'], index_dict['primaryKey'])
+
+    def index(self, uid):
+        """Create an Index instance.
+        This method doesn't trigger any HTTP call.
+
+        Returns
+        -------
+        index : Index
+            An Index instance
         """
-        return Index.get_index(self.config, uid=uid)
+        if uid is not None:
+            return Index(self.config, uid=uid)
+        raise Exception('The index UID should not be None')
 
     def get_or_create_index(self, uid, options=None):
         """Get an index, or create it if it doesn't exist.
@@ -94,19 +104,19 @@ def get_or_create_index(self, uid, options=None):
         Returns
         -------
         index : Index
-            an instance of Index containing the information of the retrieved or newly created 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
         """
-        index = self.get_index(uid)
+        index_instance = self.index(uid)
         try:
-            index.create(self.config, uid, options)
+            index_instance = self.create_index(uid, options)
         except MeiliSearchApiError as err:
             if err.error_code != 'index_already_exists':
                 raise err
-        return index
+        return index_instance
 
     def get_all_stats(self):
         """Get all stats of MeiliSearch

meilisearch/index.py

@@ -14,73 +14,78 @@ class Index():
 
     config = None
     http = None
-    uid = ""
+    uid = None
+    primary_key = None
 
-    def __init__(self, config, uid):
+    def __init__(self, config, uid, primary_key=None):
         """
         Parameters
         ----------
         config : Config
-            Config object containing permission and location of meilisearch
+            Config object containing permission and location of MeiliSearch.
         uid: str
             Uid of the index on which to perform the index actions.
         index_path: str
-            Index url path
+            Index url path.
         """
         self.config = config
-        self.uid = uid
         self.http = HttpRequests(config)
+        self.uid = uid
+        self.primary_key = primary_key
 
     def delete(self):
-        """Delete an index from meilisearch
+        """Delete the index.
 
-        Returns
-        ----------
-        update: `dict`
-            Dictionnary containing an update id to track the action:
-            https://docs.meilisearch.com/references/updates.html#get-an-update-status
+        Raises
+        ------
+        HTTPError
+            In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
         """
         return self.http.delete('{}/{}'.format(self.config.paths.index, self.uid))
 
     def update(self, **body):
-        """Update an index from meilisearch
+        """Update the index.
 
         Parameters
         ----------
         body: **kwargs
             Accepts primaryKey as an updatable parameter.
 
         Returns
-        ----------
-        update: `dict`
-            Dictionnary containing an update id to track the action:
-            https://docs.meilisearch.com/references/updates.html#get-an-update-status
+        -------
+        index: `dict`
+            Dictionnary containing index information.
         """
         payload = {}
         primary_key = body.get('primaryKey', None)
         if primary_key is not None:
             payload['primaryKey'] = primary_key
-        return self.http.put('{}/{}'.format(self.config.paths.index, self.uid), payload)
+        response = self.http.put('{}/{}'.format(self.config.paths.index, self.uid), payload)
+        self.primary_key = response['primaryKey']
+        return response
 
-    def info(self):
-        """Get info of index
+    def fetch_info(self):
+        """Fetch the info of the index.
 
         Returns
-        ----------
+        -------
         index: `dict`
-            Dictionnary containing index information.
+            Dictionnary containing the index information.
         """
-        return self.http.get('{}/{}'.format(self.config.paths.index, self.uid))
+        index_dict = self.http.get('{}/{}'.format(self.config.paths.index, self.uid))
+        self.primary_key = index_dict['primaryKey']
+        return index_dict
 
     def get_primary_key(self):
-        """Get the primary key
+        """Get the primary key.
 
         Returns
-        ----------
+        -------
         primary_key: str
             String containing primary key.
         """
-        return self.info()['primaryKey']
+        self.primary_key = self.fetch_info()['primaryKey']
+        return self.primary_key
 
     @staticmethod
     def create(config, uid, options=None):
@@ -89,14 +94,14 @@ def create(config, uid, options=None):
         Parameters
         ----------
         uid: str
-            UID of the index
+            UID of the index.
         options: dict, optional
-            Options passed during index creation (ex: primaryKey)
+            Options passed during index creation (ex: { 'primaryKey': 'name' }).
 
         Returns
         -------
         index : Index
-            an instance of Index containing the information of the newly created index
+            An instance of Index containing the information of the newly created index.
         Raises
         ------
         HTTPError
@@ -108,41 +113,22 @@ def create(config, uid, options=None):
         return HttpRequests(config).post(config.paths.index, payload)
 
     @staticmethod
-    def get_indexes(config):
-        """Get all indexes from meilisearch.
+    def list_all(config):
+        """Get all indexes
 
         Returns
         -------
         indexes : list
-            List of indexes (dict)
+            List of indexes. Each index is a dictionnary.
         Raises
         ------
         HTTPError
             In case of any error found here https://docs.meilisearch.com/references/#errors-status-code
         """
         return HttpRequests(config).get(config.paths.index)
 
-    @staticmethod
-    def get_index(config, uid):
-        """Get Index instance from given index
-
-        If the argument `uid` aren't passed in, it will raise an exception.
-
-        Returns
-        -------
-        index : Index
-            Instance of Index with the given index.
-        Raises
-        ------
-        Exception
-            If index UID is missing.
-        """
-        if uid is not None:
-            return Index(config, uid=uid)
-        raise Exception('Uid is needed to find index')
-
     def get_all_update_status(self):
-        """Get all update status from MeiliSearch
+        """Get all update status
 
         Returns
         ----------
@@ -158,7 +144,7 @@ def get_all_update_status(self):
         )
 
     def get_update_status(self, update_id):
-        """Get one update from MeiliSearch
+        """Get one update status
 
         Parameters
         ----------
@@ -224,7 +210,7 @@ def get_stats(self):
         )
 
     def search(self, query, opt_params=None):
-        """Search in meilisearch
+        """Search in the index
 
         Parameters
         ----------

meilisearch/tests/__init__.py

@@ -6,7 +6,7 @@
 def clear_all_indexes(client):
     indexes = client.get_indexes()
     for index in indexes:
-        client.get_index(index['uid']).delete()
+        client.index(index['uid']).delete()
 
 def wait_for_dump_creation(client, dump_uid):
     dump_status = client.get_dump_status(dump_uid)

meilisearch/tests/client/test_client_dumps.py

@@ -26,10 +26,10 @@ def setup_method(self, method):
         self.index.wait_for_pending_update(response['updateId'])
 
     def teardown_method(self, method):
-        self.client.get_index('indexUID-' + method.__name__).delete()
+        self.client.index('indexUID-' + method.__name__).delete()
 
     def teardown_class(self):
-        """Cleans all indexes in MEiliSearch when all the test are done"""
+        """Cleans all indexes in MeiliSearch when all the test are done"""
         clear_all_indexes(self.client)
 
     def test_dump_creation(self):