Adding raw index methods

Author: sanders41

meilisearch/client.py

@@ -52,6 +52,32 @@ def create_index(self, uid, options=None):
     def get_indexes(self):
         """Get all indexes.
 
+        Returns
+        -------
+        indexes: list
+            List of Index instances.
+
+        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
+        """
+        response = self.http.get(self.config.paths.index)
+
+        return [
+            Index(
+                self.config,
+                x["uid"],
+                x["primaryKey"],
+                x["createdAt"],
+                x["updatedAt"],
+            )
+            for x in response
+        ]
+
+    def get_raw_indexes(self):
+        """Get all indexes in dictionary format.
+
         Returns
         -------
         indexes: list
@@ -85,6 +111,27 @@ def get_index(self, uid):
         """
         return Index(self.config, uid).fetch_info()
 
+    def get_raw_index(self, uid):
+        """Get the index as a dictionary.
+        This index should already exist.
+
+        Parameters
+        ----------
+        uid: str
+            UID of the index.
+
+        Returns
+        -------
+        index : dict
+            An index in dictionary format. (e.g { 'uid': 'movies' 'primaryKey': 'objectID' })
+
+        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 self.http.get(f'{self.config.paths.index}/{uid}')
+
     def index(self, uid):
         """Create a local reference to an index identified by UID, without doing an HTTP call.
         Calling this method doesn't create an index in the MeiliSearch instance, but grants access to all the other methods in the Index class.

meilisearch/index.py

@@ -18,7 +18,7 @@ class Index():
     uid = None
     primary_key = None
 
-    def __init__(self, config, uid, primary_key=None):
+    def __init__(self, config, uid, primary_key=None, created_at=None, updated_at=None):
         """
         Parameters
         ----------
@@ -33,6 +33,8 @@ def __init__(self, config, uid, primary_key=None):
         self.http = HttpRequests(config)
         self.uid = uid
         self.primary_key = primary_key
+        self.created_at = self._iso_to_date_time(created_at)
+        self.updated_at = self._iso_to_date_time(updated_at)
 
     def delete(self):
         """Delete the index.
@@ -69,6 +71,8 @@ def update(self, **body):
             payload['primaryKey'] = primary_key
         response = self.http.put(f'{self.config.paths.index}/{self.uid}', payload)
         self.primary_key = response['primaryKey']
+        self.created_at = self._iso_to_date_time(response['createdAt'])
+        self.updated_at = self._iso_to_date_time(response['updatedAt'])
         return self
 
     def fetch_info(self):
@@ -86,6 +90,8 @@ def fetch_info(self):
         """
         index_dict = self.http.get(f'{self.config.paths.index}/{self.uid}')
         self.primary_key = index_dict['primaryKey']
+        self.created_at = self._iso_to_date_time(index_dict['createdAt'])
+        self.updated_at = self._iso_to_date_time(index_dict['updatedAt'])
         return self
 
     def get_primary_key(self):
@@ -935,5 +941,29 @@ def reset_attributes_for_faceting(self):
             self.__settings_url_for(self.config.paths.attributes_for_faceting),
         )
 
+    @staticmethod
+    def _iso_to_date_time(iso_date):
+        """
+        MeiliSearch returns the date time information in iso format. Python's implementation of
+        datetime can only handle up to 6 digits in microseconds, however MeiliSearch sometimes
+        returns more digits than this in the micosecond sections so when that happens this method
+        reduces the number of microseconds so Python can handle it. If the value passed is either
+        None or already in datetime format the original value is returned.
+        """
+        if not iso_date:
+            return None
+
+        if isinstance(iso_date, datetime):
+            return iso_date
+
+        try:
+            return datetime.strptime(iso_date, "%Y-%m-%dT%H:%M:%S.%fZ")
+        except ValueError:
+            split = iso_date.split(".")
+            reduce = len(split[1]) - 6
+            reduced = f"{split[0]}.{split[1][:-reduce]}Z"
+            return datetime.strptime(reduced, "%Y-%m-%dT%H:%M:%S.%fZ")
+
+
     def __settings_url_for(self, sub_route):
         return f'{self.config.paths.index}/{self.uid}/{self.config.paths.setting}/{sub_route}'

meilisearch/tests/conftest.py

@@ -20,7 +20,7 @@ def clear_indexes(client):
     # Deletes all the indexes in the MeiliSearch instance.
     indexes = client.get_indexes()
     for index in indexes:
-        client.index(index['uid']).delete()
+        client.index(index.uid).delete()
 
 @fixture(scope='function')
 def indexes_sample(client):

meilisearch/tests/index/test_index.py

@@ -1,5 +1,7 @@
 # pylint: disable=invalid-name
 
+from datetime import datetime
+
 import pytest
 from meilisearch.index import Index
 from meilisearch.tests import common
@@ -32,6 +34,16 @@ def test_create_index_with_uid_in_options(client):
 def test_get_indexes(client):
     """Tests getting all indexes."""
     response = client.get_indexes()
+    uids = [index.uid for index in response]
+    assert isinstance(response, list)
+    assert common.INDEX_UID in uids
+    assert common.INDEX_UID2 in uids
+    assert common.INDEX_UID3 in uids
+    assert len(response) == 3
+
+@pytest.mark.usefixtures("indexes_sample")
+def test_get_raw_indexes(client):
+    response = client.get_raw_indexes()
     uids = [index['uid'] for index in response]
     assert isinstance(response, list)
     assert common.INDEX_UID in uids
@@ -44,6 +56,8 @@ def test_index_with_any_uid(client):
     assert isinstance(index, Index)
     assert index.uid == 'anyUID'
     assert index.primary_key is None
+    assert index.created_at is None
+    assert index.updated_at is None
     assert index.config is not None
     assert index.http is not None
 
@@ -57,6 +71,8 @@ def test_get_index_with_valid_uid(client):
     response = client.get_index(uid=common.INDEX_UID)
     assert isinstance(response, Index)
     assert response.uid == common.INDEX_UID
+    assert isinstance(response.created_at, datetime)
+    assert isinstance(response.updated_at, datetime)
 
 def test_get_index_with_none_uid(client):
     """Test raising an exception if the index UID is None."""
@@ -68,6 +84,20 @@ def test_get_index_with_wrong_uid(client):
     with pytest.raises(Exception):
         client.get_index(uid='wrongUID')
 
+@pytest.mark.usefixtures("indexes_sample")
+def test_get_raw_index_with_valid_uid(client):
+    response = client.get_raw_index(uid=common.INDEX_UID)
+    assert isinstance(response, dict)
+    assert response["uid"] == common.INDEX_UID
+
+def test_get_raw_index_with_none_uid(client):
+    with pytest.raises(Exception):
+        client.get_raw_index(uid=None)
+
+def test_get_raw_index_with_wrong_uid(client):
+    with pytest.raises(Exception):
+        client.get_raw_index(uid='wrongUID')
+
 def test_get_or_create_index(client):
     """Test get_or_create_index method."""
     index_1 = client.get_or_create_index(common.INDEX_UID4)
@@ -135,6 +165,8 @@ def test_update_index(client):
     assert isinstance(response, Index)
     assert index.primary_key == 'objectID'
     assert index.get_primary_key() == 'objectID'
+    assert isinstance(index.created_at, datetime)
+    assert isinstance(index.updated_at, datetime)
 
 @pytest.mark.usefixtures("indexes_sample")
 def test_delete_index(client):