meilisearch-python-sdk 5.7.0__tar.gz → 6.0.0__tar.gz

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/.pre-commit-config.yaml

@@ -14,7 +14,7 @@ repos:
       - id: mypy
         additional_dependencies: [pydantic, orjson, types-aiofiles, types-ujson]
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.10
+    rev: v0.14.11
     hooks:
       - id: ruff-check
         args: [--fix, --exit-non-zero-on-fix]

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/CONTRIBUTING.md

@@ -76,7 +76,7 @@ git checkout main
 git pull upstream main --ff-only
 ```
 
-### Code Standards and tests (ruff, mypy, pytest, and pre-commit)
+### Code Standards and tests (ruff, mypy, pytest, and prek)
 
 meilisearch-python-sdk uses [ruff](https://github.com/charliermarsh/ruff), and
 [mypy](https://mypy.readthedocs.io/en/stable/) to ensure consistent code formatting.
@@ -94,18 +94,18 @@ uv run ruff check .
 uv run mypy meilisearch_python_sdk
 ```
 
-It is also suggested that you setup [pre-commit](https://pre-commit.com/) in order to run linting
-when you commit changes to you branch. To setup pre-commit for this project run:
+It is also suggested that you setup [prek](https://github.com/j178/prek) in order to run linting
+when you commit changes to you branch. To setup prek for this project run:
 
 ```sh
-pre-commit install
+prek install
 ```
 
-After this pre-commit will automatically run any time you check in code to your branches. You can
-also run pre-commit at any time with:
+After this prek will automatically run any time you check in code to your branches. You can
+also run prek at any time with:
 
 ```sh
-pre-commit run --all-files
+prek run --all-files
 ```
 
 ### Type Hints
@@ -224,7 +224,7 @@ Now you can commit your changes in your local repository:
 git commit -am 'Some short helpful message to describe your changes'
 ```
 
-If you setup pre-commit and any of the tests fail the commit will be cancelled and you will need to
+If you setup prek and any of the tests fail the commit will be cancelled and you will need to
 fix any errors. Once the errors are fixed you can run the same git commit command again.
 
 ## Push your changes

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: meilisearch-python-sdk
-Version: 5.7.0
+Version: 6.0.0
 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
@@ -47,11 +47,8 @@ Requires-Dist: pydantic>=2.0.0
 Requires-Dist: pyjwt>=2.3.0
 Provides-Extra: all
 Requires-Dist: orjson; extra == 'all'
-Requires-Dist: ujson; extra == 'all'
 Provides-Extra: orjson
 Requires-Dist: orjson>=3.10.6; extra == 'orjson'
-Provides-Extra: ujson
-Requires-Dist: ujson>=5.10.0; extra == 'ujson'
 Description-Content-Type: text/markdown
 
 # Meilisearch Python SDK

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/docs/js/umami.js

@@ -1,7 +1,7 @@
 document.addEventListener("DOMContentLoaded", function () {
   var umamiScript = document.createElement("script");
   umamiScript.defer = true;
-  umamiScript.src = "https://cloud.umami.is/script.js";
-  umamiScript.dataset.websiteId = "29a9d193-92a3-44d0-9b1d-16ddd23898fb";
+  umamiScript.src = "https://analytics.pbsdatasolutions.com/script.js";
+  umamiScript.dataset.websiteId = "c1557f38-bc02-4277-82b4-22a7029f42ba";
   document.head.appendChild(umamiScript);
 });

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/docs/json_handler.md

@@ -1,9 +1,9 @@
 # JSON Handler
 
-For json loads and dumps you have the option to use the `json` module from the standard library,
-orjson, or ujson. This done by setting the `json_handler` when creating the `AsyncClient` or
-`Client`. By default the standard library `json` module will be used. The examples below use
-`Client`, and the same options are available for `AsyncClient`.
+For json loads and dumps you have the option to use the `json` module from the standard library, or
+orjson. This done by setting the `json_handler` when creating the `AsyncClient` or `Client`. By
+default the standard library `json` module will be used. The examples below use `Client`, and the
+same options are available for `AsyncClient`.
 
 ## Standard Library `json` Module
 
@@ -61,23 +61,3 @@ with Client("http://127.0.0.1:7700", json_handler=OrjsonHandler()) as client:
     index = client.index("movies", primary_key="id")
     index.add_documents(documents)
 ```
-
-## ujson
-
-### Example
-
-```py
-from uuid import uuid4
-
-from meilisearch_python_sdk import Client
-from meilisearch_python_sdk.json_handler import UjsonHandler
-
-
-documents = [
-    {"id": uuid4(), "title": "test 1"},
-    {"id": uuid4(), "title": "Test 2"},
-]
-with Client("http://127.0.0.1:7700", json_handler=UjsonHandler()) as client:
-    index = client.index("movies", primary_key="id")
-    index.add_documents(documents)
-```

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/examples/async_documents_and_search_results.py

@@ -19,7 +19,11 @@ class ModifyDocumentPlugin:
     PRE_EVENT = True  # Specifies the plugin should be run before adding documents
 
     async def run_document_plugin(
-        self, event: AsyncEvent, *, documents: Sequence[JsonMapping], **kwargs: Any
+        self,
+        event: AsyncEvent,
+        *,
+        documents: Sequence[JsonMapping],
+        **kwargs: Any,  # noqa: ANN401
     ) -> Sequence[JsonMapping]:
         updated = []
         for i, document in enumerate(documents):
@@ -39,7 +43,11 @@ class FilterSearchResultsPlugin:
     PRE_EVENT = False
 
     async def run_post_search_plugin(
-        self, event: AsyncEvent, *, search_results: SearchResults, **kwargs: Any
+        self,
+        event: AsyncEvent,
+        *,
+        search_results: SearchResults,
+        **kwargs: Any,  # noqa: ANN401
     ) -> SearchResults:
         filtered_hits = []
         for hit in search_results.hits:

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/examples/async_search_tracker.py

@@ -31,7 +31,7 @@ class SearchTrackerPlugin:
         finally:
             cursor.close()
 
-    async def run_plugin(self, event: AsyncEvent, **kwargs: Any) -> None:
+    async def run_plugin(self, event: AsyncEvent, **kwargs: Any) -> None:  # noqa: ANN401
         """Note that this example uses sqlite which does not provide an async driver.
 
         Typically if you are using the AsyncClient you would also be using an async driver for the

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/examples/documents_and_search_results.py

@@ -15,7 +15,11 @@ class ModifyDocumentPlugin:
     PRE_EVENT = True  # Specifies the plugin should be run before adding documents
 
     def run_document_plugin(
-        self, event: Event, *, documents: Sequence[JsonMapping], **kwargs: Any
+        self,
+        event: Event,
+        *,
+        documents: Sequence[JsonMapping],
+        **kwargs: Any,  # noqa: ANN401
     ) -> Sequence[JsonMapping]:
         updated = []
         for i, document in enumerate(documents):
@@ -34,7 +38,11 @@ class FilterSearchResultsPlugin:
     PRE_EVENT = False
 
     def run_post_search_plugin(
-        self, event: Event, *, search_results: SearchResults, **kwargs: Any
+        self,
+        event: Event,
+        *,
+        search_results: SearchResults,
+        **kwargs: Any,  # noqa: ANN401
     ) -> SearchResults:
         filtered_hits = []
         for hit in search_results.hits:

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/examples/search_tracker.py

@@ -27,7 +27,7 @@ class SearchTrackerPlugin:
         finally:
             cursor.close()
 
-    def run_plugin(self, event: Event, **kwargs: Any) -> None:
+    def run_plugin(self, event: Event, **kwargs: Any) -> None:  # noqa: ANN401
         if kwargs.get("query"):
             self.save_search_query(kwargs["query"])
 

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/examples/tests/test_examples.py

@@ -3,7 +3,6 @@ from uuid import uuid4
 from examples.orjson_example import add_documents as orjson_add_documents
 from examples.search_tracker import SearchTrackerPlugin, search
 from examples.search_tracker import add_documents as search_tracker_add_documents
-from examples.ujson_example import add_documents as ujson_add_documents
 from examples.update_settings import add_documents as update_settings_add_documents
 from examples.update_settings import update_settings
 from meilisearch_python_sdk.plugins import IndexPlugins
@@ -38,10 +37,3 @@ def test_update_settings(small_movies_path, empty_index, client):
     client.wait_for_task(task.task_uid)
     result = client.get_task(task.task_uid)
     assert result.status == "succeeded"
-
-
-def test_ujson_example(small_movies_path, client):
-    task = ujson_add_documents(small_movies_path)
-    client.wait_for_task(task.task_uid)
-    result = client.get_task(task.task_uid)
-    assert result.status == "succeeded"

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/meilisearch_python_sdk/_client.py

@@ -16,7 +16,7 @@ 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
-from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler, UjsonHandler
+from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 from meilisearch_python_sdk.models.client import (
     ClientStats,
     Key,
@@ -41,7 +41,7 @@ from meilisearch_python_sdk.models.webhook import Webhook, WebhookCreate, Webhoo
 from meilisearch_python_sdk.plugins import AsyncIndexPlugins, IndexPlugins
 from meilisearch_python_sdk.types import JsonDict
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     import sys
     from types import TracebackType
 
@@ -59,7 +59,7 @@ class BaseClient:
         self,
         api_key: str | None = None,
         custom_headers: dict[str, str] | None = None,
-        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        json_handler: BuiltinHandler | OrjsonHandler | None = None,
     ) -> None:
         self.json_handler = json_handler if json_handler else BuiltinHandler()
         self._headers: dict[str, str] | None = None
@@ -153,7 +153,7 @@ class AsyncClient(BaseClient):
         timeout: int | None = None,
         verify: bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
-        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        json_handler: BuiltinHandler | OrjsonHandler | None = None,
         http2: bool = False,
     ) -> None:
         """Class initializer.
@@ -169,9 +169,9 @@ class AsyncClient(BaseClient):
             custom_headers: Custom headers to add when sending data to Meilisearch. Defaults to
                 None.
             json_handler: The module to use for json operations. The options are BuiltinHandler
-                (uses the json module from the standard library), OrjsonHandler (uses orjson), or
-                UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
-                extra needs to be included. Default: BuiltinHandler.
+                (uses the json module from the standard library), or OrjsonHandler (uses orjson).
+                Note that in order use orjson the corresponding extra needs to be included.
+                Default: BuiltinHandler.
             http2: Whether or not to use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
@@ -399,7 +399,7 @@ class AsyncClient(BaseClient):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
-        hits_type: Any = JsonDict,
+        hits_type: Any = JsonDict,  # noqa: ANN401
     ) -> AsyncIndex:
         """Creates a new index.
 
@@ -602,7 +602,7 @@ class AsyncClient(BaseClient):
         primary_key: str | None = None,
         *,
         plugins: AsyncIndexPlugins | None = None,
-        hits_type: Any = JsonDict,
+        hits_type: Any = JsonDict,  # noqa: ANN401
     ) -> AsyncIndex:
         """Get an index, or create it if it doesn't exist.
 
@@ -770,7 +770,7 @@ class AsyncClient(BaseClient):
         queries: list[SearchParams],
         *,
         federation: Federation | FederationMerged | None = None,
-        hits_type: Any = JsonDict,
+        hits_type: Any = JsonDict,  # noqa: ANN401
     ) -> list[SearchResultsWithUID] | SearchResultsFederated:
         """Multi-index search.
 
@@ -1316,7 +1316,7 @@ class Client(BaseClient):
         timeout: int | None = None,
         verify: bool | SSLContext = True,
         custom_headers: dict[str, str] | None = None,
-        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        json_handler: BuiltinHandler | OrjsonHandler | None = None,
         http2: bool = False,
     ) -> None:
         """Class initializer.
