meilisearch-python-sdk 3.6.2__tar.gz → 4.1.0__tar.gz

meilisearch_python_sdk-4.1.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.2 → meilisearch_python_sdk-4.1.0}/.github/workflows/docs_publish.yml

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

{meilisearch_python_sdk-3.6.2 → meilisearch_python_sdk-4.1.0}/.github/workflows/nightly_testing.yml

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

{meilisearch_python_sdk-3.6.2 → meilisearch_python_sdk-4.1.0}/.github/workflows/pypi_publish.yml

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

{meilisearch_python_sdk-3.6.2 → meilisearch_python_sdk-4.1.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@v4
+        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@v4
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -66,7 +66,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -106,7 +106,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -134,7 +134,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python ${{ matrix.python-version }}
@@ -187,7 +187,7 @@ jobs:
       - name: install Just
         uses: taiki-e/install-action@just
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v5
         with:
           enable-cache: true
       - name: Set up Python

{meilisearch_python_sdk-3.6.2 → meilisearch_python_sdk-4.1.0}/.pre-commit-config.yaml

@@ -9,12 +9,12 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.13.0
+    rev: v1.14.1
     hooks:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.0
+    rev: v0.9.3
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-3.6.2 → meilisearch_python_sdk-4.1.0}/PKG-INFO

@@ -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-3.6.2 → meilisearch_python_sdk-4.1.0}/README.md

@@ -1,6 +1,6 @@
 # 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)
@@ -85,15 +85,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/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.1.0/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-3.6.2 → meilisearch_python_sdk-4.1.0}/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-3.6.2 → meilisearch_python_sdk-4.1.0}/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)