meilisearch-python-sdk 2.2.3__tar.gz → 2.4.0__tar.gz

{meilisearch_python_sdk-2.2.3 → meilisearch_python_sdk-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 2.2.3
+Version: 2.4.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.3 → meilisearch_python_sdk-2.4.0}/meilisearch_python_sdk/_client.py

@@ -25,8 +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.plugins import AsyncIndexPlugins, IndexPlugins
 from meilisearch_python_sdk.types import JsonDict, JsonMapping
 
 
@@ -185,13 +187,26 @@ 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,
+        plugins: AsyncIndexPlugins | 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).
+            plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
 
@@ -208,7 +223,9 @@ 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, plugins=plugins
+        )
 
     async def create_snapshot(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch snapshot.
@@ -327,7 +344,7 @@ class AsyncClient(BaseClient):
         """
         return await AsyncIndex(self.http_client, uid).fetch_info()
 
-    def index(self, uid: str) -> AsyncIndex:
+    def index(self, uid: str, *, plugins: AsyncIndexPlugins | None = None) -> AsyncIndex:
         """Create a local reference to an index identified by UID, without making an HTTP call.
 
         Because no network call is made this method is not awaitable.
@@ -335,6 +352,7 @@ class AsyncClient(BaseClient):
         Args:
 
             uid: The index's unique identifier.
+            plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
 
@@ -351,7 +369,7 @@ class AsyncClient(BaseClient):
             >>> async with AsyncClient("http://localhost.com", "masterKey") as client:
             >>>     index = client.index("movies")
         """
-        return AsyncIndex(self.http_client, uid=uid)
+        return AsyncIndex(self.http_client, uid=uid, plugins=plugins)
 
     async def get_all_stats(self) -> ClientStats:
         """Get stats for all indexes.
@@ -376,13 +394,16 @@ class AsyncClient(BaseClient):
 
         return ClientStats(**response.json())
 
-    async def get_or_create_index(self, uid: str, primary_key: str | None = None) -> AsyncIndex:
+    async def get_or_create_index(
+        self, uid: str, primary_key: str | None = None, *, plugins: AsyncIndexPlugins | None = None
+    ) -> AsyncIndex:
         """Get an index, or create it if it doesn't exist.
 
         Args:
 
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
+            plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
 
@@ -405,7 +426,7 @@ class AsyncClient(BaseClient):
         except MeilisearchApiError as err:
             if "index_not_found" not in err.code:
                 raise
-            index_instance = await self.create_index(uid, primary_key)
+            index_instance = await self.create_index(uid, primary_key, plugins=plugins)
         return index_instance
 
     async def create_key(self, key: KeyCreate) -> Key:
@@ -1021,13 +1042,26 @@ 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,
+        plugins: IndexPlugins | 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).
+            plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
 
@@ -1044,7 +1078,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, plugins=plugins)
 
     def create_snapshot(self) -> TaskInfo:
         """Trigger the creation of a Meilisearch snapshot.
@@ -1163,12 +1197,13 @@ class Client(BaseClient):
         """
         return Index(self.http_client, uid).fetch_info()
 
-    def index(self, uid: str) -> Index:
+    def index(self, uid: str, *, plugins: IndexPlugins | None = None) -> Index:
         """Create a local reference to an index identified by UID, without making an HTTP call.
 
         Args:
 
             uid: The index's unique identifier.
+            plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
 
@@ -1185,7 +1220,7 @@ class Client(BaseClient):
             >>> client = Client("http://localhost.com", "masterKey")
             >>> index = client.index("movies")
         """
-        return Index(self.http_client, uid=uid)
+        return Index(self.http_client, uid=uid, plugins=plugins)
 
     def get_all_stats(self) -> ClientStats:
         """Get stats for all indexes.
@@ -1210,13 +1245,16 @@ class Client(BaseClient):
 
         return ClientStats(**response.json())
 
-    def get_or_create_index(self, uid: str, primary_key: str | None = None) -> Index:
+    def get_or_create_index(
+        self, uid: str, primary_key: str | None = None, *, plugins: IndexPlugins | None = None
+    ) -> Index:
         """Get an index, or create it if it doesn't exist.
 
         Args:
 
             uid: The index's unique identifier.
             primary_key: The primary key of the documents. Defaults to None.
+            plugins: Optional plugins can be provided to extend functionality.
 
         Returns:
 
@@ -1239,7 +1277,7 @@ class Client(BaseClient):
         except MeilisearchApiError as err:
             if "index_not_found" not in err.code:
                 raise
-            index_instance = self.create_index(uid, primary_key)
+            index_instance = self.create_index(uid, primary_key, plugins=plugins)
         return index_instance
 
     def create_key(self, key: KeyCreate) -> Key:

meilisearch_python_sdk-2.4.0/meilisearch_python_sdk/_version.py

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