meilisearch-python-sdk 3.6.2__py3-none-any.whl → 4.1.0__py3-none-any.whl

meilisearch_python_sdk/_batch.py

@@ -0,0 +1,166 @@
+from __future__ import annotations
+
+from datetime import datetime
+from typing import TYPE_CHECKING
+
+from meilisearch_python_sdk._utils import get_async_client, get_client
+from meilisearch_python_sdk.errors import BatchNotFoundError
+from meilisearch_python_sdk.models.batch import BatchResult, BatchStatus
+
+if TYPE_CHECKING:
+    from httpx import AsyncClient as HttpxAsyncClient  # pragma: no cover
+    from httpx import Client as HttpxClient  # pragma: no cover
+
+    from meilisearch_python_sdk._client import (  # pragma: no cover
+        AsyncClient,
+        Client,
+    )
+
+
+async def async_get_batch(
+    client: HttpxAsyncClient | AsyncClient, batch_uid: int
+) -> BatchResult | None:
+    client_ = get_async_client(client)
+    response = await client_.get(f"batches/{batch_uid}")
+
+    if response.status_code == 404:
+        raise BatchNotFoundError(f"Batch {batch_uid} not found")
+
+    return BatchResult(**response.json())
+
+
+async def async_get_batches(
+    client: HttpxAsyncClient | AsyncClient,
+    *,
+    uids: list[int] | None = None,
+    batch_uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
+    statuses: list[str] | None = None,
+    types: list[str] | None = None,
+    limit: int = 20,
+    from_: str | None = None,
+    reverse: bool = False,
+    before_enqueued_at: datetime | None = None,
+    after_enqueued_at: datetime | None = None,
+    before_started_at: datetime | None = None,
+    after_finished_at: datetime | None = None,
+) -> BatchStatus:
+    client_ = get_async_client(client)
+    params = _build_parameters(
+        uids=uids,
+        batch_uids=batch_uids,
+        index_uids=index_uids,
+        statuses=statuses,
+        types=types,
+        limit=limit,
+        from_=from_,
+        reverse=reverse,
+        before_enqueued_at=before_enqueued_at,
+        after_enqueued_at=after_enqueued_at,
+        before_started_at=before_started_at,
+        after_finished_at=after_finished_at,
+    )
+    response = await client_.get("batches", params=params)
+
+    return BatchStatus(**response.json())
+
+
+def get_batch(client: HttpxClient | Client, batch_uid: int) -> BatchResult | None:
+    client_ = get_client(client)
+    response = client_.get(f"batches/{batch_uid}")
+
+    if response.status_code == 404:
+        raise BatchNotFoundError(f"Batch {batch_uid} not found")
+
+    return BatchResult(**response.json())
+
+
+def get_batches(
+    client: HttpxClient | Client,
+    *,
+    uids: list[int] | None = None,
+    batch_uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
+    statuses: list[str] | None = None,
+    types: list[str] | None = None,
+    limit: int = 20,
+    from_: str | None = None,
+    reverse: bool = False,
+    before_enqueued_at: datetime | None = None,
+    after_enqueued_at: datetime | None = None,
+    before_started_at: datetime | None = None,
+    after_finished_at: datetime | None = None,
+) -> BatchStatus:
+    client_ = get_client(client)
+    params = _build_parameters(
+        uids=uids,
+        batch_uids=batch_uids,
+        index_uids=index_uids,
+        statuses=statuses,
+        types=types,
+        limit=limit,
+        from_=from_,
+        reverse=reverse,
+        before_enqueued_at=before_enqueued_at,
+        after_enqueued_at=after_enqueued_at,
+        before_started_at=before_started_at,
+        after_finished_at=after_finished_at,
+    )
+
+    response = client_.get("batches", params=params)
+
+    return BatchStatus(**response.json())
+
+
+def _build_parameters(
+    *,
+    uids: list[int] | None = None,
+    batch_uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
+    statuses: list[str] | None = None,
+    types: list[str] | None = None,
+    limit: int = 20,
+    from_: str | None = None,
+    reverse: bool = False,
+    before_enqueued_at: datetime | None = None,
+    after_enqueued_at: datetime | None = None,
+    before_started_at: datetime | None = None,
+    after_finished_at: datetime | None = None,
+) -> dict[str, str]:
+    params = {}
+
+    if uids:
+        params["uids"] = ",".join([str(uid) for uid in uids])
+
+    if batch_uids:  # pragma: no cover
+        params["batchUids"] = ",".join([str(uid) for uid in batch_uids])
+
+    if index_uids:  # pragma: no cover
+        params["indexUids"] = ",".join([str(uid) for uid in index_uids])
+
+    if statuses:  # pragma: no cover
+        params["statuses"] = ",".join(statuses)
+
+    if types:  # pragma: no cover
+        params["types"] = ",".join(types)
+
+    params["limit"] = str(limit)
+
+    if from_:  # pragma: no cover
+        params["from"] = from_
+
+    params["reverse"] = "true" if reverse else "false"
+
+    if before_enqueued_at:  # pragma: no cover
+        params["beforeEnqueuedAt"] = before_enqueued_at.isoformat()
+
+    if after_enqueued_at:  # pragma: no cover
+        params["afterEnqueuedAt"] = after_enqueued_at.isoformat()
+
+    if before_started_at:  # pragma: no cover
+        params["beforeStartedAt"] = before_started_at.isoformat()
+
+    if after_finished_at:  # pragma: no cover
+        params["afterFinishedAt"] = after_finished_at.isoformat()
+
+    return params

