Merge pull request #492 from sanders41/meilisearch-1.2.0

Update for Meilisearch v1.2.0

Author: sanders41

meilisearch_python_async/index.py

@@ -394,7 +394,12 @@ async def get_document(self, document_id: str) -> dict[str, Any]:
         return response.json()
 
     async def get_documents(
-        self, *, offset: int = 0, limit: int = 20, fields: list[str] | None = None
+        self,
+        *,
+        offset: int = 0,
+        limit: int = 20,
+        fields: list[str] | None = None,
+        filter: str | list[str | list[str]] | None = None,
     ) -> DocumentsInfo:
         """Get a batch documents from the index.
 
@@ -404,6 +409,8 @@ async def get_documents(
             limit: Maximum number of documents returnedd. Defaults to 20.
             fields: Document attributes to show. If this value is None then all
                 attributes are retrieved. Defaults to None.
+            filter: Filter value information. Defaults to None. Note: This parameter can only be
+                used with Meilisearch >= v1.2.0
 
         Returns:
 
@@ -427,11 +434,22 @@ async def get_documents(
             "limit": limit,
         }
 
+        if not filter:
+            if fields:
+                parameters["fields"] = ",".join(fields)
+
+            url = f"{self._documents_url}?{urlencode(parameters)}"
+            response = await self._http_requests.get(url)
+
+            return DocumentsInfo(**response.json())
+
         if fields:
-            parameters["fields"] = ",".join(fields)
+            parameters["fields"] = fields
 
-        url = f"{self._documents_url}?{urlencode(parameters)}"
-        response = await self._http_requests.get(url)
+        parameters["filter"] = filter
+
+        url = f"{self._documents_url}/fetch"
+        response = await self._http_requests.post(url, body=parameters)
 
         return DocumentsInfo(**response.json())
 
@@ -1307,6 +1325,67 @@ async def delete_documents(self, ids: list[str]) -> TaskInfo:
 
         return TaskInfo(**response.json())
 
+    async def delete_documents_by_filter(self, filter: str | list[str | list[str]]) -> TaskInfo:
+        """Delete documents from the index by filter.
+
+        Args:
+
+            filter: The filter value information.
+
+        Returns:
+
+            The details of the task status.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_python_async import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.delete_documents_by_filter("genre=horor"))
+        """
+        url = f"{self._documents_url}/delete"
+        response = await self._http_requests.post(url, body={"filter": filter})
+
+        return TaskInfo(**response.json())
+
+    async def delete_documents_in_batches_by_filter(
+        self, filters: list[str | list[str | list[str]]]
+    ) -> list[TaskInfo]:
+        """Delete batches of documents from the index by filter.
+
+        Args:
+
+            filters: A list of filter value information.
+
+        Returns:
+
+            The a list of details of the task statuses.
+
+        Raises:
+
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples:
+
+            >>> from meilisearch_python_async import Client
+            >>> async with Client("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.delete_documents_in_batches_by_filter(
+            >>>         [
+            >>>             "genre=horor"),
+            >>>             "release_date=1520035200"),
+            >>>         ]
+            >>>     )
+        """
+        tasks = [self.delete_documents_by_filter(filter) for filter in filters]
+        return await gather(*tasks)
+
     async def delete_all_documents(self) -> TaskInfo:
         """Delete all documents from the index.
 

tests/test_documents.py

@@ -574,6 +574,26 @@ async def test_get_documents_offset_optional_params(index_with_documents):
     assert response_offset_limit.results[0]["overview"] == response.results[1]["overview"]
 
 
+async def test_get_documents_filter(index_with_documents):
+    index = await index_with_documents()
+    response = await index.update_filterable_attributes(["genre"])
+    await wait_for_task(index.http_client, response.task_uid)
+    response = await index.get_documents(filter="genre=action")
+    genres = set([x["genre"] for x in response.results])
+    assert len(genres) == 1
+    assert next(iter(genres)) == "action"
+
+
+async def test_get_documents_filter_with_fields(index_with_documents):
+    index = await index_with_documents()
+    response = await index.update_filterable_attributes(["genre"])
+    await wait_for_task(index.http_client, response.task_uid)
+    response = await index.get_documents(fields=["genre"], filter="genre=action")
+    genres = set([x["genre"] for x in response.results])
+    assert len(genres) == 1
+    assert next(iter(genres)) == "action"
+
+
 async def test_update_documents(index_with_documents, small_movies):
     index = await index_with_documents()
     response = await index.get_documents()
@@ -1138,6 +1158,41 @@ async def test_delete_documents(index_with_documents):
     assert to_delete not in ids
 
 
+async def test_delete_documents_by_filter(index_with_documents):
+    index = await index_with_documents()
+    response = await index.update_filterable_attributes(["genre"])
+    await wait_for_task(index.http_client, response.task_uid)
+    response = await index.get_documents()
+    assert "action" in ([x.get("genre") for x in response.results])
+    response = await index.delete_documents_by_filter("genre=action")
+    await wait_for_task(index.http_client, response.task_uid)
+    response = await index.get_documents()
+    genres = [x.get("genre") for x in response.results]
+    assert "action" not in genres
+    assert "cartoon" in genres
+
+
+async def test_delete_documents_in_batches_by_filter(index_with_documents):
+    index = await index_with_documents()
+    response = await index.update_filterable_attributes(["genre", "release_date"])
+    await wait_for_task(index.http_client, response.task_uid)
+    response = await index.get_documents()
+    assert "action" in [x.get("genre") for x in response.results]
+    assert 1520035200 in [x.get("release_date") for x in response.results]
+    response = await index.delete_documents_in_batches_by_filter(
+        ["genre=action", "release_date=1520035200"]
+    )
+    for task in response:
+        await wait_for_task(index.http_client, task.task_uid)
+    response = await index.get_documents()
+    genres = [x.get("genre") for x in response.results]
+    release_dates = [x.get("release_date") for x in response.results]
+    assert "action" not in genres
+    assert "cartoon" in genres
+    assert len(release_dates) > 0
+    assert 1520035200 not in release_dates
+
+
 async def test_delete_all_documents(index_with_documents):
     index = await index_with_documents()
     response = await index.delete_all_documents()