@@ -1332,9 +1332,9 @@ class Client(BaseClient):
             custom_headers: Custom headers to add when sending data to Meilisearch. Defaults to
                 None.
             json_handler: The module to use for json operations. The options are BuiltinHandler
-                (uses the json module from the standard library), OrjsonHandler (uses orjson), or
-                UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
-                extra needs to be included. Default: BuiltinHandler.
+                (uses the json module from the standard library), or OrjsonHandler (uses orjson).
+                Note that in order use orjson the corresponding extra needs to be included.
+                Default: BuiltinHandler.
             http2: If set to True, the client will use HTTP/2. Defaults to False.
         """
         super().__init__(api_key, custom_headers, json_handler)
@@ -1564,7 +1564,7 @@ class Client(BaseClient):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: IndexPlugins | None = None,
-        hits_type: Any = JsonDict,
+        hits_type: Any = JsonDict,  # noqa: ANN401
     ) -> Index:
         """Creates a new index.
 
@@ -1762,7 +1762,7 @@ class Client(BaseClient):
         primary_key: str | None = None,
         *,
         plugins: IndexPlugins | None = None,
-        hits_type: Any = JsonDict,
+        hits_type: Any = JsonDict,  # noqa: ANN401
     ) -> Index:
         """Get an index, or create it if it doesn't exist.
 
@@ -1929,7 +1929,7 @@ class Client(BaseClient):
         queries: list[SearchParams],
         *,
         federation: Federation | FederationMerged | None = None,
-        hits_type: Any = JsonDict,
+        hits_type: Any = JsonDict,  # noqa: ANN401
     ) -> list[SearchResultsWithUID] | SearchResultsFederated:
         """Multi-index search.
 