meilisearch_python_sdk/_client.py

@@ -9,6 +9,9 @@ from httpx import AsyncClient as HttpxAsyncClient
 from httpx import Client as HttpxClient
 
 from meilisearch_python_sdk import _task
+from meilisearch_python_sdk._batch import async_get_batch, async_get_batches
+from meilisearch_python_sdk._batch import get_batch as _get_batch
+from meilisearch_python_sdk._batch import get_batches as _get_batches
 from meilisearch_python_sdk._http_requests import AsyncHttpRequests, HttpRequests
 from meilisearch_python_sdk.errors import InvalidRestriction, MeilisearchApiError
 from meilisearch_python_sdk.index import AsyncIndex, Index
@@ -39,6 +42,7 @@ if TYPE_CHECKING:  # pragma: no cover
     import sys
     from types import TracebackType
 
+    from meilisearch_python_sdk.models.batch import BatchResult, BatchStatus
     from meilisearch_python_sdk.types import JsonMapping
 
     if sys.version_info >= (3, 11):
@@ -144,7 +148,7 @@ class AsyncClient(BaseClient):
         api_key: str | None = None,
         *,
         timeout: int | None = None,
-        verify: str | bool | SSLContext = True,
+        verify: bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
         http2: bool = False,
@@ -770,11 +774,46 @@ class AsyncClient(BaseClient):
 
         return TaskInfo(**response.json())
 
