meilisearch-python-sdk 2.2.2__tar.gz → 2.3.0__tar.gz

{meilisearch_python_sdk-2.2.2 → meilisearch_python_sdk-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 2.2.2
+Version: 2.3.0
 Summary: A Python async client for the Meilisearch API
 Home-page: https://github.com/sanders41/meilisearch-python-sdk
 License: MIT

{meilisearch_python_sdk-2.2.2 → meilisearch_python_sdk-2.3.0}/meilisearch_python_sdk/_client.py

@@ -25,9 +25,10 @@ from meilisearch_python_sdk.models.client import (
 from meilisearch_python_sdk.models.health import Health
 from meilisearch_python_sdk.models.index import IndexInfo
 from meilisearch_python_sdk.models.search import SearchParams, SearchResultsWithUID
+from meilisearch_python_sdk.models.settings import MeilisearchSettings
 from meilisearch_python_sdk.models.task import TaskInfo, TaskResult, TaskStatus
 from meilisearch_python_sdk.models.version import Version
-from meilisearch_python_sdk.types import JsonDict
+from meilisearch_python_sdk.types import JsonDict, JsonMapping
 
 
 class BaseClient:
@@ -43,7 +44,7 @@ class BaseClient:
 
     def generate_tenant_token(
         self,
-        search_rules: JsonDict | list[str],
+        search_rules: JsonMapping | list[str],
         *,
         api_key: Key,
         expires_at: datetime | None = None,
@@ -185,13 +186,24 @@ class AsyncClient(BaseClient):
 
         return TaskInfo(**response.json())
 
-    async def create_index(self, uid: str, primary_key: str | None = None) -> AsyncIndex:
+    async def create_index(
+        self,
+        uid: str,
+        primary_key: str | None = None,
+        *,
+        settings: MeilisearchSettings | None = None,
+    ) -> AsyncIndex:
         """Creates a new index.
 
         Args:
 
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
+            settings: Settings for the index. The settings can also be updated independently of
+            creating the index. The advantage to updating them here is updating the settings after
+            adding documents will cause the documents to be re-indexed. Because of this it will be
+            faster to update them before adding documents. Defaults to None (i.e. default
+            Meilisearch index settings).
 
         Returns:
 
@@ -208,7 +220,7 @@ class AsyncClient(BaseClient):
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     index = await client.create_index("movies")
         """
-        return await AsyncIndex.create(self.http_client, uid, primary_key)
+        return await AsyncIndex.create(self.http_client, uid, primary_key, settings=settings)
 
     async def create_snapshot(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch snapshot.
@@ -711,7 +723,7 @@ class AsyncClient(BaseClient):
 
             >>> from meilisearch_python_sdk import AsyncClient
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
-            >>>     health = await client.get_healths()
+            >>>     health = await client.get_health()
         """
         response = await self._http_requests.get("health")
 
@@ -1021,13 +1033,24 @@ class Client(BaseClient):
 
         return TaskInfo(**response.json())
 
-    def create_index(self, uid: str, primary_key: str | None = None) -> Index:
+    def create_index(
+        self,
+        uid: str,
+        primary_key: str | None = None,
+        *,
+        settings: MeilisearchSettings | None = None,
+    ) -> Index:
         """Creates a new index.
 
         Args:
 
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
+            settings: Settings for the index. The settings can also be updated independently of
+            creating the index. The advantage to updating them here is updating the settings after
+            adding documents will cause the documents to be re-indexed. Because of this it will be
+            faster to update them before adding documents. Defaults to None (i.e. default
+            Meilisearch index settings).
 
         Returns:
 
@@ -1044,7 +1067,7 @@ class Client(BaseClient):
             >>> client = Client("http://localhost.com", "masterKey")
             >>> index = client.create_index("movies")
         """
-        return Index.create(self.http_client, uid, primary_key)
+        return Index.create(self.http_client, uid, primary_key, settings=settings)
 
     def create_snapshot(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch snapshot.
@@ -1545,7 +1568,7 @@ class Client(BaseClient):
 
             >>> from meilisearch_python_sdk import Client
             >>> client = Client("http://localhost.com", "masterKey")
-            >>> health = client.get_healths()
+            >>> health = client.get_health()
         """
         response = self._http_requests.get("health")
 

meilisearch_python_sdk-2.3.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-2.2.2 → meilisearch_python_sdk-2.3.0}/meilisearch_python_sdk/decorators.py

@@ -19,7 +19,7 @@ class ConnectionInfo(NamedTuple):
     api_key: str
 
 
-def async_add_documments(
+def async_add_documents(
     *,
     index_name: str,
     connection_info: AsyncClient | ConnectionInfo,
@@ -101,7 +101,7 @@ def async_add_documments(
     return decorator
 
 
-def add_documments(
+def add_documents(
     *,
     index_name: str,
     connection_info: Client | ConnectionInfo,

{meilisearch_python_sdk-2.2.2 → meilisearch_python_sdk-2.3.0}/meilisearch_python_sdk/index.py

@@ -6,7 +6,7 @@ from csv import DictReader
 from datetime import datetime
 from functools import partial
 from pathlib import Path
-from typing import Any, Generator
+from typing import Any, Generator, Mapping, Sequence
 from urllib.parse import urlencode
 from warnings import warn
 
@@ -27,7 +27,7 @@ from meilisearch_python_sdk.models.settings import (
     TypoTolerance,
 )
 from meilisearch_python_sdk.models.task import TaskInfo
-from meilisearch_python_sdk.types import Filter, JsonDict
+from meilisearch_python_sdk.types import Filter, JsonDict, JsonMapping
 
 
 class BaseIndex:
@@ -223,7 +223,12 @@ class AsyncIndex(BaseIndex):
 
     @classmethod
     async def create(
-        cls, http_client: AsyncClient, uid: str, primary_key: str | None = None
+        cls,
+        http_client: AsyncClient,
+        uid: str,
+        primary_key: str | None = None,
+        *,
+        settings: MeilisearchSettings | None = None,
     ) -> AsyncIndex:
         """Creates a new index.
 
@@ -233,9 +238,14 @@ class AsyncIndex(BaseIndex):
         Args:
 
             http_client: An instance of the AsyncClient. This automatically gets passed by the
-                Client when creating and AsyncIndex instance.
+                Client when creating an AsyncIndex instance.
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
+            settings: Settings for the index. The settings can also be updated independently of
+                creating the index. The advantage to updating them here is updating the settings after
+                adding documents will cause the documents to be re-indexed. Because of this it will be
+                faster to update them before adding documents. Defaults to None (i.e. default
+                Meilisearch index settings).
 
         Returns:
 
@@ -261,9 +271,10 @@ class AsyncIndex(BaseIndex):
         http_request = AsyncHttpRequests(http_client)
         response = await http_request.post(url, payload)
         await async_wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=100000)
+
         index_response = await http_request.get(f"{url}/{uid}")
         index_dict = index_response.json()
-        return cls(
+        index = cls(
             http_client=http_client,
             uid=index_dict["uid"],
             primary_key=index_dict["primaryKey"],
@@ -271,6 +282,12 @@ class AsyncIndex(BaseIndex):
             updated_at=index_dict["updatedAt"],
         )
 
+        if settings:
+            settings_task = await index.update_settings(settings)
+            await async_wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=100000)
+
+        return index
+
     async def get_stats(self) -> IndexStats:
         """Get stats of the index.
 
@@ -619,7 +636,7 @@ class AsyncIndex(BaseIndex):
         return DocumentsInfo(**response.json())
 
     async def add_documents(
-        self, documents: list[JsonDict], primary_key: str | None = None
+        self, documents: Sequence[JsonMapping], primary_key: str | None = None
     ) -> TaskInfo:
         """Add documents to the index.
 
@@ -660,7 +677,7 @@ class AsyncIndex(BaseIndex):
 
     async def add_documents_in_batches(
         self,
-        documents: list[JsonDict],
+        documents: Sequence[JsonMapping],
         *,
         batch_size: int = 1000,
         primary_key: str | None = None,
@@ -1060,7 +1077,7 @@ class AsyncIndex(BaseIndex):
         return TaskInfo(**response.json())
 
     async def update_documents(
-        self, documents: list[JsonDict], primary_key: str | None = None
+        self, documents: Sequence[JsonMapping], primary_key: str | None = None
     ) -> TaskInfo:
         """Update documents in the index.
 
@@ -1101,7 +1118,7 @@ class AsyncIndex(BaseIndex):
 
     async def update_documents_in_batches(
         self,
-        documents: list[JsonDict],
+        documents: Sequence[JsonMapping],
         *,
         batch_size: int = 1000,
         primary_key: str | None = None,
@@ -3015,7 +3032,14 @@ class Index(BaseIndex):
         return info.primary_key
 
     @classmethod
-    def create(cls, http_client: Client, uid: str, primary_key: str | None = None) -> Index:
+    def create(
+        cls,
+        http_client: Client,
+        uid: str,
+        primary_key: str | None = None,
+        *,
+        settings: MeilisearchSettings | None = None,
+    ) -> Index:
         """Creates a new index.
 
         In general this method should not be used directly and instead the index should be created
@@ -3024,9 +3048,14 @@ class Index(BaseIndex):
         Args:
 
             http_client: An instance of the Client. This automatically gets passed by the Client
-                when creating and Index instance.
+                when creating an Index instance.
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
+            settings: Settings for the index. The settings can also be updated independently of
+                creating the index. The advantage to updating them here is updating the settings after
+                adding documents will cause the documents to be re-indexed. Because of this it will be
+                faster to update them before adding documents. Defaults to None (i.e. default
+                Meilisearch index settings).
 
         Returns:
 
@@ -3054,7 +3083,7 @@ class Index(BaseIndex):
         wait_for_task(http_client, response.json()["taskUid"], timeout_in_ms=100000)
         index_response = http_request.get(f"{url}/{uid}")
         index_dict = index_response.json()
-        return cls(
+        index = cls(
             http_client=http_client,
             uid=index_dict["uid"],
             primary_key=index_dict["primaryKey"],
@@ -3062,6 +3091,12 @@ class Index(BaseIndex):
             updated_at=index_dict["updatedAt"],
         )
 
+        if settings:
+            settings_task = index.update_settings(settings)
+            wait_for_task(http_client, settings_task.task_uid, timeout_in_ms=10000)
+
+        return index
+
     def get_stats(self) -> IndexStats:
         """Get stats of the index.
 
@@ -3406,7 +3441,9 @@ class Index(BaseIndex):
 
         return DocumentsInfo(**response.json())
 
-    def add_documents(self, documents: list[JsonDict], primary_key: str | None = None) -> TaskInfo:
+    def add_documents(
+        self, documents: Sequence[JsonMapping], primary_key: str | None = None
+    ) -> TaskInfo:
         """Add documents to the index.
 
         Args:
@@ -3446,7 +3483,7 @@ class Index(BaseIndex):
 
     def add_documents_in_batches(
         self,
-        documents: list[JsonDict],
+        documents: Sequence[JsonMapping],
         *,
         batch_size: int = 1000,
         primary_key: str | None = None,
@@ -3794,7 +3831,7 @@ class Index(BaseIndex):
         return TaskInfo(**response.json())
 
     def update_documents(
-        self, documents: list[JsonDict], primary_key: str | None = None
+        self, documents: Sequence[JsonMapping], primary_key: str | None = None
     ) -> TaskInfo:
         """Update documents in the index.
 
@@ -3835,7 +3872,7 @@ class Index(BaseIndex):
 
     def update_documents_in_batches(
         self,
-        documents: list[JsonDict],
+        documents: Sequence[JsonMapping],
         *,
         batch_size: int = 1000,
         primary_key: str | None = None,
@@ -5549,7 +5586,9 @@ async def _async_load_documents_from_file(
         return documents
 
 
-def _batch(documents: list[dict], batch_size: int) -> Generator[list[dict], None, None]:
+def _batch(
+    documents: Sequence[Mapping], batch_size: int
+) -> Generator[Sequence[Mapping], None, None]:
     total_len = len(documents)
     for i in range(0, total_len, batch_size):
         yield documents[i : i + batch_size]
@@ -5667,7 +5706,7 @@ def _process_search_parameters(
     return body
 
 
-def _build_encoded_url(base_url: str, params: JsonDict) -> str:
+def _build_encoded_url(base_url: str, params: JsonMapping) -> str:
     return f"{base_url}?{urlencode(params)}"
 
 

meilisearch_python_sdk-2.3.0/meilisearch_python_sdk/types.py

@@ -0,0 +1,5 @@
+from typing import Any, Dict, List, Mapping, Union
+
+Filter = Union[str, List[Union[str, List[str]]]]
+JsonDict = Dict[str, Any]
+JsonMapping = Mapping[str, Any]

{meilisearch_python_sdk-2.2.2 → meilisearch_python_sdk-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "meilisearch-python-sdk"
-version = "2.2.2"
+version = "2.3.0"
 description = "A Python async client for the Meilisearch API"
 authors = ["Paul Sanders <psanders1@gmail.com>"]
 license = "MIT"

meilisearch_python_sdk-2.2.2/meilisearch_python_sdk/_version.py

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

meilisearch_python_sdk-2.2.2/meilisearch_python_sdk/types.py

@@ -1,4 +0,0 @@
-from typing import Any, Dict, List, Union
-
-Filter = Union[str, List[Union[str, List[str]]]]
-JsonDict = Dict[str, Any]