Merge branch 'main' into bump-meilisearch-v0.23.0

Author: alallema

CONTRIBUTING.md

@@ -15,9 +15,9 @@ It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest
 
 🚀 If your PR gets accepted it will count into your participation to Hacktoberfest!
 
-✅ To be accepted it has either to have been merged, approved or tagged with the `hacktoberest-accepted` label.
+✅ To be accepted it has either to have been merged, approved or tagged with the `hacktoberfest-accepted` label.
 
-🧐 Don't forget to check the [quality standards](https://hacktoberfest.digitalocean.com/resources/qualitystandards), otherwise your PR could be marked as `spam` or `invalid`, and it will not be counted toward your participation in Hacktoberfest.
+🧐 Don't forget to check the [quality standards](https://hacktoberfest.digitalocean.com/resources/qualitystandards)! Low-quality PRs might get marked as `spam` or `invalid`, and will not count toward your participation in Hacktoberfest.
 
 ## Assumptions
 
@@ -30,7 +30,7 @@ It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest
 1. Make sure that the contribution you want to make is explained or detailed in a GitHub issue! Find an [existing issue](https://github.com/meilisearch/meilisearch-python/issues/) or [open a new one](https://github.com/meilisearch/meilisearch-python/issues/new).
 2. Once done, [fork the meilisearch-python repository](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) in your own GitHub account. Ask a maintainer if you want your issue to be checked before making a PR.
 3. [Create a new Git branch](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository).
-4. Review the [Development Workflow](#workflow) section that describes the steps to maintain the repository.
+4. Review the [Development Workflow](#development-workflow) section that describes the steps to maintain the repository.
 5. Make the changes on your branch.
 6. [Submit the branch as a PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) pointing to the `main` branch of the main meilisearch-python repository. A maintainer should comment and/or review your Pull Request within a few days. Although depending on the circumstances, it may take longer.<br>
  We do not enforce a naming convention for the PRs, but **please use something descriptive of your changes**, having in mind that the title of your PR will be automatically added to the next [release changelog](https://github.com/meilisearch/meilisearch-python/releases/).
@@ -103,7 +103,7 @@ Some notes on GitHub PRs:
 
 - [Convert your PR as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/changing-the-stage-of-a-pull-request) if your changes are a work in progress: no one will review it until you pass your PR as ready for review.<br>
   The draft PR can be very useful if you want to show that you are working on something and make your work visible.
-- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually..
+- The branch related to the PR must be **up-to-date with `main`** before merging. Fortunately, this project [integrates a bot](https://github.com/meilisearch/integration-guides/blob/main/guides/bors.md) to automatically enforce this requirement without the PR author having to do it manually.
 - All PRs must be reviewed and approved by at least one maintainer.
 - The PR title should be accurate and descriptive of the changes. The title of the PR will be indeed automatically added to the next [release changelogs](https://github.com/meilisearch/meilisearch-python/releases/).
 

Pipfile.lock

@@ -72,18 +72,18 @@ import meilisearch
 client = meilisearch.Client('http://127.0.0.1:7700', 'masterKey')
 
 # An index is where the documents are stored.
-index = client.index('books')
+index = client.index('movies')
 
 documents = [
-  { 'book_id': 123,  'title': 'Pride and Prejudice' },
-  { 'book_id': 456,  'title': 'Le Petit Prince' },
-  { 'book_id': 1,    'title': 'Alice In Wonderland' },
-  { 'book_id': 1344, 'title': 'The Hobbit' },
-  { 'book_id': 4,    'title': 'Harry Potter and the Half-Blood Prince' },
-  { 'book_id': 42,   'title': 'The Hitchhiker\'s Guide to the Galaxy' }
+      { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
+      { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
+      { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
+      { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
+      { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
+      { id: 6, title: 'Philadelphia', genres: ['Drama'] },
 ]
 
-# If the index 'books' does not exist, MeiliSearch creates it when you first add the documents.
+# If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
 index.add_documents(documents) # => { "updateId": 0 }
 ```
 
@@ -93,21 +93,24 @@ With the `updateId`, you can check the status (`enqueued`, `processing`, `proces
 
 ``` python
 # MeiliSearch is typo-tolerant:
-index.search('harry pottre')
+index.search('caorl')
 ```
 
 Output:
 
-```python
+```json
 {
-  "hits" => [{
-    "book_id" => 4,
-    "title" => "Harry Potter and the Half-Blood Prince"
-  }],
-  "offset" => 0,
-  "limit" => 20,
-  "processingTimeMs" => 1,
-  "query" => "harry pottre"
+    "hits": [
+        {
+            "id": 1,
+            "title": "Carol",
+            "genre": ["Romance", "Drama"]
+        }
+    ],
+    "offset": 0,
+    "limit": 20,
+    "processingTimeMs": 1,
+    "query": "caorl"
 }
 ```
 
@@ -117,7 +120,7 @@ All the supported options are described in the [search parameters](https://docs.
 
 ```python
 index.search(
-  'hob',
+  'phil',
   {
     'attributesToHighlight': ['*'],
   }
@@ -130,18 +133,19 @@ JSON output:
 {
     "hits": [
         {
-            "book_id": 1344,
-            "title": "The Hobbit",
+            "id": 6,
+            "title": "Philadelphia",
             "_formatted": {
-                "book_id": 1344,
-                "title": "The <em>Hob</em>bit"
+                "id": 6,
+                "title": "<em>Phil</em>adelphia",
+                "genre": ["Drama"]
             }
         }
     ],
     "offset": 0,
     "limit": 20,
     "processingTimeMs": 0,
-    "query": "hob"
+    "query": "phil"
 }
 ```
 

README.md

@@ -218,5 +218,13 @@
     "poster": "https://image.tmdb.org/t/p/w1280/oeZh7yEz3PMnZLgBPhrafFHRbVz.jpg",
     "overview": "Earl Stone, a man in his 80s who is broke, alone, and facing foreclosure of his business when he is offered a job that simply requires him to drive. Easy enough, but, unbeknownst to Earl, he’s just signed on as a drug courier for a Mexican cartel. He does so well that his cargo increases exponentially, and Earl hit the radar of hard-charging DEA agent Colin Bates.",
     "release_date": 1544745600
+  },
+  {
+    "id": "123456",
+    "title": "Hitchhiker's Guide to the Galaxy",
+    "poster": "https://www.themoviedb.org/t/p/w1280/yKiH7IIbo23uA72MmY318mXorjw.jpg",
+    "overview": "Don't Panic! The story of Arthur Dent, an average Englishman who life was spared by his friend, who turned out to be an alien, while the planet Earth is destroyed. His friend tells him about the Hitchhiker's Guide to the Galaxy, a guide with anything you ever needed, and wanted to know. They travel across the galaxy, meeting friendly, and not so friendly characters in order to find the great question (the answer being 42).",
+    "release_date": 1114669984,
+    "genre": "Sci Fi"
   }
 ]

datasets/small_movies.json

@@ -148,6 +148,51 @@ def test_custom_search_params_with_filter_string(index_with_documents):
     assert 'facetsDistribution' not in response
     assert 'exhaustiveFacetsCount' not in response
 
+def test_custom_search_params_with_filter_string_with_space(index_with_documents):
+    index = index_with_documents()
+    update = index.update_filterable_attributes(['genre'])
+    index.wait_for_pending_update(update['updateId'])
+    response = index.search(
+        'galaxy',
+        {
+            'filter': "genre = 'sci fi'"
+        }
+    )
+    assert isinstance(response, dict)
+    assert len(response['hits']) == 1
+    assert 'facetsDistribution' not in response
+    assert 'exhaustiveFacetsCount' not in response
+
+def test_custom_search_params_with_multiple_filter_string_with_space(index_with_documents):
+    index = index_with_documents()
+    update = index.update_filterable_attributes(['genre', 'release_date'])
+    index.wait_for_pending_update(update['updateId'])
+    response = index.search(
+        'galaxy',
+        {
+            'filter': "genre = 'sci fi' AND release_date < 1550000000"
+        }
+    )
+    assert isinstance(response, dict)
+    assert len(response['hits']) == 1
+    assert 'facetsDistribution' not in response
+    assert 'exhaustiveFacetsCount' not in response
+
+def test_custom_search_params_with_array_filter_with_space(index_with_documents):
+    index = index_with_documents()
+    update = index.update_filterable_attributes(['genre', 'release_date'])
+    index.wait_for_pending_update(update['updateId'])
+    response = index.search(
+        'galaxy',
+        {
+            "filter": ["genre = 'sci fi'", "release_date < 1550000000"]
+        }
+    )
+    assert isinstance(response, dict)
+    assert len(response['hits']) == 1
+    assert 'facetsDistribution' not in response
+    assert 'exhaustiveFacetsCount' not in response
+
 def test_custom_search_params_with_mutilple_filter_string(index_with_documents):
     index = index_with_documents()
     update = index.update_filterable_attributes(['genre', 'release_date'])