Merge #227

227: Refactored isinstance asserts to check specific types r=eskombro a=sanders41

Closes #225

I also updated the doc string in one case where the new tests found an issue.

Co-authored-by: Paul Sanders <[email protected]>

Author: bors[bot]

meilisearch/index.py

@@ -631,8 +631,8 @@ def get_distinct_attribute(self):
 
         Returns
         -------
-        settings: str
-            String containing the distinct attribute of the index.
+        settings: str | None
+            String containing the distinct attribute of the index. If no distinct attribute None is returned.
 
         Raises
         ------

meilisearch/tests/client/test_client_stats_meilisearch.py

@@ -4,7 +4,7 @@
 def test_get_all_stats(client):
     """Tests getting all stats."""
     response = client.get_all_stats()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'databaseSize' in response
     assert isinstance(response['databaseSize'], int)
     assert 'lastUpdate' in response

meilisearch/tests/errors/test_communication_error_meilisearch.py

@@ -5,6 +5,7 @@
 from meilisearch.errors import MeiliSearchCommunicationError
 from meilisearch.tests import MASTER_KEY
 
+
 def test_meilisearch_communication_error_host():
     client = meilisearch.Client("http://wrongurl:1234", MASTER_KEY)
     with pytest.raises(MeiliSearchCommunicationError):

meilisearch/tests/index/test_index_document_meilisearch.py

@@ -12,7 +12,7 @@ def test_add_documents(empty_index, small_movies):
     """Tests adding new documents to a clean index."""
     index = empty_index()
     response = index.add_documents(small_movies)
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     update = index.wait_for_pending_update(response['updateId'])
     assert index.get_primary_key() == 'id'
@@ -21,7 +21,7 @@ def test_add_documents(empty_index, small_movies):
 def test_get_document(index_with_documents):
     """Tests getting one document from a populated index."""
     response = index_with_documents().get_document('500682')
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'title' in response
     assert response['title'] == 'The Highwaymen'
 
@@ -56,7 +56,7 @@ def test_update_documents(index_with_documents, small_movies):
     response = index.get_documents()
     response[0]['title'] = 'Some title'
     update = index.update_documents([response[0]])
-    assert isinstance(update, object)
+    assert isinstance(update, dict)
     assert 'updateId' in update
     index.wait_for_pending_update(update['updateId'])
     response = index.get_documents()
@@ -70,7 +70,7 @@ def test_delete_document(index_with_documents):
     """Tests deleting a single document."""
     index = index_with_documents()
     response = index.delete_document('500682')
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     index.wait_for_pending_update(response['updateId'])
     with pytest.raises(Exception):
@@ -81,7 +81,7 @@ def test_delete_documents(index_with_documents):
     to_delete = ['522681', '450465', '329996']
     index = index_with_documents()
     response = index.delete_documents(to_delete)
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     index.wait_for_pending_update(response['updateId'])
     for document in to_delete:
@@ -92,7 +92,7 @@ def test_delete_all_documents(index_with_documents):
     """Tests deleting all the documents in the index."""
     index = index_with_documents()
     response = index.delete_all_documents()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     index.wait_for_pending_update(response['updateId'])
     response = index.get_documents()

meilisearch/tests/index/test_index_search_meilisearch.py

@@ -3,27 +3,27 @@
 def test_basic_search(index_with_documents):
     """Tests search with an simple query."""
     response = index_with_documents().search('How to Train Your Dragon')
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert response['hits'][0]['id'] == '166428'
 
 def test_basic_search_with_empty_params(index_with_documents):
     """Tests search with a simple query and empty params."""
     response = index_with_documents().search('How to Train Your Dragon', {})
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert response['hits'][0]['id'] == '166428'
     assert '_formatted' not in response['hits'][0]
 
 def test_basic_search_with_empty_query(index_with_documents):
     """Tests search with an empty query and empty params."""
     response = index_with_documents().search('')
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 20
     assert response['query'] == ''
 
 def test_basic_search_with_no_query(index_with_documents):
     """Tests search with no query [None] and empty params."""
     response = index_with_documents().search(None, {})
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 20
 
 def test_custom_search(index_with_documents):
@@ -34,7 +34,7 @@ def test_custom_search(index_with_documents):
             'attributesToHighlight': ['title']
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert response['hits'][0]['id'] == '166428'
     assert '_formatted' in response['hits'][0]
     assert 'dragon' in response['hits'][0]['_formatted']['title'].lower()
@@ -47,7 +47,7 @@ def test_custom_search_with_empty_query(index_with_documents):
             'attributesToHighlight': ['title']
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 20
     assert response['query'] == ''
 
@@ -59,7 +59,7 @@ def test_custom_search_with_no_query(index_with_documents):
             'limit': 5
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 5
 
 def test_custom_search_params_with_wildcard(index_with_documents):
@@ -73,7 +73,7 @@ def test_custom_search_params_with_wildcard(index_with_documents):
             'attributesToCrop': ['*'],
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 5
     assert '_formatted' in response['hits'][0]
     assert "title" in response['hits'][0]['_formatted']
@@ -89,7 +89,7 @@ def test_custom_search_params_with_simple_string(index_with_documents):
             'attributesToCrop': ['title'],
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 5
     assert '_formatted' in response['hits'][0]
     assert 'title' in response['hits'][0]['_formatted']
