meilisearch-python-sdk 2.8.0__tar.gz → 2.10.0__tar.gz

{meilisearch_python_sdk-2.8.0 → meilisearch_python_sdk-2.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 2.8.0
+Version: 2.10.0
 Summary: A Python client providing both async and sync support for the Meilisearch API
 Home-page: https://github.com/sanders41/meilisearch-python-sdk
 License: MIT
@@ -36,9 +36,6 @@ Description-Content-Type: text/markdown
 [![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-sdk?color=5cc141)](https://github.com/sanders41/meilisearch-python-sdk)
 
-NOTE: This project was previously named `meilisearch-python-async`. Development on
-that project continues here under the new name.
-
 Meilisearch Python SDK provides both an async and sync client for the
 [Meilisearch](https://github.com/meilisearch/meilisearch) API.
 

{meilisearch_python_sdk-2.8.0 → meilisearch_python_sdk-2.10.0}/README.md

@@ -6,9 +6,6 @@
 [![PyPI version](https://badge.fury.io/py/meilisearch-python-sdk.svg)](https://badge.fury.io/py/meilisearch-python-sdk)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/meilisearch-python-sdk?color=5cc141)](https://github.com/sanders41/meilisearch-python-sdk)
 
-NOTE: This project was previously named `meilisearch-python-async`. Development on
-that project continues here under the new name.
-
 Meilisearch Python SDK provides both an async and sync client for the
 [Meilisearch](https://github.com/meilisearch/meilisearch) API.
 

{meilisearch_python_sdk-2.8.0 → meilisearch_python_sdk-2.10.0}/meilisearch_python_sdk/_client.py

@@ -194,6 +194,7 @@ class AsyncClient(BaseClient):
         *,
         settings: MeilisearchSettings | None = None,
         wait: bool = True,
+        timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
     ) -> AsyncIndex:
         """Creates a new index.
@@ -210,6 +211,9 @@ class AsyncClient(BaseClient):
             wait: If set to True and settings are being updated, the index will be returned after
                 the settings update has completed. If False it will not wait for settings to complete.
                 Default: True
+            timeout_in_ms: Amount of time in milliseconds to wait before raising a
+                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
+                if the `None` option is used the wait time could be very long. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
@@ -228,7 +232,13 @@ class AsyncClient(BaseClient):
             >>>     index = await client.create_index("movies")
         """
         return await AsyncIndex.create(
-            self.http_client, uid, primary_key, settings=settings, wait=wait, plugins=plugins
+            self.http_client,
+            uid,
+            primary_key,
+            settings=settings,
+            wait=wait,
+            timeout_in_ms=timeout_in_ms,
+            plugins=plugins,
         )
 
     async def create_snapshot(self) -> TaskInfo:
@@ -470,6 +480,7 @@ class AsyncClient(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.post("keys", json.loads(key.json(by_alias=True)))  # type: ignore[attr-defined]
 
@@ -625,6 +636,7 @@ class AsyncClient(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = await self._http_requests.post(
                 url,
@@ -870,14 +882,14 @@ class AsyncClient(BaseClient):
 
         Args:
 
-            uids: A list of task UIDs to cancel.
-            index_uids: A list of index UIDs for which to cancel tasks.
-            statuses: A list of statuses to cancel.
-            types: A list of types to cancel.
-            before_enqueued_at: Cancel tasks that were enqueued before the specified date time.
-            after_enqueued_at: Cancel tasks that were enqueued after the specified date time.
-            before_started_at: Cancel tasks that were started before the specified date time.
-            after_finished_at: Cancel tasks that were finished after the specified date time.
+            uids: A list of task UIDs to delete.
+            index_uids: A list of index UIDs for which to delete tasks.
+            statuses: A list of statuses to delete.
+            types: A list of types to delete.
+            before_enqueued_at: Delete tasks that were enqueued before the specified date time.
+            after_enqueued_at: Delete tasks that were enqueued after the specified date time.
+            before_started_at: Delete tasks that were started before the specified date time.
+            after_finished_at: Delete tasks that were finished after the specified date time.
 
         Returns:
 
@@ -1053,6 +1065,7 @@ class Client(BaseClient):
         *,
         settings: MeilisearchSettings | None = None,
         wait: bool = True,
+        timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
     ) -> Index:
         """Creates a new index.
@@ -1069,6 +1082,9 @@ class Client(BaseClient):
             wait: If set to True and settings are being updated, the index will be returned after
                 the settings update has completed. If False it will not wait for settings to complete.
                 Default: True
+            timeout_in_ms: Amount of time in milliseconds to wait before raising a
+                MeilisearchTimeoutError. `None` can also be passed to wait indefinitely. Be aware that
+                if the `None` option is used the wait time could be very long. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
@@ -1087,7 +1103,13 @@ class Client(BaseClient):
             >>> index = client.create_index("movies")
         """
         return Index.create(
-            self.http_client, uid, primary_key, settings=settings, wait=wait, plugins=plugins
+            self.http_client,
+            uid,
+            primary_key,
+            settings=settings,
+            wait=wait,
+            timeout_in_ms=timeout_in_ms,
+            plugins=plugins,
         )
 
     def create_snapshot(self) -> TaskInfo:
@@ -1327,6 +1349,7 @@ class Client(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.post("keys", json.loads(key.json(by_alias=True)))  # type: ignore[attr-defined]
 
@@ -1482,6 +1505,7 @@ class Client(BaseClient):
             warn(
                 "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
                 DeprecationWarning,
+                stacklevel=2,
             )
             response = self._http_requests.post(
                 url,
@@ -1701,14 +1725,14 @@ class Client(BaseClient):
 
         Args:
 
-            uids: A list of task UIDs to cancel.
-            index_uids: A list of index UIDs for which to cancel tasks.
-            statuses: A list of statuses to cancel.
-            types: A list of types to cancel.
-            before_enqueued_at: Cancel tasks that were enqueued before the specified date time.
-            after_enqueued_at: Cancel tasks that were enqueued after the specified date time.
-            before_started_at: Cancel tasks that were started before the specified date time.
-            after_finished_at: Cancel tasks that were finished after the specified date time.
+            uids: A list of task UIDs to delete.
+            index_uids: A list of index UIDs for which to delete tasks.
+            statuses: A list of statuses to delete.
+            types: A list of types to delete.
+            before_enqueued_at: Delete tasks that were enqueued before the specified date time.
+            after_enqueued_at: Delete tasks that were enqueued after the specified date time.
+            before_started_at: Delete tasks that were started before the specified date time.
+            after_finished_at: Delete tasks that were finished after the specified date time.
 
         Returns:
 
@@ -1875,6 +1899,7 @@ def _build_update_key_payload(key: KeyUpdate) -> JsonDict:
         warn(
             "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
             DeprecationWarning,
+            stacklevel=2,
         )
         return {  # type: ignore[attr-defined]
             k: v

{meilisearch_python_sdk-2.8.0 → meilisearch_python_sdk-2.10.0}/meilisearch_python_sdk/_http_requests.py

@@ -34,6 +34,8 @@ class AsyncHttpRequests:
         body: Any | None = None,
         content_type: str = "application/json",
         compress: bool = False,
+        *,
+        serializer: type[json.JSONEncoder] | None = None,
     ) -> Response:
         headers = build_headers(content_type, compress)
 
@@ -41,11 +43,13 @@ class AsyncHttpRequests:
             if body is None:
                 response = await http_method(path)
             elif content_type == "application/json" and not compress:
-                response = await http_method(path, json=body, headers=headers)
+                response = await http_method(
+                    path, data=json.dumps(body, cls=serializer), headers=headers
+                )
             else:
                 if body and compress:
                     if content_type == "application/json":
-                        body = gzip.compress(json.dumps(body).encode("utf-8"))
+                        body = gzip.compress(json.dumps(body, cls=serializer).encode("utf-8"))
                     else:
                         body = gzip.compress((body).encode("utf-8"))
                 response = await http_method(path, content=body, headers=headers)
@@ -60,7 +64,7 @@ class AsyncHttpRequests:
                 raise MeilisearchApiError(str(err), response) from err
             else:
                 # Fail safe just in case error happens before response is created
-                raise MeilisearchError(str(err))  # pragma: no cover
+                raise MeilisearchError(str(err)) from err  # pragma: no cover
 
     async def get(self, path: str) -> Response:
         return await self._send_request(self.http_client.get, path)
@@ -80,8 +84,12 @@ class AsyncHttpRequests:
         body: Any | None = None,
         content_type: str = "application/json",
         compress: bool = False,
+        *,
+        serializer: type[json.JSONEncoder] | None = None,
     ) -> Response:
-        return await self._send_request(self.http_client.post, path, body, content_type, compress)
+        return await self._send_request(
+            self.http_client.post, path, body, content_type, compress, serializer=serializer
+        )
 
     async def put(
         self,
@@ -89,8 +97,12 @@ class AsyncHttpRequests:
         body: Any | None = None,
         content_type: str = "application/json",
         compress: bool = False,
+        *,
+        serializer: type[json.JSONEncoder] | None = None,
     ) -> Response:
-        return await self._send_request(self.http_client.put, path, body, content_type, compress)
+        return await self._send_request(
+            self.http_client.put, path, body, content_type, compress, serializer=serializer
+        )
 
     async def delete(self, path: str, body: dict | None = None) -> Response:
         return await self._send_request(self.http_client.delete, path, body)
@@ -107,17 +119,19 @@ class HttpRequests:
         body: Any | None = None,
         content_type: str = "applicaton/json",
         compress: bool = False,
+        *,
+        serializer: type[json.JSONEncoder] | None = None,
     ) -> Response:
         headers = build_headers(content_type, compress)
         try:
             if not body:
                 response = http_method(path)
             elif content_type == "application/json" and not compress:
-                response = http_method(path, json=body, headers=headers)
+                response = http_method(path, data=json.dumps(body, cls=serializer), headers=headers)
             else:
                 if body and compress:
                     if content_type == "application/json":
-                        body = gzip.compress(json.dumps(body).encode("utf-8"))
+                        body = gzip.compress(json.dumps(body, cls=serializer).encode("utf-8"))
                     else:
                         body = gzip.compress((body).encode("utf-8"))
                 response = http_method(path, content=body, headers=headers)
@@ -132,7 +146,7 @@ class HttpRequests:
                 raise MeilisearchApiError(str(err), response) from err
             else:
                 # Fail safe just in case error happens before response is created
-                raise MeilisearchError(str(err))  # pragma: no cover
+                raise MeilisearchError(str(err)) from err  # pragma: no cover
 
     def get(self, path: str) -> Response:
         return self._send_request(self.http_client.get, path)
@@ -152,8 +166,12 @@ class HttpRequests:
         body: Any | None = None,
         content_type: str = "application/json",
         compress: bool = False,
+        *,
+        serializer: type[json.JSONEncoder] | None = None,
     ) -> Response:
-        return self._send_request(self.http_client.post, path, body, content_type, compress)
+        return self._send_request(
+            self.http_client.post, path, body, content_type, compress, serializer=serializer
+        )
 
     def put(
         self,
@@ -161,8 +179,12 @@ class HttpRequests:
         body: Any | None = None,
         content_type: str = "application/json",
         compress: bool = False,
+        *,
+        serializer: type[json.JSONEncoder] | None = None,
     ) -> Response:
-        return self._send_request(self.http_client.put, path, body, content_type, compress)
+        return self._send_request(
+            self.http_client.put, path, body, content_type, compress, serializer=serializer
+        )
 
     def delete(self, path: str, body: dict | None = None) -> Response:
         return self._send_request(self.http_client.delete, path, body)

meilisearch_python_sdk-2.10.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-2.8.0 → meilisearch_python_sdk-2.10.0}/meilisearch_python_sdk/decorators.py

@@ -68,7 +68,7 @@ def async_add_documents(
         >>> # with `ConnectionInfo`
         >>> @async_add_documents(
                 index_name="movies",
-                connection_info=ConnectionInfo(url="http://localhost:7700", api_key="masterKey",
+                connection_info=ConnectionInfo(url="http://localhost:7700", api_key="masterKey"),
             )
         >>> async def my_function() -> list[dict[str, Any]]:
         >>>     return [{"id": 1, "title": "Test 1"}, {"id": 2, "title": "Test 2"}]