Improve parameters for get_document method

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, fields: Optional[List[str]] = None) -> 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
@@ -267,10 +267,10 @@ def get_document(self, document_id: str, fields: Optional[List[str]] = None) ->
         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 fields is None:
+        if parameters is None:
             parameters = {}
-        else:
-            parameters = {'fields': ",".join(fields)}
+        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}?{parse.urlencode(parameters)}'
         )
@@ -295,7 +295,7 @@ 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):
+        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)}'

tests/index/test_index_document_meilisearch.py

@@ -52,7 +52,7 @@ def test_get_document(index_with_documents):
 
 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'])
+    response = index_with_documents().get_document('500682', {'fields' : ['id', 'title']})
     assert isinstance(response, dict)
     assert 'title' in response
     assert 'poster' not in response
@@ -81,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):