meilisearch-python-sdk 3.6.1__tar.gz → 4.0.0__tar.gz

meilisearch_python_sdk-4.0.0/.github/renovate.json5

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  lockFileMaintenance: {
+    enabled: true,
+  },
+  "labels": ["dependencies", "skip-changelog"],
+}

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/.github/workflows/docs_publish.yml

@@ -11,7 +11,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/.github/workflows/nightly_testing.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: install Just

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/.github/workflows/pypi_publish.yml

@@ -14,7 +14,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/.github/workflows/testing.yml

@@ -15,7 +15,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python
@@ -38,7 +38,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -50,7 +50,7 @@ jobs:
       - name: Test with pytest
         run: just test-parallel-ci
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -66,7 +66,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -90,7 +90,7 @@ jobs:
       - name: Test with pytest
         run: just test-parallel-ci-http2
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -106,7 +106,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -118,7 +118,7 @@ jobs:
       - name: Test with pytest
         run: just test-no-parallel-ci
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -134,7 +134,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -158,7 +158,7 @@ jobs:
       - name: Test with pytest
         run: just test-no-parallel-ci-http2
       - name: Upload coverage
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true
@@ -187,7 +187,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v3
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.7.2
+    rev: v0.8.4
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 3.6.1
+Version: 4.0.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

meilisearch_python_sdk-4.0.0/examples/requirements.txt

@@ -0,0 +1,4 @@
+../.[all]
+fastapi==0.115.6
+pytest==8.3.4
+pytest-asyncio==0.25.0

meilisearch_python_sdk-4.0.0/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-3.6.1 → meilisearch_python_sdk-4.0.0}/meilisearch_python_sdk/_client.py

@@ -9,6 +9,7 @@ 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, 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 @@ 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 +146,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,6 +772,12 @@ 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) -> BatchStatus:
+        return await async_get_batches(self)
+
     async def cancel_tasks(
         self,
         *,
@@ -903,6 +911,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 +919,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 +935,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 +996,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,6 +1598,12 @@ 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) -> BatchStatus:
+        return get_batches(self)
+
     def cancel_tasks(
         self,
         *,
@@ -1718,6 +1736,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 +1744,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 +1760,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-3.6.1 → meilisearch_python_sdk-4.0.0}/meilisearch_python_sdk/_http_requests.py

@@ -116,12 +116,12 @@ 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)
         try:
-            if not body:
+            if body is None:
                 response = http_method(path)
             elif content_type == "application/json" and not compress:
                 response = http_method(path, content=self.json_handler.dumps(body), headers=headers)

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-4.0.0}/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
@@ -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-3.6.1 → meilisearch_python_sdk-4.0.0}/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-4.0.0/meilisearch_python_sdk/_version.py

@@ -0,0 +1 @@
+VERSION = "4.0.0"

{meilisearch_python_sdk-3.6.1 → meilisearch_python_sdk-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."""