+    async def get_batch(self, batch_uid: int) -> BatchResult | None:
+        return await async_get_batch(self, batch_uid)
+
+    async def get_batches(
+        self,
+        *,
+        uids: list[int] | None = None,
+        batch_uids: list[int] | None = None,
+        index_uids: list[int] | None = None,
+        statuses: list[str] | None = None,
+        types: list[str] | None = None,
+        limit: int = 20,
+        from_: str | None = None,
+        reverse: bool = False,
+        before_enqueued_at: datetime | None = None,
+        after_enqueued_at: datetime | None = None,
+        before_started_at: datetime | None = None,
+        after_finished_at: datetime | None = None,
+    ) -> BatchStatus:
+        return await async_get_batches(
+            self,
+            uids=uids,
+            batch_uids=batch_uids,
+            index_uids=index_uids,
+            statuses=statuses,
+            types=types,
+            limit=limit,
+            from_=from_,
+            reverse=reverse,
+            before_enqueued_at=before_enqueued_at,
+            after_enqueued_at=after_enqueued_at,
+            before_started_at=before_started_at,
+            after_finished_at=after_finished_at,
+        )
+
     async def cancel_tasks(
         self,
         *,
-        uids: list[str] | None = None,
-        index_uids: list[str] | None = None,
+        uids: list[int] | None = None,
+        index_uids: list[int] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         before_enqueued_at: datetime | None = None,
@@ -848,8 +887,8 @@ class AsyncClient(BaseClient):
     async def delete_tasks(
         self,
         *,
-        uids: list[str] | None = None,
-        index_uids: list[str] | None = None,
+        uids: list[int] | None = None,
+        index_uids: list[int] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         before_enqueued_at: datetime | None = None,
@@ -903,6 +942,7 @@ class AsyncClient(BaseClient):
         *,
         index_ids: list[str] | None = None,
         types: str | list[str] | None = None,
+        reverse: bool | None = None,
     ) -> TaskStatus:
         """Get multiple tasks.
 
@@ -910,6 +950,7 @@ class AsyncClient(BaseClient):
             index_ids: A list of index UIDs for which to get the tasks. If provided this will get the
                 tasks only for the specified indexes, if not all tasks will be returned. Default = None
             types: Specify specific task types to retrieve. Default = None
+            reverse: If True the tasks will be returned in reverse order. Default = None
 
         Returns:
             Task statuses.
@@ -925,7 +966,9 @@ class AsyncClient(BaseClient):
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     await client.get_tasks()
         """
-        return await _task.async_get_tasks(self.http_client, index_ids=index_ids, types=types)
+        return await _task.async_get_tasks(
+            self.http_client, index_ids=index_ids, types=types, reverse=reverse
+        )
 
     async def wait_for_task(
         self,
@@ -984,7 +1027,7 @@ class Client(BaseClient):
         api_key: str | None = None,
         *,
         timeout: int | None = None,
-        verify: str | bool | SSLContext = True,
+        verify: bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
         json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
         http2: bool = False,
@@ -1586,11 +1629,46 @@ class Client(BaseClient):
 
         return TaskInfo(**response.json())
 
+    def get_batch(self, batch_uid: int) -> BatchResult | None:
+        return _get_batch(self, batch_uid)
+
+    def get_batches(
+        self,
+        *,
+        uids: list[int] | None = None,
+        batch_uids: list[int] | None = None,
+        index_uids: list[int] | None = None,
+        statuses: list[str] | None = None,
+        types: list[str] | None = None,
+        limit: int = 20,
+        from_: str | None = None,
+        reverse: bool = False,
+        before_enqueued_at: datetime | None = None,
+        after_enqueued_at: datetime | None = None,
+        before_started_at: datetime | None = None,
+        after_finished_at: datetime | None = None,
+    ) -> BatchStatus:
+        return _get_batches(
+            self,
+            uids=uids,
+            batch_uids=batch_uids,
+            index_uids=index_uids,
+            statuses=statuses,
+            types=types,
+            limit=limit,
+            from_=from_,
+            reverse=reverse,
+            before_enqueued_at=before_enqueued_at,
+            after_enqueued_at=after_enqueued_at,
+            before_started_at=before_started_at,
+            after_finished_at=after_finished_at,
+        )
+
     def cancel_tasks(
         self,
         *,
-        uids: list[str] | None = None,
-        index_uids: list[str] | None = None,
+        uids: list[int] | None = None,
+        index_uids: list[int] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         before_enqueued_at: datetime | None = None,
@@ -1642,8 +1720,8 @@ class Client(BaseClient):
     def delete_tasks(
         self,
         *,
-        uids: list[str] | None = None,
-        index_uids: list[str] | None = None,
+        uids: list[int] | None = None,
+        index_uids: list[int] | None = None,
         statuses: list[str] | None = None,
         types: list[str] | None = None,
         before_enqueued_at: datetime | None = None,
@@ -1718,6 +1796,7 @@ class Client(BaseClient):
         *,
         index_ids: list[str] | None = None,
         types: str | list[str] | None = None,
+        reverse: bool | None = None,
     ) -> TaskStatus:
         """Get multiple tasks.
 
@@ -1725,6 +1804,7 @@ class Client(BaseClient):
             index_ids: A list of index UIDs for which to get the tasks. If provided this will get the
                 tasks only for the specified indexes, if not all tasks will be returned. Default = None
             types: Specify specific task types to retrieve. Default = None
+            reverse: If True the tasks will be returned in reverse order. Default = None
 
         Returns:
             Task statuses.
@@ -1740,7 +1820,7 @@ class Client(BaseClient):
             >>> client = Client("http://localhost.com", "masterKey")
             >>> client.get_tasks(client)
         """
-        return _task.get_tasks(self.http_client, index_ids=index_ids, types=types)
+        return _task.get_tasks(self.http_client, index_ids=index_ids, types=types, reverse=reverse)
 
     def wait_for_task(
         self,

meilisearch_python_sdk/_http_requests.py

@@ -116,7 +116,7 @@ class HttpRequests:
         http_method: Callable,
         path: str,
         body: Any | None = None,
-        content_type: str = "applicaton/json",
+        content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
         headers = build_headers(content_type, compress)

meilisearch_python_sdk/_task.py

@@ -10,6 +10,7 @@ from httpx import AsyncClient as HttpxAsyncClient
 from httpx import Client as HttpxClient
 
 from meilisearch_python_sdk._http_requests import AsyncHttpRequests, HttpRequests
+from meilisearch_python_sdk._utils import get_async_client, get_client
 from meilisearch_python_sdk.errors import MeilisearchTaskFailedError, MeilisearchTimeoutError
 from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler, UjsonHandler
 from meilisearch_python_sdk.models.task import TaskInfo, TaskResult, TaskStatus
@@ -21,8 +22,8 @@ if TYPE_CHECKING:
 async def async_cancel_tasks(
     client: HttpxAsyncClient | AsyncClient,
     *,
-    uids: list[str] | None = None,
-    index_uids: list[str] | None = None,
+    uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     before_enqueued_at: datetime | None = None,
@@ -76,7 +77,7 @@ async def async_cancel_tasks(
         parameters["statuses"] = "enqueued,processing"
 
     url = f"tasks/cancel?{urlencode(parameters)}"
-    client_ = _get_async_client(client)
+    client_ = get_async_client(client)
     response = await client_.post(url)
 
     return TaskInfo(**response.json())
@@ -85,8 +86,8 @@ async def async_cancel_tasks(
 async def async_delete_tasks(
     client: HttpxAsyncClient | AsyncClient,
     *,
-    uids: list[str] | None = None,
-    index_uids: list[str] | None = None,
+    uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     before_enqueued_at: datetime | None = None,
@@ -110,14 +111,17 @@ async def async_delete_tasks(
         parameters["statuses"] = "canceled,enqueued,failed,processing,succeeded"
 
     url = f"tasks?{urlencode(parameters)}"
-    client_ = _get_async_client(client)
+    client_ = get_async_client(client)
     response = await client_.delete(url)
 
     return TaskInfo(**response.json())
 
 
-async def async_get_task(client: HttpxAsyncClient | AsyncClient, task_id: int) -> TaskResult:
-    client_ = _get_async_client(client)
+async def async_get_task(
+    client: HttpxAsyncClient | AsyncClient,
+    task_id: int,
+) -> TaskResult:
+    client_ = get_async_client(client)
     response = await client_.get(f"tasks/{task_id}")
 
     return TaskResult(**response.json())
@@ -128,12 +132,19 @@ async def async_get_tasks(
     *,
     index_ids: list[str] | None = None,
     types: str | list[str] | None = None,
+    reverse: bool | None = None,
 ) -> TaskStatus:
     url = f"tasks?indexUids={','.join(index_ids)}" if index_ids else "tasks"
     if types:
         formatted_types = ",".join(types) if isinstance(types, list) else types
         url = f"{url}&types={formatted_types}" if "?" in url else f"{url}?types={formatted_types}"
-    client_ = _get_async_client(client)
+    if reverse:
+        url = (
+            f"{url}&reverse={str(reverse).lower()}"
+            if "?" in url
+            else f"{url}?reverse={str(reverse).lower()}"
+        )
+    client_ = get_async_client(client)
     response = await client_.get(url)
 
     return TaskStatus(**response.json())
@@ -147,7 +158,7 @@ async def async_wait_for_task(
     interval_in_ms: int = 50,
     raise_for_status: bool = False,
 ) -> TaskResult:
-    client_ = _get_async_client(client)
+    client_ = get_async_client(client)
     handler = _get_json_handler(client)
     url = f"tasks/{task_id}"
     http_requests = AsyncHttpRequests(client_, handler)
@@ -182,8 +193,8 @@ async def async_wait_for_task(
 def cancel_tasks(
     client: HttpxClient | Client,
     *,
-    uids: list[str] | None = None,
-    index_uids: list[str] | None = None,
+    uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     before_enqueued_at: datetime | None = None,
@@ -207,7 +218,7 @@ def cancel_tasks(
         parameters["statuses"] = "enqueued,processing"
 
     url = f"tasks/cancel?{urlencode(parameters)}"
-    client_ = _get_client(client)
+    client_ = get_client(client)
     response = client_.post(url)
 
     return TaskInfo(**response.json())
@@ -216,8 +227,8 @@ def cancel_tasks(
 def delete_tasks(
     client: HttpxClient | Client,
     *,
-    uids: list[str] | None = None,
-    index_uids: list[str] | None = None,
+    uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     before_enqueued_at: datetime | None = None,
@@ -241,14 +252,14 @@ def delete_tasks(
         parameters["statuses"] = "canceled,enqueued,failed,processing,succeeded"
 
     url = f"tasks?{urlencode(parameters)}"
-    client_ = _get_client(client)
+    client_ = get_client(client)
     response = client_.delete(url)
 
     return TaskInfo(**response.json())
 
 
 def get_task(client: HttpxClient | Client, task_id: int) -> TaskResult:
-    client_ = _get_client(client)
+    client_ = get_client(client)
     response = client_.get(f"tasks/{task_id}")
 
     return TaskResult(**response.json())
@@ -259,12 +270,19 @@ def get_tasks(
     *,
     index_ids: list[str] | None = None,
     types: str | list[str] | None = None,
+    reverse: bool | None = None,
 ) -> TaskStatus:
     url = f"tasks?indexUids={','.join(index_ids)}" if index_ids else "tasks"
     if types:
         formatted_types = ",".join(types) if isinstance(types, list) else types
         url = f"{url}&types={formatted_types}" if "?" in url else f"{url}?types={formatted_types}"
-    client_ = _get_client(client)
+    if reverse:
+        url = (
+            f"{url}&reverse={str(reverse).lower()}"
+            if "?" in url
+            else f"{url}?reverse={str(reverse).lower()}"
+        )
+    client_ = get_client(client)
     response = client_.get(url)
 
     return TaskStatus(**response.json())
@@ -278,7 +296,7 @@ def wait_for_task(
     interval_in_ms: int = 50,
     raise_for_status: bool = False,
 ) -> TaskResult:
-    client_ = _get_client(client)
+    client_ = get_client(client)
     handler = _get_json_handler(client)
     url = f"tasks/{task_id}"
     http_requests = HttpRequests(client_, json_handler=handler)
@@ -310,24 +328,6 @@ def wait_for_task(
             time.sleep(interval_in_ms / 1000)
 
 
-def _get_async_client(
-    client: AsyncClient | HttpxAsyncClient,
-) -> HttpxAsyncClient:
-    if isinstance(client, HttpxAsyncClient):
-        return client
-
-    return client.http_client
-
-
-def _get_client(
-    client: Client | HttpxClient,
-) -> HttpxClient:
-    if isinstance(client, HttpxClient):
-        return client
-
-    return client.http_client
-
-
 def _get_json_handler(
     client: AsyncClient | Client | HttpxAsyncClient | HttpxClient,
 ) -> BuiltinHandler | OrjsonHandler | UjsonHandler:
@@ -338,8 +338,8 @@ def _get_json_handler(
 
 
 def _process_params(
-    uids: list[str] | None = None,
-    index_uids: list[str] | None = None,
+    uids: list[int] | None = None,
+    index_uids: list[int] | None = None,
     statuses: list[str] | None = None,
     types: list[str] | None = None,
     before_enqueued_at: datetime | None = None,

meilisearch_python_sdk/_utils.py

@@ -3,6 +3,31 @@ from __future__ import annotations
 import sys
 from datetime import datetime
 from functools import lru_cache
+from typing import TYPE_CHECKING
+
+from httpx import AsyncClient as HttpxAsyncClient
+from httpx import Client as HttpxClient
+
+if TYPE_CHECKING:
+    from meilisearch_python_sdk._client import AsyncClient, Client  # pragma: no cover
+
+
+def get_async_client(
+    client: AsyncClient | HttpxAsyncClient,
+) -> HttpxAsyncClient:
+    if isinstance(client, HttpxAsyncClient):
+        return client
+
+    return client.http_client
+
+
+def get_client(
+    client: Client | HttpxClient,
+) -> HttpxClient:
+    if isinstance(client, HttpxClient):
+        return client
+
+    return client.http_client
 
 
 def iso_to_date_time(iso_date: datetime | str | None) -> datetime | None:

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "3.6.2"
+VERSION = "4.1.0"

meilisearch_python_sdk/errors.py

@@ -1,6 +1,10 @@
 from httpx import Response
 
 
+class BatchNotFoundError(Exception):
+    pass
+
+
 class InvalidDocumentError(Exception):
     """Error for documents that are not in a valid format for Meilisearch."""
 

meilisearch_python_sdk/index.py

@@ -4383,6 +4383,147 @@ class AsyncIndex(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    async def get_facet_search(self) -> bool | None:
+        """Get setting for facet search opt-out.
+
+        Returns:
+            True if facet search is enabled or False if not.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples
+            >>> from meilisearch_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     facet_search = await index.get_facet_search()
+        """
+        response = await self._http_requests.get(f"{self._settings_url}/facet-search")
+
+        return response.json()
+
+    async def update_facet_search(self, facet_search: bool, *, compress: bool = False) -> TaskInfo:
+        """Update setting for facet search opt-out.
+
+        Args:
+            facet_search: Boolean indicating if facet search should be disabled.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        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_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.update_facet_search(True)
+        """
+        response = await self._http_requests.put(
+            f"{self._settings_url}/facet-search",
+            facet_search,
+            compress=compress,
+        )
+
+        return TaskInfo(**response.json())
+
+    async def reset_facet_search(self) -> TaskInfo:
+        """Reset the facet search opt-out settings.
+
+        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_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = client.index("movies")
+            >>>     await index.reset_facet_search()
+        """
+        response = await self._http_requests.delete(f"{self._settings_url}/facet-search")
+
+        return TaskInfo(**response.json())
+
+    async def get_prefix_search(self) -> str:
+        """Get setting for prefix search opt-out.
+
+        Returns:
+            True if prefix search is enabled or False if not.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples
+            >>> from meilisearch_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     prefix_search = await index.get_prefix_search()
+        """
+        response = await self._http_requests.get(f"{self._settings_url}/prefix-search")
+
+        return response.json()
+
+    async def update_prefix_search(
+        self,
+        prefix_search: Literal["disabled", "indexingTime", "searchTime"],
+        *,
+        compress: bool = False,
+    ) -> TaskInfo:
+        """Update setting for prefix search opt-out.
+
+        Args:
+            prefix_search: Value indicating prefix search setting.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        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_sdk import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     await index.update_prefix_search("disabled")
+        """
+        response = await self._http_requests.put(
+            f"{self._settings_url}/prefix-search",
+            prefix_search,
+            compress=compress,
+        )
+
+        return TaskInfo(**response.json())
+
+    async def reset_prefix_search(self) -> TaskInfo:
+        """Reset the prefix search opt-out settings.
+
+        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_async_client import AsyncClient
+            >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
+            >>>     index = await client.index("movies")
+            >>>     await index.reset_prefix_search()
+        """
+        response = await self._http_requests.delete(f"{self._settings_url}/prefix-search")
+
+        return TaskInfo(**response.json())
+
     @staticmethod
     async def _run_plugins(
         plugins: Sequence[AsyncPlugin | AsyncDocumentPlugin | AsyncPostSearchPlugin],
@@ -7792,6 +7933,147 @@ class Index(_BaseIndex):
 
         return TaskInfo(**response.json())
 
+    def get_facet_search(self) -> bool:
+        """Get setting for facet search opt-out.
+
+        Returns:
+            True if facet search is enabled or False if not.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples
+            >>> from meilisearch_async_client import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> facet_search = await index.get_facet_search()
+        """
+        response = self._http_requests.get(f"{self._settings_url}/facet-search")
+
+        return response.json()
+
+    def update_facet_search(self, facet_search: bool, *, compress: bool = False) -> TaskInfo:
+        """Update setting for facet search opt-out.
+
+        Args:
+            facet_search: Boolean indicating if facet search should be disabled.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        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_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> index.update_facet_search(True)
+        """
+        response = self._http_requests.put(
+            f"{self._settings_url}/facet-search",
+            facet_search,
+            compress=compress,
+        )
+
+        return TaskInfo(**response.json())
+
+    def reset_facet_search(self) -> TaskInfo:
+        """Reset the facet search opt-out settings.
+
+        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_async_client import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> await index.reset_facet_search()
+        """
+        response = self._http_requests.delete(f"{self._settings_url}/facet-search")
+
+        return TaskInfo(**response.json())
+
+    def get_prefix_search(self) -> bool:
+        """Get setting for prefix search opt-out.
+
+        Returns:
+            True if prefix search is enabled or False if not.
+
+        Raises:
+            MeilisearchCommunicationError: If there was an error communicating with the server.
+            MeilisearchApiError: If the Meilisearch API returned an error.
+
+        Examples
+            >>> from meilisearch_async_client import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> prefix_search = index.get_prefix_search()
+        """
+        response = self._http_requests.get(f"{self._settings_url}/prefix-search")
+
+        return response.json()
+
+    def update_prefix_search(
+        self,
+        prefix_search: Literal["disabled", "indexingTime", "searchTime"],
+        *,
+        compress: bool = False,
+    ) -> TaskInfo:
+        """Update setting for prefix search opt-out.
+
+        Args:
+            prefix_search: Value indicating prefix search setting.
+            compress: If set to True the data will be sent in gzip format. Defaults to False.
+
+        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_sdk import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> index.update_prefix_search("disabled")
+        """
+        response = self._http_requests.put(
+            f"{self._settings_url}/prefix-search",
+            prefix_search,
+            compress=compress,
+        )
+
+        return TaskInfo(**response.json())
+
+    def reset_prefix_search(self) -> TaskInfo:
+        """Reset the prefix search opt-out settings.
+
+        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_async_client import Client
+            >>> client = Client("http://localhost.com", "masterKey")
+            >>> index = client.index("movies")
+            >>> index.reset_prefix_search()
+        """
+        response = self._http_requests.delete(f"{self._settings_url}/prefix-search")
+
+        return TaskInfo(**response.json())
+
     @staticmethod
     def _run_plugins(
         plugins: Sequence[Plugin | DocumentPlugin | PostSearchPlugin],

meilisearch_python_sdk/json_handler.py

@@ -2,10 +2,7 @@ from __future__ import annotations
 
 import json
 from abc import ABC, abstractmethod
-from typing import TYPE_CHECKING, Any
-
-if TYPE_CHECKING:  # pragma: no cover
-    pass
+from typing import Any
 
 try:
     import orjson

meilisearch_python_sdk/models/batch.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+from datetime import datetime
+
+from camel_converter.pydantic_base import CamelBase
+from pydantic import Field, field_validator
+
+from meilisearch_python_sdk._utils import iso_to_date_time
+from meilisearch_python_sdk.types import JsonDict
+
+
+class BatchId(CamelBase):
+    uid: int
+
+
+class Status(CamelBase):
+    succeeded: int | None = None
+    failed: int | None = None
+    cancelled: int | None = None
+    processing: int | None = None
+    enqueued: int | None = None
+
+
+class Stats(CamelBase):
+    total_nb_tasks: int
+    status: Status
+    batch_types: JsonDict | None = Field(None, alias="types")
+    index_uids: JsonDict | None = None
+
+
+class BatchResult(BatchId):
+    details: JsonDict | None = None
+    progress: JsonDict | None = None
+    stats: Stats
+    duration: str | None = None
+    started_at: datetime | None = None
+    finished_at: datetime | None = None
+
+    @field_validator("started_at", mode="before")  # type: ignore[attr-defined]
+    @classmethod
+    def validate_started_at(cls, v: str) -> datetime | None:
+        return iso_to_date_time(v)
+
+    @field_validator("finished_at", mode="before")  # type: ignore[attr-defined]
+    @classmethod
+    def validate_finished_at(cls, v: str) -> datetime | None:
+        return iso_to_date_time(v)
+
+
+class BatchStatus(CamelBase):
+    results: list[BatchResult]
+    total: int
+    limit: int
+    from_: int | None = Field(None, alias="from")
+    next: int | None = None

meilisearch_python_sdk/models/settings.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from enum import Enum
+from typing import Literal
 
 import pydantic
 from camel_converter.pydantic_base import CamelBase
@@ -142,3 +143,5 @@ class MeilisearchSettings(CamelBase):
         | None
     ) = None  # Optional[Embedders] = None
     localized_attributes: list[LocalizedAttributes] | None = None
+    facet_search: bool | None = None
+    prefix_search: Literal["disabled", "indexingTime", "searchTime"] | None = None

meilisearch_python_sdk/models/task.py

@@ -25,6 +25,7 @@ class TaskResult(TaskId):
     enqueued_at: datetime
     started_at: datetime | None = None
     finished_at: datetime | None = None
+    batch_uid: int | None = None
 
     @pydantic.field_validator("enqueued_at", mode="before")  # type: ignore[attr-defined]
     @classmethod
@@ -61,6 +62,7 @@ class TaskInfo(CamelBase):
     status: str
     task_type: str | JsonDict = Field(..., alias="type")
     enqueued_at: datetime
+    batch_uid: int | None = None
 
     @pydantic.field_validator("enqueued_at", mode="before")  # type: ignore[attr-defined]
     @classmethod

meilisearch_python_sdk/types.py

@@ -1,13 +1,15 @@
 from __future__ import annotations
 
-import sys
 from collections.abc import MutableMapping
-from typing import Any, Union
+from typing import TYPE_CHECKING, Any, Union
 
-if sys.version_info >= (3, 10):  # pragma: no cover
-    from typing import TypeAlias
-else:
-    from typing_extensions import TypeAlias
+if TYPE_CHECKING:  # pragma: no cover
+    import sys
+
+    if sys.version_info >= (3, 10):
+        from typing import TypeAlias
+    else:
+        from typing_extensions import TypeAlias
 
 Filter: TypeAlias = Union[str, list[Union[str, list[str]]]]
 JsonDict: TypeAlias = dict[str, Any]

{meilisearch_python_sdk-3.6.2.dist-info → meilisearch_python_sdk-4.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 3.6.2
+Version: 4.1.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Project-URL: repository, https://github.com/sanders41/meilisearch-python-sdk
 Project-URL: homepage, https://github.com/sanders41/meilisearch-python-sdk
@@ -27,6 +27,7 @@ License: MIT License
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
+License-File: LICENSE
 Keywords: async,client,meilisearch,python,sdk
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -56,7 +57,7 @@ Description-Content-Type: text/markdown
 
 # Meilisearch Python SDK
 
-[![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/workflows/Testing/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
+[![Tests Status](https://github.com/sanders41/meilisearch-python-sdk/actions/workflows/testing.yml/badge.svg?branch=main&event=push)](https://github.com/sanders41/meilisearch-python-sdk/actions?query=workflow%3ATesting+branch%3Amain+event%3Apush)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sanders41/meilisearch-python-sdk/main.svg)](https://results.pre-commit.ci/latest/github/sanders41/meilisearch-python-sdk/main)
 [![Coverage](https://codecov.io/github/sanders41/meilisearch-python-sdk/coverage.svg?branch=main)](https://codecov.io/gh/sanders41/meilisearch-python-sdk)
 [![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
@@ -141,15 +142,15 @@ variable, this will be an `UpdateId` object, and use it to check the status of t
 #### AsyncClient
 
 ```py
-update = await index.add_documents(documents)
-status = await client.index('books').get_update_status(update.update_id)
+task = await index.add_documents([{"id": 1, "title": "test"}])
+status = await client.get_task(task.task_uid)
 ```
 
 #### Client
 
 ```py
-update = index.add_documents(documents)
-status = client.index('books').get_update_status(update.update_id)
+task = index.add_documents([{"id": 1, "title": "test"}])
+status = client.get_task(task.task_uid)
 ```
 
 ### Basic Searching

meilisearch_python_sdk-4.1.0.dist-info/RECORD

@@ -0,0 +1,28 @@
+meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
+meilisearch_python_sdk/_batch.py,sha256=Hbt-M8Lt8ZDZqcKToUMzUd5zvT-gku709er4pRlvXWk,5065
+meilisearch_python_sdk/_client.py,sha256=LJ_MXxdIMfZ-Rva3feZRS7pzfY7rgr0lYUxY8hD9be4,73282
+meilisearch_python_sdk/_http_requests.py,sha256=O3M3n-t1jAKwccWowPbk-HPD3ExtHq8a3XhnZT5facs,6746
+meilisearch_python_sdk/_task.py,sha256=QgVcqMlZdURRS_oYpB_bTBa5dvT3Sp_-O0-s6TqAxHk,12485
+meilisearch_python_sdk/_utils.py,sha256=NoCDxJPhjABeuSxFTNCih585UDWdXEUBD_FvdgtScQw,1539
+meilisearch_python_sdk/_version.py,sha256=5hHes-uiUQVCKxIz0rFy7XVtaMCXeP6lPXPOk_JZPmU,18
+meilisearch_python_sdk/decorators.py,sha256=njMn40P-qOzKGGQLCDpsBKWyj2ai10s4XG4IUBSHoD4,8674
+meilisearch_python_sdk/errors.py,sha256=RNNHXtXLBiCVZaLM2MeKKs9RbRuE-SLRttiPeVAEXgA,2133
+meilisearch_python_sdk/index.py,sha256=QIZk0O8cZ3qR2osPb03gSatR72dGaFEF_MC0PqTLmdU,341518
+meilisearch_python_sdk/json_handler.py,sha256=c1rGKzYlE0dGfLygQjPqVUNfQkN1JvafBGmIx31JW8g,2044
+meilisearch_python_sdk/plugins.py,sha256=YySzTuVr4IrogTgrP8q-gZPsew8TwedopjWnTj5eV48,3607
+meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+meilisearch_python_sdk/types.py,sha256=WxbQBPfy5S_j9hRKJ74ktuIxkH9Oifn7GYStQjs49Ik,458
+meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+meilisearch_python_sdk/models/batch.py,sha256=w0R0tINqm5DkkdX-9RXDqyS8rxDGCjEySSzzyVZ_gGs,1465
+meilisearch_python_sdk/models/client.py,sha256=ntecx3ya_5EwgnxZfqYsBg9UlyQe_i3jgaTlRWFUVTE,2451
+meilisearch_python_sdk/models/documents.py,sha256=eT3FHrPND-g2IzNRyOHQApTTJ1WbFcGlqgxZ6aKrRgI,247
+meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
+meilisearch_python_sdk/models/index.py,sha256=GGwuhx5Wsn5iyj1ov3f4eWjfw6ttM8WzvyrnSsC4vRg,1132
+meilisearch_python_sdk/models/search.py,sha256=Wmv8LmhwMVGoZnndkhw16RuoxxC203jlcOO2Q_VZIU4,3439
+meilisearch_python_sdk/models/settings.py,sha256=uCm-F4PDeCR5e2d8WrGT8hwq0VhrCv19MatQVpS8ocU,4154
+meilisearch_python_sdk/models/task.py,sha256=_PyuH5tSlHCKMwFsx1nMKjFgc8bDBZxscKYZOdf-4pg,2166
+meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
+meilisearch_python_sdk-4.1.0.dist-info/METADATA,sha256=ZTC9P3sbdC7sxtMnXpHAa0EOagZ1zXkWWOPrnSf84cs,9763
+meilisearch_python_sdk-4.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-4.1.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-4.1.0.dist-info/RECORD,,

{meilisearch_python_sdk-3.6.2.dist-info → meilisearch_python_sdk-4.1.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

meilisearch_python_sdk-3.6.2.dist-info/RECORD

@@ -1,26 +0,0 @@
-meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=HvZ74xfKtOfxwujsj0INdlBycW2vMakQfWw5IbTrpX8,70330
-meilisearch_python_sdk/_http_requests.py,sha256=baXB-tBhNrE9C5PQmyR-KEKxSNINgK02sqf3MFDSEL4,6745
-meilisearch_python_sdk/_task.py,sha256=WpUwj-CuFtMbbljNOrFUGzp41k5LuZ_riw08IWLwp4M,12347
-meilisearch_python_sdk/_utils.py,sha256=k6SYMJSiVjfF-vlhQRMaE1ziJsVf5FrL94mFwrMfdLY,957
-meilisearch_python_sdk/_version.py,sha256=S_1FdFnjMgmMn9CDgNZ3etYT2R6OERmYf-F2a4tDMdE,18
-meilisearch_python_sdk/decorators.py,sha256=njMn40P-qOzKGGQLCDpsBKWyj2ai10s4XG4IUBSHoD4,8674
-meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
-meilisearch_python_sdk/index.py,sha256=RWbJAKajw_wI96Zifjc4crmn0HDvwxfUiPYobIXx7p8,330996
-meilisearch_python_sdk/json_handler.py,sha256=q_87zSnJfDNuVEI9cEvuOQOGBC7AGWJMEqCh2kGAAqA,2107
-meilisearch_python_sdk/plugins.py,sha256=YySzTuVr4IrogTgrP8q-gZPsew8TwedopjWnTj5eV48,3607
-meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meilisearch_python_sdk/types.py,sha256=VBzt-JF6w1f5V_aTAM3NetDQxs9fscnRy8t-Y1HWZXM,404
-meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meilisearch_python_sdk/models/client.py,sha256=ntecx3ya_5EwgnxZfqYsBg9UlyQe_i3jgaTlRWFUVTE,2451
-meilisearch_python_sdk/models/documents.py,sha256=eT3FHrPND-g2IzNRyOHQApTTJ1WbFcGlqgxZ6aKrRgI,247
-meilisearch_python_sdk/models/health.py,sha256=hvruti7ylsk7bAh8RPOhTPcRrjx6MPgdkDFX9vZ5Qks,95
-meilisearch_python_sdk/models/index.py,sha256=GGwuhx5Wsn5iyj1ov3f4eWjfw6ttM8WzvyrnSsC4vRg,1132
-meilisearch_python_sdk/models/search.py,sha256=Wmv8LmhwMVGoZnndkhw16RuoxxC203jlcOO2Q_VZIU4,3439
-meilisearch_python_sdk/models/settings.py,sha256=wg9nmmZd9cP2WrgtHqIgLXdJH4BlCmAuS793QRK6cjc,4007
-meilisearch_python_sdk/models/task.py,sha256=P3NLaZhrY8H02Q9lDEkoq-3Z6_qGESglOxs4dNRyMWg,2100
-meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
-meilisearch_python_sdk-3.6.2.dist-info/METADATA,sha256=4vIJhJWyHoloj27cBlsL_LN5xleHTuKwVKEps2n5VXg,9749
-meilisearch_python_sdk-3.6.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-meilisearch_python_sdk-3.6.2.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-3.6.2.dist-info/RECORD,,