meilisearch-python-sdk 4.0.0__py3-none-any.whl → 4.1.1__py3-none-any.whl

meilisearch_python_sdk/_batch.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from datetime import datetime
 from typing import TYPE_CHECKING
 
 from meilisearch_python_sdk._utils import get_async_client, get_client
@@ -28,9 +29,38 @@ async def async_get_batch(
     return BatchResult(**response.json())
 
 
-async def async_get_batches(client: HttpxAsyncClient | AsyncClient) -> BatchStatus:
+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)
-    response = await client_.get("batches")
+    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())
 
@@ -45,8 +75,92 @@ def get_batch(client: HttpxClient | Client, batch_uid: int) -> BatchResult | Non
     return BatchResult(**response.json())
 
 
-def get_batches(client: HttpxClient | Client) -> BatchStatus:
+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)
-    response = client_.get("batches")
+    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,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/_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/_version.py

@@ -1 +1 @@
-VERSION = "4.0.0"
+VERSION = "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/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/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-4.0.0.dist-info → meilisearch_python_sdk-4.1.1.dist-info}/METADATA

@@ -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.dist-info → meilisearch_python_sdk-4.1.1.dist-info}/RECORD

@@ -1,28 +1,28 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_batch.py,sha256=kO8JJpelrmDQbBVA5teFiG-tX8KBMcONYHbcqpHCfg4,1603
-meilisearch_python_sdk/_client.py,sha256=HN_T9rotwqCrsKjJEszB0hgUdkV0bZLVkYhkbqvUPbo,71204
+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=9w8ncyi2KQkfDaO5ejbD2IzLejXIQCZ44bqTarjcwXM,12485
+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=7fW10HPawx5fQGb_cUxvRh9Y5glb-Iser4_JvWxqCGk,18
+meilisearch_python_sdk/_version.py,sha256=c4Mq0PB9iieEclDeTA6m_tZX7t3ur0ECMvUGRiBxBr4,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=q_87zSnJfDNuVEI9cEvuOQOGBC7AGWJMEqCh2kGAAqA,2107
+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=VBzt-JF6w1f5V_aTAM3NetDQxs9fscnRy8t-Y1HWZXM,404
+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/search.py,sha256=lbZXN4DGb3arpG7LtFUxzfOMszIvz24seFRodOaeiVs,3446
 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.0.0.dist-info/METADATA,sha256=JNg2qOakPOhUf0U3YMlfyaIffZu11lNVTJWzavY_2zY,9771
-meilisearch_python_sdk-4.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-meilisearch_python_sdk-4.0.0.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-4.0.0.dist-info/RECORD,,
+meilisearch_python_sdk-4.1.1.dist-info/METADATA,sha256=pyzi4roX2dRKZ_JC7SleT7fK9sNO_HDnNfOh7vhe7DY,9763
+meilisearch_python_sdk-4.1.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+meilisearch_python_sdk-4.1.1.dist-info/licenses/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-4.1.1.dist-info/RECORD,,