meilisearch-python-sdk 2.3.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

meilisearch_python_sdk/plugins.py

@@ -0,0 +1,122 @@
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any, NamedTuple, Protocol, Sequence
+
+from meilisearch_python_sdk.models.search import FacetSearchResults, SearchResults
+from meilisearch_python_sdk.models.task import TaskInfo
+from meilisearch_python_sdk.types import JsonDict, JsonMapping
+
+
+class AsyncEvent(Enum):
+    PRE = "pre"
+    CONCURRENT = "concurrent"
+    POST = "post"
+
+
+class Event(Enum):
+    PRE = "pre"
+    POST = "post"
+
+
+class AsyncPlugin(Protocol):
+    CONCURRENT_EVENT: bool
+    POST_EVENT: bool
+    PRE_EVENT: bool
+
+    async def run_plugin(
+        self, event: AsyncEvent, **kwargs: Any
+    ) -> (
+        None | list[JsonDict] | TaskInfo | list[TaskInfo] | SearchResults | FacetSearchResults
+    ):  # pragma: no cover
+        ...
+
+
+class AsyncDocumentPlugin(Protocol):
+    CONCURRENT_EVENT: bool
+    POST_EVENT: bool
+    PRE_EVENT: bool
+
+    async def run_document_plugin(
+        self,
+        event: AsyncEvent,
+        *,
+        documents: Sequence[JsonMapping],
+        primary_key: str | None,
+        **kwargs: Any,
+    ) -> Sequence[JsonMapping] | None:  # pragma: no cover
+        ...
+
+
+class AsyncPostSearchPlugin(Protocol):
+    CONCURRENT_EVENT: bool
+    POST_EVENT: bool
+    PRE_EVENT: bool
+
+    async def run_post_search_plugin(
+        self,
+        event: AsyncEvent,
+        *,
+        search_results: SearchResults,
+        **kwargs: Any,
+    ) -> SearchResults | None:  # pragma: no cover
+        ...
+
+
+class Plugin(Protocol):
+    POST_EVENT: bool
+    PRE_EVENT: bool
+
+    def run_plugin(
+        self, event: Event, **kwargs: Any
+    ) -> (
+        None | list[JsonDict] | TaskInfo | list[TaskInfo] | SearchResults | FacetSearchResults
+    ):  # pragma: no cover
+        ...
+
+
+class DocumentPlugin(Protocol):
+    POST_EVENT: bool
+    PRE_EVENT: bool
+
+    def run_document_plugin(
+        self,
+        event: Event,
+        *,
+        documents: Sequence[JsonMapping],
+        primary_key: str | None,
+        **kwargs: Any,
+    ) -> Sequence[JsonMapping] | None:  # pragma: no cover
+        ...
+
+
+class PostSearchPlugin(Protocol):
+    POST_EVENT: bool
+    PRE_EVENT: bool
+
+    def run_post_search_plugin(
+        self, event: Event, *, search_results: SearchResults, **kwargs: Any
+    ) -> SearchResults | None:  # pragma: no cover
+        ...
+
+
+class AsyncIndexPlugins(NamedTuple):
+    add_documents_plugins: Sequence[AsyncPlugin | AsyncDocumentPlugin] | None = None
+    delete_all_documents_plugins: Sequence[AsyncPlugin] | None = None
+    delete_document_plugins: Sequence[AsyncPlugin] | None = None
+    delete_documents_plugins: Sequence[AsyncPlugin] | None = None
+    delete_documents_by_filter_plugins: Sequence[AsyncPlugin] | None = None
+    facet_search_plugins: Sequence[AsyncPlugin] | None = None
+    search_plugins: Sequence[AsyncPlugin | AsyncPostSearchPlugin] | None = None
+    update_documents_plugins: Sequence[AsyncPlugin | AsyncDocumentPlugin] | None = None
+
+
+class IndexPlugins(NamedTuple):
+    add_documents_plugins: Sequence[Plugin | DocumentPlugin] | None = None
+    delete_all_documents_plugins: Sequence[Plugin] | None = None
+    delete_document_plugins: Sequence[Plugin] | None = None
+    delete_documents_plugins: Sequence[Plugin] | None = None
+    delete_documents_by_filter_plugins: Sequence[Plugin] | None = None
+    facet_search_plugins: Sequence[Plugin] | None = None
+    search_plugins: Sequence[Plugin | PostSearchPlugin] | None = None
+    update_documents_plugins: Sequence[Plugin | DocumentPlugin] | None = None

