Adds missing attributesToRetrieve option into search_index.get_objects

Author: nunomaduro

algoliasearch/search_index.py

@@ -126,9 +126,21 @@ def get_object(self, object_id, request_options=None):
     def get_objects(self, object_ids, request_options=None):
         # type: (Iterator[str], Optional[Union[dict, RequestOptions]]) -> dict
 
+        if request_options is None or isinstance(request_options, dict):
+            request_options = RequestOptions.create(
+                self._config,
+                request_options
+            )
+
         requests = []
         for object_id in object_ids:
             request = {'indexName': self._name, 'objectID': str(object_id)}
+
+            if 'attributesToRetrieve' in request_options.data:
+                request['attributesToRetrieve'] = request_options.data.pop(
+                    'attributesToRetrieve'
+                )
+
             requests.append(request)
 
         return self._transporter.read(

tests/unit/test_search_index.py

@@ -3,6 +3,7 @@
 import mock
 
 from algoliasearch.exceptions import MissingObjectIdException
+from algoliasearch.http.request_options import RequestOptions
 from algoliasearch.responses import Response
 from algoliasearch.search_index import SearchIndex
 from algoliasearch.configs import SearchConfig
@@ -98,6 +99,45 @@ def test_partial_update_objects(self):
             None,
         )
 
+    def test_get_objects(self):
+        request_options = RequestOptions.create(self.config)
+
+        requests = [{
+            'indexName': 'index-name',
+            'objectID': 'foo_id'
+        }]
+
+        self.index.get_objects(['foo_id'], request_options)
+
+        self.transporter.read.assert_called_once_with(
+            'POST',
+            '1/indexes/*/objects',
+            {'requests': requests},  # asserts version 2 it's used.
+            request_options
+        )
+
+    def test_get_objects_with_attributes_to_retreive(self):
+        request_options = RequestOptions.create(self.config, {
+            'attributesToRetrieve': ['firstname', 'lastname']
+        })
+
+        requests = [{
+            'indexName': 'index-name',
+            'objectID': 'foo_id',
+            'attributesToRetrieve': ['firstname', 'lastname']
+        }]
+
+        self.index.get_objects(['foo_id'], request_options)
+
+        self.transporter.read.assert_called_once_with(
+            'POST',
+            '1/indexes/*/objects',
+            {'requests': requests},  # asserts version 2 it's used.
+            request_options
+        )
+
+        self.assertNotIn('attributesToRetrieve', request_options.data)
+
     def test_get_settings(self):
         self.transporter.read.return_value = {
             'attributesToIndex': ['attr1', 'attr2'],