@@ -2467,7 +2467,7 @@ def _build_offset_limit_url(base: str, offset: int | None, limit: int | None) ->
 
 
 def _build_update_key_payload(
-    key: KeyUpdate, json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler
+    key: KeyUpdate, json_handler: BuiltinHandler | OrjsonHandler
 ) -> JsonDict:
     # The json_handler.loads(key.json()) is because Pydantic can't serialize a date in a Python dict,
     # but can when converting to a json string.

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/meilisearch_python_sdk/_http_requests.py

@@ -21,17 +21,17 @@ from meilisearch_python_sdk.errors import (
     MeilisearchCommunicationError,
     MeilisearchError,
 )
-from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler, UjsonHandler
+from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 
 
 class AsyncHttpRequests:
     def __init__(
-        self, http_client: AsyncClient, json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler
+        self, http_client: AsyncClient, json_handler: BuiltinHandler | OrjsonHandler
     ) -> None:
         self.http_client = http_client
         self.json_handler = json_handler
 
-    def parse_json(self, response: Response) -> Any:
+    def parse_json(self, response: Response) -> Any:  # noqa: ANN401
         """Parse JSON response using the custom json_handler."""
         return self.json_handler.loads(response.content)
 
@@ -39,7 +39,7 @@ class AsyncHttpRequests:
         self,
         http_method: Callable,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -89,7 +89,7 @@ class AsyncHttpRequests:
     async def patch(
         self,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -98,7 +98,7 @@ class AsyncHttpRequests:
     async def post(
         self,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -107,7 +107,7 @@ class AsyncHttpRequests:
     async def put(
         self,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -118,13 +118,11 @@ class AsyncHttpRequests:
 
 
 class HttpRequests:
-    def __init__(
-        self, http_client: Client, json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler
-    ) -> None:
+    def __init__(self, http_client: Client, json_handler: BuiltinHandler | OrjsonHandler) -> None:
         self.http_client = http_client
         self.json_handler = json_handler
 
-    def parse_json(self, response: Response) -> Any:
+    def parse_json(self, response: Response) -> Any:  # noqa: ANN401
         """Parse JSON response using the custom json_handler."""
         return self.json_handler.loads(response.content)
 
@@ -132,7 +130,7 @@ class HttpRequests:
         self,
         http_method: Callable,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -179,7 +177,7 @@ class HttpRequests:
     def patch(
         self,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -188,7 +186,7 @@ class HttpRequests:
     def post(
         self,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:
@@ -197,7 +195,7 @@ class HttpRequests:
     def put(
         self,
         path: str,
-        body: Any | None = None,
+        body: Any | None = None,  # noqa: ANN401
         content_type: str = "application/json",
         compress: bool = False,
     ) -> Response:

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/meilisearch_python_sdk/_utils.py

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING
 from httpx import AsyncClient as HttpxAsyncClient
 from httpx import Client as HttpxClient
 
-from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler, UjsonHandler
+from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 
 if TYPE_CHECKING:
     from meilisearch_python_sdk._client import AsyncClient, Client  # pragma: no cover
@@ -34,7 +34,7 @@ def get_client(
 
 def get_json_handler(
     client: AsyncClient | Client | HttpxAsyncClient | HttpxClient,
-) -> BuiltinHandler | OrjsonHandler | UjsonHandler:
+) -> BuiltinHandler | OrjsonHandler:
     if isinstance(client, (HttpxAsyncClient, HttpxClient)):
         return BuiltinHandler()
 

meilisearch_python_sdk-6.0.0/meilisearch_python_sdk/_version.py

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

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/meilisearch_python_sdk/decorators.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
 
 import asyncio
-from collections.abc import Callable
+from collections.abc import Callable, Sequence
 from functools import wraps
 from typing import Any, NamedTuple
 
 from meilisearch_python_sdk import AsyncClient, Client
 from meilisearch_python_sdk._utils import use_task_groups
+from meilisearch_python_sdk.types import JsonMapping
 
 
 class ConnectionInfo(NamedTuple):
@@ -75,7 +76,7 @@ def async_add_documents(
 
     def decorator(func: Callable) -> Callable:
         @wraps(func)
-        async def wrapper(*args: Any, **kwargs: Any) -> Any:
+        async def wrapper(*args: Any, **kwargs: Any) -> Any:  # noqa: ANN401
             result = await func(*args, **kwargs)
             if isinstance(connection_info, AsyncClient):
                 await _async_add_documents(
@@ -157,7 +158,7 @@ def add_documents(
 
     def decorator(func: Callable) -> Callable:
         @wraps(func)
-        def wrapper(*args: Any, **kwargs: Any) -> Any:
+        def wrapper(*args: Any, **kwargs: Any) -> Any:  # noqa: ANN401
             result = func(*args, **kwargs)
             if isinstance(connection_info, Client):
                 _add_documents(
@@ -192,7 +193,7 @@ def add_documents(
 async def _async_add_documents(
     async_client: AsyncClient,
     index_name: str,
-    documents: Any,
+    documents: Sequence[JsonMapping],
     batch_size: int | None,
     primary_key: str | None,
     wait_for_task: bool,
@@ -221,7 +222,7 @@ async def _async_add_documents(
 def _add_documents(
     client: Client,
     index_name: str,
-    documents: Any,
+    documents: Sequence[JsonMapping],
     batch_size: int | None,
     primary_key: str | None,
     wait_for_task: bool,

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/meilisearch_python_sdk/index/_common.py

@@ -9,10 +9,8 @@ from urllib.parse import urlencode
 
 from meilisearch_python_sdk._utils import iso_to_date_time
 from meilisearch_python_sdk.errors import MeilisearchError
-from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler, UjsonHandler
-from meilisearch_python_sdk.models.search import (
-    Hybrid,
-)
+from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
+from meilisearch_python_sdk.models.search import Hybrid
 from meilisearch_python_sdk.models.settings import (
     CompositeEmbedder,
     Embedders,
@@ -32,16 +30,9 @@ from meilisearch_python_sdk.plugins import (
 )
 from meilisearch_python_sdk.types import JsonDict
 
-if TYPE_CHECKING:  # pragma: no cover
-    import sys
-
+if TYPE_CHECKING:
     from meilisearch_python_sdk.types import Filter, JsonMapping
 
-    if sys.version_info >= (3, 11):
-        pass
-    else:
-        pass
-
 
 class BaseIndex:
     def __init__(
@@ -50,9 +41,9 @@ class BaseIndex:
         primary_key: str | None = None,
         created_at: str | datetime | None = None,
         updated_at: str | datetime | None = None,
-        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
-        hits_type: Any = JsonDict,
-    ):
+        json_handler: BuiltinHandler | OrjsonHandler | None = None,
+        hits_type: Any = JsonDict,  # noqa: ANN401
+    ) -> None:
         self.uid = uid
         self.primary_key = primary_key
         self.created_at: datetime | None = iso_to_date_time(created_at)

{meilisearch_python_sdk-5.7.0 → meilisearch_python_sdk-6.0.0}/meilisearch_python_sdk/index/async_index.py

@@ -29,7 +29,7 @@ from meilisearch_python_sdk.index._common import (
     validate_ranking_score_threshold,
 )
 from meilisearch_python_sdk.index._common import combine_documents as combine_documents_
-from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler, UjsonHandler
+from meilisearch_python_sdk.json_handler import BuiltinHandler, OrjsonHandler
 from meilisearch_python_sdk.models.documents import DocumentsInfo
 from meilisearch_python_sdk.models.index import IndexStats
 from meilisearch_python_sdk.models.search import (
@@ -59,7 +59,7 @@ from meilisearch_python_sdk.plugins import (
 )
 from meilisearch_python_sdk.types import JsonDict
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     import sys
 
     from meilisearch_python_sdk.types import Filter, JsonMapping
@@ -84,10 +84,10 @@ class AsyncIndex(BaseIndex):
         created_at: str | datetime | None = None,
         updated_at: str | datetime | None = None,
         plugins: AsyncIndexPlugins | None = None,
-        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
+        json_handler: BuiltinHandler | OrjsonHandler | None = None,
         *,
-        hits_type: Any = JsonDict,
-    ):
+        hits_type: type[Any] = JsonDict,
+    ) -> None:
         """Class initializer.
 
         Args:
@@ -99,9 +99,9 @@ class AsyncIndex(BaseIndex):
             updated_at: The date and time the index was last updated. Defaults to None.
             plugins: Optional plugins can be provided to extend functionality.
             json_handler: The module to use for json operations. The options are BuiltinHandler
-                (uses the json module from the standard library), OrjsonHandler (uses orjson), or
-                UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
-                extra needs to be included. Default: BuiltinHandler.
+                (uses the json module from the standard library), or OrjsonHandler (uses orjson).
+                Note that in order use orjson the corresponding extra needs to be included.
+                Default: BuiltinHandler.
             hits_type: Allows for a custom type to be passed to use for hits. Defaults to
                 JsonDict
         """
@@ -581,8 +581,8 @@ class AsyncIndex(BaseIndex):
         wait: bool = True,
         timeout_in_ms: int | None = None,
         plugins: AsyncIndexPlugins | None = None,
-        json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler | None = None,
-        hits_type: Any = JsonDict,
+        json_handler: BuiltinHandler | OrjsonHandler | None = None,
+        hits_type: type[Any] = JsonDict,
     ) -> Self:
         """Creates a new index.
 
@@ -607,9 +607,9 @@ class AsyncIndex(BaseIndex):
                 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.
             json_handler: The module to use for json operations. The options are BuiltinHandler
-                (uses the json module from the standard library), OrjsonHandler (uses orjson), or
-                UjsonHandler (uses ujson). Note that in order use orjson or ujson the corresponding
-                extra needs to be included. Default: BuiltinHandler.
+                (uses the json module from the standard library), or OrjsonHandler (uses orjson).
+                Note that in order use orjson the corresponding extra needs to be included.
+                Default: BuiltinHandler.
             hits_type: Allows for a custom type to be passed to use for hits. Defaults to
                 JsonDict
 
@@ -4819,7 +4819,7 @@ class AsyncIndex(BaseIndex):
     async def _run_plugins(
         plugins: Sequence[AsyncPlugin | AsyncDocumentPlugin | AsyncPostSearchPlugin],
         event: AsyncEvent,
-        **kwargs: Any,
+        **kwargs: Any,  # noqa: ANN401
     ) -> dict[str, Any]:
         generic_plugins = []
         document_plugins = []
@@ -4888,7 +4888,7 @@ async def _async_load_documents_from_file(
     file_path: Path | str,
     csv_delimiter: str | None = None,
     *,
-    json_handler: BuiltinHandler | OrjsonHandler | UjsonHandler,
+    json_handler: BuiltinHandler | OrjsonHandler,
 ) -> list[dict[Any, Any]]:
     if isinstance(file_path, str):
         file_path = Path(file_path)