meilisearch_python_sdk/types.py

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

{meilisearch_python_sdk-2.3.0.dist-info → meilisearch_python_sdk-2.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: meilisearch-python-sdk
-Version: 2.3.0
+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.3.0.dist-info → meilisearch_python_sdk-2.4.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
 meilisearch_python_sdk/__init__.py,sha256=SB0Jlm6FwT13J9xasZKseZzTWBk0hkfe1CWyWmIIZnE,258
-meilisearch_python_sdk/_client.py,sha256=aFsf34LsHMuzTW5Nb84mpDwq_exN88i24hdRtAnx2gQ,64233
+meilisearch_python_sdk/_client.py,sha256=i93zSm5JEFkH91BSnSpXViLYYNCWT8vJHFpj8jRIf4U,65231
 meilisearch_python_sdk/_http_requests.py,sha256=vqxAXcNhzbupHcqUNuZQtsfERgIIK9Nq8Li6Cy2-8ow,4831
 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=ZGW6G5WJj1QfvFS-LneLnBG6X2v4VY6vrLHrJSg90tg,18
+meilisearch_python_sdk/_version.py,sha256=2JNrWTKhyWzxPhD68Ldhi_FHvK24GqvqcWxGeDeDs8U,18
 meilisearch_python_sdk/decorators.py,sha256=4NcMz73vJPiYII1ns5UJpFBqf_thPakypPNSTUD6ypE,8345
 meilisearch_python_sdk/errors.py,sha256=0sAKYt47-zFpKsEU6W8Qnvf4uHBynKtlGPpPl-5laSA,2085
-meilisearch_python_sdk/index.py,sha256=wEXB5Id7rMQgArQwDqKCc5VUEWzo6VffSB8iChRL53A,211166
+meilisearch_python_sdk/index.py,sha256=GDDH_5hOyuOXbSiT7p2TxLz8pDL9g-A0VqxBrOHfkGM,269673
 meilisearch_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 meilisearch_python_sdk/models/client.py,sha256=rJ02cSWnuBpdltFTdgXXwj4IVaoOtwMXnaSnSO8KFrY,5570
 meilisearch_python_sdk/models/documents.py,sha256=1X6y-gPRD1sB8V-2b-c-gOmQEs-yR8e7ZiY5TWwFNBs,236
@@ -16,9 +16,10 @@ meilisearch_python_sdk/models/search.py,sha256=Y3JgBiOGDvLiJs0_CH9m6ItGL4apL1hIS
 meilisearch_python_sdk/models/settings.py,sha256=su5lfloFIZKcdk0bEtXz6bitW6qIwMrjHAC6s0a8fBQ,2608
 meilisearch_python_sdk/models/task.py,sha256=5dHFx0G-yajBuX79gjDkDnK7MZrjCI2iKQyLf4J18aw,3697
 meilisearch_python_sdk/models/version.py,sha256=YDu-aj5H-d6nSaWRTXzlwWghmZAoiknaw250UyEd48I,215
+meilisearch_python_sdk/plugins.py,sha256=AiPGVj1bT6ZIrDXNxKbN6uoEGRX5xX8qiySMPVKsmDU,3515
 meilisearch_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-meilisearch_python_sdk/types.py,sha256=i5mqKGGP9kEajgrop1wKkdRbbsHra8FlqZgNsRI5ZWs,159
-meilisearch_python_sdk-2.3.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
-meilisearch_python_sdk-2.3.0.dist-info/METADATA,sha256=lboIIqCchZGyOG3MSPNnyxDdR-MonZL7W3OIPueezmg,8364
-meilisearch_python_sdk-2.3.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-meilisearch_python_sdk-2.3.0.dist-info/RECORD,,
+meilisearch_python_sdk/types.py,sha256=BoZcEdkazGKp3Hh6h5yMDtDBLYjOQjQW3SH0cO8k8kw,173
+meilisearch_python_sdk-2.4.0.dist-info/LICENSE,sha256=xVzevI1TrlKfM0plmJ7vfK1Muu0V9n-dGE8RnDrOFlM,1069
+meilisearch_python_sdk-2.4.0.dist-info/METADATA,sha256=5LCyCX0jkAU8KrAZlJbDFTn1zkSSnVg5O1kw8KB-co0,8364
+meilisearch_python_sdk-2.4.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+meilisearch_python_sdk-2.4.0.dist-info/RECORD,,