Add fields list and string in get_document parameters

Author: alallema

meilisearch/index.py

@@ -249,7 +249,7 @@ def search(self, query: str, opt_params: Optional[Dict[str, Any]] = None) -> Dic
             body=body
         )
 
-    def get_document(self, document_id: str, parameters: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
+    def get_document(self, document_id: str, fields: Optional[List[str]] = None) -> Dict[str, Any]:
         """Get one document with given document identifier.
 
         Parameters
@@ -267,8 +267,10 @@ def get_document(self, document_id: str, parameters: Optional[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:
+        if fields is None:
             parameters = {}
+        else:
+            parameters = {'fields': ",".join(fields)}
         return self.http.get(
             f'{self.config.paths.index}/{self.uid}/{self.config.paths.document}/{document_id}?{parse.urlencode(parameters)}'
         )
@@ -293,6 +295,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, 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', ['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):