Merge pull request #492 from meilisearch/documents_changes

Add pagination parameters to the `get_document()` method

Author: alallema

meilisearch/index.py

@@ -249,13 +249,15 @@ def search(self, query: str, opt_params: Optional[Dict[str, Any]] = None) -> Dic
             body=body
         )
 
-    def get_document(self, document_id: str) -> Dict[str, Any]:
+    def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
         """Get one document with given document identifier.
 
         Parameters
         ----------
         document_id:
             Unique identifier of the document.
+        parameters (optional):
+            parameters accepted by the get document route: https://docs.meilisearch.com/reference/api/documents.html#get-one-document
 
         Returns
         -------
@@ -267,8 +269,12 @@ def get_document(self, document_id: str) -> Dict[str, Any]:
         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
         """
+        if parameters is None:
+            parameters = {}
+        elif 'fields' in parameters and isinstance(parameters['fields'], list):
+            parameters['fields'] = ",".join(parameters['fields'])
         return self.http.get(
-            f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}'
+            f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}?{parse.urlencode(parameters)}'
         )
 
     def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
@@ -291,6 +297,8 @@ def get_documents(self, parameters: Optional[Dict[str, Any]] = None) -> List[Dic
         """
         if parameters is None:
             parameters = {}
+        elif 'fields' in parameters and isinstance(parameters['fields'], list):
+            parameters['fields'] = ",".join(parameters['fields'])
         return self.http.get(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}?{parse.urlencode(parameters)}'
         )

meilisearch/task.py

@@ -29,10 +29,11 @@ def get_tasks(config: Config, parameters: Optional[Dict[str, Any]] = None) -> Di
         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
     """
     http = HttpRequests(config)
-    if parameters is None or parameters == {}:
+    if parameters is None:
         parameters = {}
-    elif 'indexUid' in parameters:
-        parameters['indexUid'] = ",".join(parameters['indexUid'])
+    for param in parameters:
+        if isinstance(parameters[param], list):
+            parameters[param] = ",".join(parameters[param])
     return http.get(
         f"{config.paths.task}?{parse.urlencode(parameters)}"
     )

tests/index/test_index_document_meilisearch.py

@@ -50,6 +50,14 @@ def test_get_document(index_with_documents):
     assert 'title' in response
     assert response['title'] == 'The Highwaymen'
 
+def test_get_document_with_fields(index_with_documents):
+    """Tests getting one document from a populated index."""
+    response = index_with_documents().get_document('500682', {'fields' : ['id', 'title']})
+    assert isinstance(response, dict)
+    assert 'title' in response
+    assert 'poster' not in response
+    assert response['title'] == 'The Highwaymen'
+
 def test_get_document_inexistent(empty_index):
     """Tests getting one inexistent document from a populated index."""
     with pytest.raises(Exception):
@@ -73,6 +81,7 @@ def test_get_documents_offset_optional_params(index_with_documents):
         'fields': 'title'
     })
     assert len(response_offset_limit['results']) == 3
+    assert 'title' in response_offset_limit['results'][0]
     assert response_offset_limit['results'][0]['title'] == response['results'][1]['title']
 
 def test_update_documents(index_with_documents, small_movies):

tests/index/test_index_task_meilisearch.py

@@ -12,7 +12,7 @@ def test_get_tasks_default(index_with_documents):
 
 def test_get_tasks(empty_index, small_movies):
     """Tests getting the tasks list of a populated index."""
-    index = empty_index()
+    index = empty_index("test_task")
     current_tasks = index.get_tasks()
     pre_count = len(current_tasks['results'])
     response = index.add_documents(small_movies)