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

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

@@ -3,6 +3,7 @@ on:
   release:
     types:
       - published
+  workflow_dispatch:
 env:
   PYTHON_VERSION: "3.12"
 jobs:

{meilisearch_python_sdk-4.0.0 → meilisearch_python_sdk-4.1.1}/.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.4
+    rev: v0.9.4
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 4.0.0
+Version: 4.1.1
 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
@@ -57,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)
@@ -142,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.0.0 → meilisearch_python_sdk-4.1.1}/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.0.0 → meilisearch_python_sdk-4.1.1}/docs/js/umami.js

@@ -1,7 +1,7 @@
 document.addEventListener("DOMContentLoaded", function () {
   var umamiScript = document.createElement("script");
   umamiScript.defer = true;
-  umamiScript.src = "https://analytics.us.umami.is/script.js";
+  umamiScript.src = "https://cloud.umami.is/script.js";
   umamiScript.dataset.websiteId = "29a9d193-92a3-44d0-9b1d-16ddd23898fb";
   document.head.appendChild(umamiScript);
 });

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

@@ -9,7 +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, get_batch, get_batches
+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
@@ -775,14 +777,43 @@ class AsyncClient(BaseClient):
     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 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,
@@ -856,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,
@@ -1599,16 +1630,45 @@ class Client(BaseClient):
         return TaskInfo(**response.json())
 
     def get_batch(self, batch_uid: int) -> BatchResult | None:
-        return get_batch(self, batch_uid)
+        return _get_batch(self, batch_uid)
 
-    def get_batches(self) -> BatchStatus:
-        return get_batches(self)
+    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,
@@ -1660,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,

{meilisearch_python_sdk-4.0.0 → meilisearch_python_sdk-4.1.1}/meilisearch_python_sdk/_task.py

@@ -22,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,
@@ -86,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,
@@ -193,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,
@@ -227,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,
@@ -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-4.1.1/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-4.0.0 → meilisearch_python_sdk-4.1.1}/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-4.0.0 → meilisearch_python_sdk-4.1.1}/meilisearch_python_sdk/models/search.py

@@ -18,7 +18,7 @@ class FacetHits(CamelBase):
 
 class FacetSearchResults(CamelBase):
     facet_hits: list[FacetHits]
-    facet_query: str
+    facet_query: str | None
     processing_time_ms: int
 
 

meilisearch_python_sdk-4.1.1/meilisearch_python_sdk/types.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from collections.abc import MutableMapping
+from typing import TYPE_CHECKING, Any, Union
+
+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]
+JsonMapping: TypeAlias = MutableMapping[str, Any]

{meilisearch_python_sdk-4.0.0 → meilisearch_python_sdk-4.1.1}/pyproject.toml

@@ -41,19 +41,19 @@ all = ["orjson", "ujson"]
 [dependency-groups]
 dev = [
   "mkdocs==1.6.1",
-  "mkdocs-material==9.5.49",
-  "mkdocstrings[python]==0.27.0",
-  "mypy[faster-cache]==1.14.0",
-  "pre-commit==4.0.1",
+  "mkdocs-material==9.6.3",
+  "mkdocstrings[python]==0.28.0",
+  "mypy[faster-cache]==1.15.0",
+  "pre-commit==4.1.0",
   "pytest==8.3.4",
   "pytest-cov==6.0.0",
-  "pytest-asyncio==0.25.0",
+  "pytest-asyncio==0.25.3",
   "pytest-xdist==3.6.1",
-  "ruff==0.8.4",
+  "ruff==0.9.5",
   "types-aiofiles==24.1.0.20241221",
   "typing-extensions==4.12.2",
   "types-ujson==5.10.0.20240515",
-  "meilisearch==0.33.0",
+  "meilisearch==0.33.1",
   "rich==13.9.4",
 ]
 

{meilisearch_python_sdk-4.0.0 → meilisearch_python_sdk-4.1.1}/tests/test_async_client.py

@@ -1021,6 +1021,17 @@ async def test_get_batches(async_client, async_empty_index, small_movies):
     assert len(result.results) > 0
 
 
+async def test_get_batches_with_params(async_client, async_empty_index, small_movies):
+    # Add documents to create batches
+    index = await async_empty_index()
+    tasks = await index.add_documents_in_batches(small_movies, batch_size=5)
+    waits = [async_client.wait_for_task(x.task_uid) for x in tasks]
+    await asyncio.gather(*waits)
+
+    result = await async_client.get_batches(uids=[task.task_uid for task in tasks])
+    assert len(result.results) > 0
+
+
 async def test_get_batch(async_client, async_empty_index, small_movies):
     # Add documents to create batches
     index = await async_empty_index()

{meilisearch_python_sdk-4.0.0 → meilisearch_python_sdk-4.1.1}/tests/test_client.py

@@ -1002,6 +1002,17 @@ def test_get_batches(client, empty_index, small_movies):
     assert len(result.results) > 0
 
 
+def test_get_batches_with_params(client, empty_index, small_movies):
+    # Add documents to create batches
+    index = empty_index()
+    tasks = index.add_documents_in_batches(small_movies, batch_size=5)
+    for task in tasks:
+        client.wait_for_task(task.task_uid)
+
+    result = client.get_batches(uids=[task.task_uid for task in tasks])
+    assert len(result.results) > 0
+
+
 def test_get_batch(client, empty_index, small_movies):
     # Add documents to create batches
     index = empty_index()