meilisearch-python-sdk 2.11.1__py3-none-any.whl → 2.12.0__py3-none-any.whl

meilisearch_python_sdk/_client.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 import json
 from datetime import datetime, timezone
 from ssl import SSLContext
-from types import TracebackType
+from typing import TYPE_CHECKING
 from warnings import warn
 
 import jwt
@@ -29,19 +29,34 @@ 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
+
+if TYPE_CHECKING:  # pragma: no cover
+    import sys
+    from types import TracebackType
+
+    from meilisearch_python_sdk.types import JsonDict, JsonMapping
+
+    if sys.version_info >= (3, 11):
+        from typing import Self
+    else:
+        from typing_extensions import Self
 
 
 class BaseClient:
     def __init__(
         self,
         api_key: str | None = None,
+        custom_headers: dict[str, str] | None = None,
     ) -> None:
-        self._headers: dict[str, str] | None
+        self._headers: dict[str, str] | None = None
         if api_key:
             self._headers = {"Authorization": f"Bearer {api_key}"}
-        else:
-            self._headers = None
+
+        if custom_headers:
+            if self._headers:
+                self._headers.update(custom_headers)
+            else:
+                self._headers = custom_headers
 
     def generate_tenant_token(
         self,
@@ -127,6 +142,7 @@ class AsyncClient(BaseClient):
         *,
         timeout: int | None = None,
         verify: str | bool | SSLContext = True,
+        custom_headers: dict[str, str] | None = None,
     ) -> None:
         """Class initializer.
 
@@ -139,15 +155,17 @@ class AsyncClient(BaseClient):
             verify: SSL certificates (a.k.a CA bundle) used to
                 verify the identity of requested hosts. Either `True` (default CA bundle),
                 a path to an SSL certificate file, or `False` (disable verification)
+            custom_headers: Custom headers to add when sending data to Meilisearch. Defaults to
+                None.
         """
-        super().__init__(api_key)
+        super().__init__(api_key, custom_headers)
 
         self.http_client = HttpxAsyncClient(
             base_url=url, timeout=timeout, headers=self._headers, verify=verify
         )
         self._http_requests = AsyncHttpRequests(self.http_client)
 
-    async def __aenter__(self) -> AsyncClient:
+    async def __aenter__(self) -> Self:
         return self
 
     async def __aexit__(
@@ -1016,6 +1034,7 @@ class Client(BaseClient):
         *,
         timeout: int | None = None,
         verify: str | bool | SSLContext = True,
+        custom_headers: dict[str, str] | None = None,
     ) -> None:
         """Class initializer.
 
@@ -1028,8 +1047,10 @@ class Client(BaseClient):
             verify: SSL certificates (a.k.a CA bundle) used to
                 verify the identity of requested hosts. Either `True` (default CA bundle),
                 a path to an SSL certificate file, or `False` (disable verification)
+            custom_headers: Custom headers to add when sending data to Meilisearch. Defaults to
+                None.
         """
-        super().__init__(api_key)
+        super().__init__(api_key, custom_headers)
 
         self.http_client = HttpxClient(
             base_url=url, timeout=timeout, headers=self._headers, verify=verify

meilisearch_python_sdk/_version.py

@@ -1 +1 @@
-VERSION = "2.11.1"
+VERSION = "2.12.0"

meilisearch_python_sdk/index.py

@@ -54,8 +54,15 @@ from meilisearch_python_sdk.plugins import (
 )
 
 if TYPE_CHECKING:  # pragma: no cover
+    import sys
+
     from meilisearch_python_sdk.types import Filter, JsonDict, JsonMapping
 
+    if sys.version_info >= (3, 11):
+        from typing import Self
+    else:
+        from typing_extensions import Self
+
 
 class _BaseIndex:
     def __init__(
@@ -533,7 +540,7 @@ class AsyncIndex(_BaseIndex):
 
         return False
 
-    async def update(self, primary_key: str) -> AsyncIndex:
+    async def update(self, primary_key: str) -> Self:
         """Update the index primary key.
 
         Args:
@@ -565,7 +572,7 @@ class AsyncIndex(_BaseIndex):
         self.primary_key = index_response.json()["primaryKey"]
         return self
 
-    async def fetch_info(self) -> AsyncIndex:
+    async def fetch_info(self) -> Self:
         """Gets the infromation about the index.
 
         Returns:
@@ -624,7 +631,7 @@ class AsyncIndex(_BaseIndex):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
-    ) -> AsyncIndex:
+    ) -> Self:
         """Creates a new index.
 
         In general this method should not be used directly and instead the index should be created
@@ -4905,7 +4912,7 @@ class Index(_BaseIndex):
 
         return False
 
-    def update(self, primary_key: str) -> Index:
+    def update(self, primary_key: str) -> Self:
         """Update the index primary key.
 
         Args:
@@ -4935,7 +4942,7 @@ class Index(_BaseIndex):
         self.primary_key = index_response.json()["primaryKey"]
         return self
 
-    def fetch_info(self) -> Index:
+    def fetch_info(self) -> Self:
         """Gets the infromation about the index.
 
         Returns:
@@ -4994,7 +5001,7 @@ class Index(_BaseIndex):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
-    ) -> Index:
+    ) -> Self:
         """Creates a new index.
 
         In general this method should not be used directly and instead the index should be created

meilisearch_python_sdk/types.py

@@ -1,5 +1,11 @@
+import sys
 from typing import Any, Dict, List, MutableMapping, Union
 
-Filter = Union[str, List[Union[str, List[str]]]]
-JsonDict = Dict[str, Any]
-JsonMapping = MutableMapping[str, Any]
+if sys.version_info >= (3, 10):  # pragma: no cover
+    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-2.11.1.dist-info → meilisearch_python_sdk-2.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 2.11.1
+Version: 2.12.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

{meilisearch_python_sdk-2.11.1.dist-info → meilisearch_python_sdk-2.12.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=uUwIsqr47_a4XaElsP2ew0H-M4VGNHOUNNwNpW9CtYw,66791
+meilisearch_python_sdk/_client.py,sha256=UuTYt5qPh0N5ziuRawSJhz_rharRkmIew-lTjHeR7nE,67568
 meilisearch_python_sdk/_http_requests.py,sha256=codxloe8PeV1e7WCzC9N_DDMJu5_UqSRZl2g4f8O9hE,7073
 meilisearch_python_sdk/_task.py,sha256=HiyrLsQn5O2PlnUsKPc0RLSPZnJMIsiwA3WSmFsU2Qk,11874
 meilisearch_python_sdk/_utils.py,sha256=SMoBWDlLtAEtpD8n94CCcHvtBA-HLWyolxPY-n4K_UE,1610
-meilisearch_python_sdk/_version.py,sha256=HBjUBr8Pc7t7KGSSL56EtHb3w2c4ELcCtsap2ibZD7g,19
+meilisearch_python_sdk/_version.py,sha256=Oims9BkxGWftvFLEp8GVkzcqnafuqqtIAC-q_iATlUc,19
 meilisearch_python_sdk/decorators.py,sha256=KpS5gAgks28BtPMZJumRaXfgXK4A3QNVPR8Z4BpZC0g,8346
 meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
-meilisearch_python_sdk/index.py,sha256=USNG8RqmyIuhVhZB0Ba3Uirm18Wm9PeCIDuKT3OlKzE,323068
+meilisearch_python_sdk/index.py,sha256=OnMb-K1MTa-CFt4HbMYzUR7Q-gEZ2UFYgXbu8AKJoeI,323185
 meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 meilisearch_python_sdk/models/client.py,sha256=Ka-BgBXmWGqwRm95r2y-vJYFm95fgDamXlPXdfBVvzo,5700
 meilisearch_python_sdk/models/documents.py,sha256=1X6y-gPRD1sB8V-2b-c-gOmQEs-yR8e7ZiY5TWwFNBs,236
@@ -18,8 +18,8 @@ meilisearch_python_sdk/models/task.py,sha256=6wVY6M9HlIjMaMUMq63RbcsnqOBWrDVUBDw
 meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
 meilisearch_python_sdk/plugins.py,sha256=qfc5smEvOqYV_okdcmnJgDszCzOpmUPG1oA2UYCw5dE,3580
 meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meilisearch_python_sdk/types.py,sha256=BoZcEdkazGKp3Hh6h5yMDtDBLYjOQjQW3SH0cO8k8kw,173
-meilisearch_python_sdk-2.11.1.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-2.11.1.dist-info/METADATA,sha256=UyYQ3H8UbxhMRs5z2xFkO0WNWpkktXL1D40vpz4Udjo,8265
-meilisearch_python_sdk-2.11.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-meilisearch_python_sdk-2.11.1.dist-info/RECORD,,
+meilisearch_python_sdk/types.py,sha256=qQV3sOaUDm5xwY8nsLtusObDvDO-I8jSNMiaNqQn-W0,353
+meilisearch_python_sdk-2.12.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-2.12.0.dist-info/METADATA,sha256=rQx3bDg4mp58U_KYFUYaB5KenkeB68ps-b6JF1xIJ9g,8265
+meilisearch_python_sdk-2.12.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+meilisearch_python_sdk-2.12.0.dist-info/RECORD,,