@@ -105,7 +105,7 @@ def test_custom_search_params_with_string_list(index_with_documents):
             'attributesToHighlight': ['title'],
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 5
     assert 'title' in response['hits'][0]
     assert 'overview' in response['hits'][0]
@@ -123,7 +123,7 @@ def test_custom_search_params_with_facets_distribution(index_with_documents):
             'facetsDistribution': ['genre']
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 12
     assert 'facetsDistribution' in response
     assert 'exhaustiveFacetsCount' in response
@@ -143,7 +143,7 @@ def test_custom_search_params_with_facet_filters(index_with_documents):
             'facetFilters': [['genre:action']]
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 3
     assert 'facetsDistribution' not in response
     assert 'exhaustiveFacetsCount' not in response
@@ -158,7 +158,7 @@ def test_custom_search_params_with_multiple_facet_filters(index_with_documents):
             'facetFilters': ['genre:action', ['genre:action', 'genre:action']]
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 3
     assert 'facetsDistribution' not in response
     assert 'exhaustiveFacetsCount' not in response
@@ -174,7 +174,7 @@ def test_custom_search_params_with_many_params(index_with_documents):
             'attributesToRetrieve': ['title', 'poster']
         }
     )
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert len(response['hits']) == 3
     assert 'facetsDistribution' not in response
     assert 'exhaustiveFacetsCount' not in response

meilisearch/tests/index/test_index_stats_meilisearch.py

@@ -3,7 +3,7 @@
 def test_get_stats(empty_index):
     """Tests getting stats of an index."""
     response = empty_index().get_stats()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'numberOfDocuments' in response
     assert response['numberOfDocuments'] == 0
     assert 'isIndexing' in response

meilisearch/tests/index/test_index_wait_for_pending_update.py

@@ -10,7 +10,7 @@ def test_wait_for_pending_update_default(index_with_documents):
     response = index.add_documents([{'id': 1, 'title': 'Le Petit Prince'}])
     assert 'updateId' in response
     update = index.wait_for_pending_update(response['updateId'])
-    assert isinstance(update, object)
+    assert isinstance(update, dict)
     assert 'status' in update
     assert update['status'] != 'enqueued'
 
@@ -31,7 +31,7 @@ def test_wait_for_pending_update_interval_custom(index_with_documents, small_mov
         timeout_in_ms=6000
     )
     time_delta = datetime.now() - start_time
-    assert isinstance(wait_update, object)
+    assert isinstance(wait_update, dict)
     assert 'status' in wait_update
     assert wait_update['status'] != 'enqueued'
     assert time_delta.seconds >= 1
@@ -46,6 +46,6 @@ def test_wait_for_pending_update_interval_zero(index_with_documents, small_movie
         interval_in_ms=0,
         timeout_in_ms=6000
     )
-    assert isinstance(wait_update, object)
+    assert isinstance(wait_update, dict)
     assert 'status' in wait_update
     assert wait_update['status'] != 'enqueued'

meilisearch/tests/settings/test_settings.py

@@ -16,7 +16,7 @@
 def test_get_settings_default(empty_index):
     """Tests getting all settings by default."""
     response = empty_index().get_settings()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     for rule in DEFAULT_RANKING_RULES:
         assert rule in response['rankingRules']
     assert response['distinctAttribute'] is None
@@ -29,7 +29,7 @@ def test_update_settings(empty_index):
     """Tests updating some settings."""
     index = empty_index()
     response = index.update_settings(NEW_SETTINGS)
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     update = index.wait_for_pending_update(response['updateId'])
     assert update['status'] == 'processed'
@@ -62,7 +62,7 @@ def test_reset_settings(empty_index):
     assert response['synonyms'] == {}
     # Check the reset of the settings
     response = index.reset_settings()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     update = index.wait_for_pending_update(response['updateId'])
     assert update['status'] == 'processed'

meilisearch/tests/settings/test_settings_attributes_for_faceting_meilisearch.py

@@ -5,7 +5,7 @@
 def test_get_attributes_for_faceting(empty_index):
     """Tests getting the attributes for faceting."""
     response = empty_index().get_attributes_for_faceting()
-    assert isinstance(response, object)
+    assert isinstance(response, list)
     assert response == []
 
 def test_update_attributes_for_faceting(empty_index):
@@ -34,9 +34,9 @@ def test_reset_attributes_for_faceting(empty_index):
         assert attribute in get_attributes
     # Check the reset of the settings
     response = index.reset_attributes_for_faceting()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     index.wait_for_pending_update(response['updateId'])
     response = index.get_attributes_for_faceting()
-    assert isinstance(response, object)
+    assert isinstance(response, list)
     assert response == []

meilisearch/tests/settings/test_settings_displayed_attributes_meilisearch.py

@@ -7,7 +7,7 @@ def test_get_displayed_attributes(empty_index, small_movies):
     """Tests getting the displayed attributes before and after indexing a dataset."""
     index =  empty_index()
     response = index.get_displayed_attributes()
-    assert isinstance(response, object)
+    assert isinstance(response, list)
     assert response == ['*']
     response = index.add_documents(small_movies)
     index.wait_for_pending_update(response['updateId'])
@@ -38,7 +38,7 @@ def test_reset_displayed_attributes(empty_index):
         assert attribute in get_attributes_new
     # Check the reset of the settings
     response = index.reset_displayed_attributes()
-    assert isinstance(response, object)
+    assert isinstance(response, dict)
     assert 'updateId' in response
     index.wait_for_pending_update(response['updateId'])
     get_attributes = index.get_displayed_attributes()