Merge pull request #1145 from sanders41/meilisearch-1.12.0

Update for Meilisearch v1.12

Author: sanders41

meilisearch_python_sdk/_batch.py

@@ -0,0 +1,52 @@
+from __future__ import annotations
+
+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) -> BatchStatus:
+    client_ = get_async_client(client)
+    response = await client_.get("batches")
+
+    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) -> BatchStatus:
+    client_ = get_client(client)
+    response = client_.get("batches")
+
+    return BatchStatus(**response.json())

meilisearch_python_sdk/_client.py

@@ -9,6 +9,7 @@
 from httpx import Client as HttpxClient
 
 from meilisearch_python_sdk import _task
+from meilisearch_python_sdk._batch import async_get_batch, async_get_batches, get_batch, 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 +40,7 @@
     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):
@@ -770,6 +772,12 @@ async def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
 
         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) -> BatchStatus:
+        return await async_get_batches(self)
+
     async def cancel_tasks(
         self,
         *,
@@ -903,13 +911,15 @@ async def get_tasks(
         *,
         index_ids: list[str] | None = None,
         types: str | list[str] | None = None,
+        reverse: bool | None = None,
     ) -> TaskStatus:
         """Get multiple tasks.
 
         Args:
             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 +935,9 @@ async def get_tasks(
             >>> 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,
@@ -1586,6 +1598,12 @@ def swap_indexes(self, indexes: list[tuple[str, str]]) -> TaskInfo:
 
         return TaskInfo(**response.json())
 
+    def get_batch(self, batch_uid: int) -> BatchResult | None:
+        return get_batch(self, batch_uid)
+
+    def get_batches(self) -> BatchStatus:
+        return get_batches(self)
+
     def cancel_tasks(
         self,
         *,
@@ -1718,13 +1736,15 @@ def get_tasks(
         *,
         index_ids: list[str] | None = None,
         types: str | list[str] | None = None,
+        reverse: bool | None = None,
     ) -> TaskStatus:
         """Get multiple tasks.
 
         Args:
             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 +1760,7 @@ def get_tasks(
             >>> 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 @@ def _send_request(
         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 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
@@ -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())
@@ -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)
@@ -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())
@@ -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:

meilisearch_python_sdk/_utils.py

@@ -3,6 +3,31 @@
 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.0.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."""