Merge #250

250: Changes related to the next MeiliSearch release (v0.21.0) r=alallema a=meili-bot

Related to this issue: meilisearch/integration-guides#117

This PR:
- gathers the changes related to the next MeiliSearch release (v0.21.0) so that this package is ready when the official release is out.
- should pass the tests against the [latest pre-release of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases). Until there is an RC version, the tests should be valid against the [alpha versions of transplant](https://github.com/meilisearch/transplant/releases).
- might eventually contain test failures until the MeiliSearch v0.21.0 is out.

⚠️ This PR should NOT be merged until the next release of MeiliSearch (v0.21.0) is out.

_This PR is auto-generated for the [pre-release week](https://github.com/meilisearch/integration-guides/blob/master/guides/pre-release-week.md) purpose. Exceptionally for this release, the pre-release time will be more than just one week._

Done:
- Update README #286 
- Rename `attributes_for_faceting` into `filterable_attributes` #287 #292 
- Update `WaitForPendingUpdate` status #288
- Adapts tests according to v0.21.0 breaking changes #289
    - Rename fields `buildDate` into `commitDate`
    - Update `rankingRules`
    - `exhaustiveFacetsCount` return `False`
- Add missing tests according to new features #290
    - Phrase search tests
    - Filter/facet on number is now doable
    - Test the syntax on Filter array and string
- Update code sample file #291 #293

Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Clémentine Urquizar <[email protected]>
Co-authored-by: Amélie <[email protected]>
Co-authored-by: alallema <[email protected]>

Author: 4 people

.code-samples.meilisearch.yaml

@@ -50,11 +50,10 @@ get_settings_1: |-
 update_settings_1: |-
   client.index('movies').update_settings({
     'rankingRules': [
-        'typo',
         'words',
+        'typo',
         'proximity',
         'attribute',
-        'wordsPosition',
         'exactness',
         'desc(release_date)',
         'desc(rank)'
@@ -104,11 +103,10 @@ get_ranking_rules_1: |-
   client.index('movies').get_ranking_rules()
 update_ranking_rules_1: |-
   client.index('movies').update_ranking_rules([
-      'typo',
       'words',
+      'typo',
       'proximity',
       'attribute',
-      'wordsPosition',
       'exactness',
       'asc(release_date)',
       'desc(rank)'
@@ -121,6 +119,15 @@ update_distinct_attribute_1: |-
   client.index('movies').update_distinct_attribute('movie_id')
 reset_distinct_attribute_1: |-
   client.index('movies').reset_distinct_attribute()
+get_filterable_attributes_1: |-
+  client.index('movies').get_filterable_attributes()
+update_filterable_attributes_1: |-
+  client.index('movies').update_filterable_attributes([
+    'genres',
+    'director'
+  ])
+reset_filterable_attributes_1: |-
+  client.index('movies').reset_filterable_attributes()
 get_searchable_attributes_1: |-
   client.index('movies').get_searchable_attributes()
 update_searchable_attributes_1: |-
@@ -135,11 +142,10 @@ get_displayed_attributes_1: |-
   client.index('movies').get_displayed_attributes()
 update_displayed_attributes_1: |-
   client.index('movies').update_displayed_attributes([
-      "title",
+      'title',
       'description',
-      'release_date',
-      'rank',
-      'poster'
+      'genre',
+      'release_date'
   ])
 reset_displayed_attributes_1: |-
   client.index('movies').reset_displayed_attributes()
@@ -170,19 +176,19 @@ field_properties_guide_displayed_1: |-
   ]})
 filtering_guide_1: |-
   client.index('movies').search('Avengers', {
-    'filters': 'release_date > 795484800'
+    'filter': 'release_date > 795484800'
   })
 filtering_guide_2: |-
   client.index('movies').search('Batman', {
-    'filters': 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")'
+    'filter': 'release_date > 795484800 AND (director = "Tim Burton" OR director = "Christopher Nolan")'
   })
 filtering_guide_3: |-
   client.index('movies').search('horror', {
-    'filters': 'director = "Jordan Peele"'
+    'filter': 'director = "Jordan Peele"'
   })
 filtering_guide_4: |-
   client.index('movies').search('Planet of the Apes', {
-    'filters': 'rating >= 3 AND (NOT director = "Tim Burton")'
+    'filter': 'rating >= 3 AND (NOT director = "Tim Burton")'
   })
 search_parameter_guide_query_1: |-
   client.index('movies').search('shifu')
@@ -204,25 +210,23 @@ search_parameter_guide_crop_1: |-
     'cropLength': 10
   })
 search_parameter_guide_highlight_1: |-
-  client.index('movies').search('shifu', {
+  client.index('movies').search('winter feast', {
     'attributesToHighlight': ['overview']
   })
 search_parameter_guide_filter_1: |-
   client.index('movies').search('n', {
-    'filters': 'title = Nightshift'
+    'filter': 'title = Nightshift'
   })
 search_parameter_guide_filter_2: |-
-  client.index('movies').search('n', {
-    'filters': 'title = "Kung Fu Panda"'
+  client.index('movies').search('shifu', {
+    'filter': 'title = "Kung Fu Panda"'
   })
 search_parameter_guide_matches_1: |-
-  client.index('movies').search('n', {
-    'filters': 'title = "Kung Fu Panda"',
-    'attributesToHighlight': ['overview'],
+  client.index('movies').search('winter feast', {
     'matches': 'true'
   })
 settings_guide_synonyms_1: |-
-  client.index('movies').update_settings({
+  client.index('tops').update_settings({
     'synonyms': {
       sweater: ['jumper'],
       jumper: ['sweater']
@@ -239,18 +243,17 @@ settings_guide_stop_words_1: |-
 settings_guide_ranking_rules_1: |-
   client.index('movies').update_settings({
     'rankingRules': [
-        'typo',
         'words',
+        'typo',
         'proximity',
         'attribute',
-        'wordsPosition',
         'exactness',
         'asc(release_date)',
         'desc(rank)'
     ]
   })
 settings_guide_distinct_1: |-
-  client.index('movies').update_settings({
+  client.index('jackets').update_settings({
     'distinctAttribute': 'product_id'
   })
 settings_guide_searchable_1: |-
@@ -270,6 +273,12 @@ settings_guide_displayed_1: |-
       'release_date'
     ]
   })
+add_movies_json_1: |-
+  import json
+
+  json_file = open('movies.json')
+  movies = json.load(json_file)
+  client.index('movies').add_documents(movies)
 documents_guide_add_movie_1: |-
   client.index('movies').add_documents([{
     'movie_id': '123sq178',
@@ -282,7 +291,7 @@ search_guide_1: |-
   })
 search_guide_2: |-
   client.index('movies').search('Avengers', {
-    'filters': 'release_date > 795484800'
+    'filter': 'release_date > 795484800'
   })
 getting_started_add_documents_md: |-
   ```bash
@@ -308,28 +317,28 @@ getting_started_search_md: |-
 
   [About this SDK](https://github.com/meilisearch/meilisearch-python/)
 faceted_search_update_settings_1: |-
-  client.index('movies').update_attributes_for_faceting([
+  client.index('movies').update_filterable_attributes([
       'director',
       'genres',
   ])
-faceted_search_facet_filters_1: |-
+faceted_search_filter_1: |-
   client.index('movies').search('thriller', {
-    'facetFilters': [['genres:Horror', 'genres:Mystery'], 'director:Jordan Peele']
+    'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
   })
 faceted_search_facets_distribution_1: |-
   client.index('movies').search('Batman', {
     'facetsDistribution': ['genres']
   })
-faceted_search_walkthrough_attributes_for_faceting_1: |-
-  client.index('movies').update_attributes_for_faceting([
+faceted_search_walkthrough_filterable_attributes_1: |-
+  client.index('movies').update_filterable_attributes([
       'director',
       'producer',
       'genres',
       'production_companies'
   ])
-faceted_search_walkthrough_facet_filters_1: |-
+faceted_search_walkthrough_filter_1: |-
   client.index('movies').search('thriller', {
-    'facetFilters': [['genres:Horror', 'genres:Mystery'], 'director:Jordan Peele']
+    'filter': [['genres = Horror', 'genres = Mystery'], 'director = "Jordan Peele"']
   })
 faceted_search_walkthrough_facets_distribution_1: |-
   client.index('movies').search('Batman', {
@@ -339,18 +348,5 @@ post_dump_1: |-
   client.create_dump()
 get_dump_status_1: |-
   client.get_dump_status('20201101-110357260')
-get_attributes_for_faceting_1: |-
-  client.index('movies').get_attributes_for_faceting()
-update_attributes_for_faceting_1: |-
-  client.index('movies').update_attributes_for_faceting([
-    'genres',
-    'director'
-  ])
-reset_attributes_for_faceting_1: |-
-  client.index('movies').reset_attributes_for_faceting()
-add_movies_json_1: |-
-  import json
-
-  json_file = open('movies.json')
-  movies = json.load(json_file)
-  client.index('movies').add_documents(movies)
+phrase_search_1: |-
+  client.index('movies').search('"african american" horror')

README.md

@@ -87,7 +87,7 @@ documents = [
 index.add_documents(documents) # => { "updateId": 0 }
 ```
 
-With the `updateId`, you can check the status (`enqueued`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
+With the `updateId`, you can check the status (`enqueued`, `processing`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/reference/api/updates.html#get-an-update-status).
 
 #### Basic Search <!-- omit in toc -->
 
@@ -117,10 +117,9 @@ All the supported options are described in the [search parameters](https://docs.
 
 ```python
 index.search(
-  'prince',
+  'hob',
   {
-    'attributesToHighlight': ['title'],
-    'filters': 'book_id > 10'
+    'attributesToHighlight': ['*'],
   }
 )
 ```
@@ -131,24 +130,24 @@ JSON output:
 {
     "hits": [
         {
-            "book_id": 456,
-            "title": "Le Petit Prince",
+            "book_id": 1344,
+            "title": "The Hobbit",
             "_formatted": {
-                "book_id": 456,
-                "title": "Le Petit <em>Prince</em>"
+                "book_id": 1344,
+                "title": "The <em>Hob</em>bit"
             }
         }
     ],
     "offset": 0,
     "limit": 20,
-    "processingTimeMs": 10,
-    "query": "prince"
+    "processingTimeMs": 0,
+    "query": "hob"
 }
 ```
 
 ## 🤖 Compatibility with MeiliSearch
 
-This package only guarantees the compatibility with the [version v0.20.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.20.0).
+This package only guarantees the compatibility with the [version v0.21.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.21.0).
 
 ## 💡 Learn More
 

meilisearch/config.py

@@ -23,7 +23,7 @@ class Paths():
         stop_words = 'stop-words'
         synonyms = 'synonyms'
         accept_new_fields = 'accept-new-fields'
-        attributes_for_faceting = 'attributes-for-faceting'
+        filterable_attributes = 'filterable-attributes'
         dumps = 'dumps'
 
     def __init__(

meilisearch/index.py

@@ -151,7 +151,7 @@ def get_all_update_status(self) -> List[Dict[str, Any]]:
         Returns
         -------
         update:
-            List of all enqueued and processed actions of the index.
+            List of all enqueued, processing, processed or failed actions of the index.
 
         Raises
         ------
@@ -215,7 +215,7 @@ def wait_for_pending_update(
         while elapsed_time < timeout_in_ms:
             get_update = self.get_update_status(update_id)
 
-            if get_update['status'] != 'enqueued':
+            if get_update['status'] != 'enqueued' and get_update['status'] != 'processing':
                 return get_update
             sleep(interval_in_ms / 1000)
             time_delta = datetime.now() - start_time
@@ -973,34 +973,34 @@ def reset_synonyms(self) -> Dict[str, int]:
             self.__settings_url_for(self.config.paths.synonyms),
         )
 
-    # ATTRIBUTES FOR FACETING SUB-ROUTES
+    # FILTERABLE ATTRIBUTES SUB-ROUTES
 
-    def get_attributes_for_faceting(self) -> List[str]:
+    def get_filterable_attributes(self) -> List[str]:
         """
-        Get attributes for faceting of the index.
+        Get filterable attributes of the index.
 
         Returns
         -------
         settings:
-            List containing the attributes for faceting of the index
+            List containing the filterable attributes of the index
 
         Raises
         ------
         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
         """
         return self.http.get(
-            self.__settings_url_for(self.config.paths.attributes_for_faceting)
+            self.__settings_url_for(self.config.paths.filterable_attributes)
         )
 
-    def update_attributes_for_faceting(self, body: List[str]) -> Dict[str, int]:
+    def update_filterable_attributes(self, body: List[str]) -> Dict[str, int]:
         """
-        Update attributes for faceting of the index.
+        Update filterable attributes of the index.
 
         Parameters
         ----------
         body:
-            List containing the attributes for faceting.
+            List containing the filterable attributes.
 
         Returns
         -------
@@ -1014,12 +1014,12 @@ def update_attributes_for_faceting(self, body: List[str]) -> Dict[str, int]:
             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
         """
         return self.http.post(
-            self.__settings_url_for(self.config.paths.attributes_for_faceting),
+            self.__settings_url_for(self.config.paths.filterable_attributes),
             body
         )
 
-    def reset_attributes_for_faceting(self) -> Dict[str, int]:
-        """Reset attributes for faceting of the index to default values.
+    def reset_filterable_attributes(self) -> Dict[str, int]:
+        """Reset filterable attributes of the index to default values.
 
         Returns
         -------
@@ -1033,7 +1033,7 @@ def reset_attributes_for_faceting(self) -> Dict[str, int]:
             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
         """
         return self.http.delete(
-            self.__settings_url_for(self.config.paths.attributes_for_faceting),
+            self.__settings_url_for(self.config.paths.filterable_attributes),
         )
 
     @staticmethod

meilisearch/tests/client/test_client_version_meilisearch.py

@@ -4,4 +4,4 @@ def test_get_version(client):
     response = client.get_version()
     assert 'pkgVersion' in response
     assert 'commitSha' in response
-    assert 'buildDate' in response
+    assert 'commitDate' in response