Add depreciation warning for Pydantic < 2

Author: sanders41

meilisearch_python_sdk/_client.py

@@ -4,6 +4,7 @@
 from datetime import datetime, timezone
 from ssl import SSLContext
 from types import TracebackType
+from warnings import warn
 
 import jwt
 from httpx import AsyncClient as HttpxAsyncClient
@@ -441,6 +442,10 @@ async def create_key(self, key: KeyCreate) -> Key:
                 "keys", json.loads(key.model_dump_json(by_alias=True))
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = await self._http_requests.post("keys", json.loads(key.json(by_alias=True)))  # type: ignore[attr-defined]
 
         return Key(**response.json())
@@ -592,6 +597,10 @@ async def multi_search(self, queries: list[SearchParams]) -> list[SearchResultsW
                 body={"queries": [x.model_dump(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
             )
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = await self._http_requests.post(
                 url,
                 body={"queries": [x.dict(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
@@ -1267,6 +1276,10 @@ def create_key(self, key: KeyCreate) -> Key:
                 "keys", json.loads(key.model_dump_json(by_alias=True))
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = self._http_requests.post("keys", json.loads(key.json(by_alias=True)))  # type: ignore[attr-defined]
 
         return Key(**response.json())
@@ -1418,6 +1431,10 @@ def multi_search(self, queries: list[SearchParams]) -> list[SearchResultsWithUID
                 body={"queries": [x.model_dump(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
             )
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = self._http_requests.post(
                 url,
                 body={"queries": [x.dict(by_alias=True) for x in queries]},  # type: ignore[attr-defined]
@@ -1807,6 +1824,10 @@ def _build_update_key_payload(key: KeyUpdate) -> JsonDict:
             if v is not None and k != "key"
         }
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
         return {  # type: ignore[attr-defined]
             k: v
             for k, v in json.loads(key.json(by_alias=True)).items()

meilisearch_python_sdk/index.py

@@ -8,6 +8,7 @@
 from pathlib import Path
 from typing import Any, Generator
 from urllib.parse import urlencode
+from warnings import warn
 
 import aiofiles
 from httpx import AsyncClient, Client
@@ -1728,6 +1729,10 @@ async def update_settings(self, body: MeilisearchSettings) -> TaskInfo:
         if is_pydantic_2():
             body_dict = {k: v for k, v in body.model_dump(by_alias=True).items() if v is not None}  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             body_dict = {k: v for k, v in body.dict(by_alias=True).items() if v is not None}  # type: ignore[attr-defined]
 
         response = await self._http_requests.patch(self._settings_url, body_dict)
@@ -2428,6 +2433,10 @@ async def update_typo_tolerance(self, typo_tolerance: TypoTolerance) -> TaskInfo
                 f"{self._settings_url}/typo-tolerance", typo_tolerance.model_dump(by_alias=True)
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = await self._http_requests.patch(
                 f"{self._settings_url}/typo-tolerance", typo_tolerance.dict(by_alias=True)
             )  # type: ignore[attr-defined]
@@ -2508,6 +2517,10 @@ async def update_faceting(self, faceting: Faceting) -> TaskInfo:
                 f"{self._settings_url}/faceting", faceting.model_dump(by_alias=True)
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = await self._http_requests.patch(
                 f"{self._settings_url}/faceting", faceting.dict(by_alias=True)
             )  # type: ignore[attr-defined]
@@ -2589,6 +2602,10 @@ async def update_pagination(self, settings: Pagination) -> TaskInfo:
                 f"{self._settings_url}/pagination", settings.model_dump(by_alias=True)
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = await self._http_requests.patch(
                 f"{self._settings_url}/pagination", settings.dict(by_alias=True)
             )  # type: ignore[attr-defined]
@@ -4367,6 +4384,10 @@ def update_settings(self, body: MeilisearchSettings) -> TaskInfo:
         if is_pydantic_2():
             body_dict = {k: v for k, v in body.model_dump(by_alias=True).items() if v is not None}  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             body_dict = {k: v for k, v in body.dict(by_alias=True).items() if v is not None}  # type: ignore[attr-defined]
 
         response = self._http_requests.patch(self._settings_url, body_dict)
@@ -5061,6 +5082,10 @@ def update_typo_tolerance(self, typo_tolerance: TypoTolerance) -> TaskInfo:
                 f"{self._settings_url}/typo-tolerance", typo_tolerance.model_dump(by_alias=True)
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = self._http_requests.patch(
                 f"{self._settings_url}/typo-tolerance", typo_tolerance.dict(by_alias=True)
             )  # type: ignore[attr-defined]
@@ -5141,6 +5166,10 @@ def update_faceting(self, faceting: Faceting) -> TaskInfo:
                 f"{self._settings_url}/faceting", faceting.model_dump(by_alias=True)
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = self._http_requests.patch(
                 f"{self._settings_url}/faceting", faceting.dict(by_alias=True)
             )  # type: ignore[attr-defined]
@@ -5222,6 +5251,10 @@ def update_pagination(self, settings: Pagination) -> TaskInfo:
                 f"{self._settings_url}/pagination", settings.model_dump(by_alias=True)
             )  # type: ignore[attr-defined]
         else:  # pragma: no cover
+            warn(
+                "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+                DeprecationWarning,
+            )
             response = self._http_requests.patch(
                 f"{self._settings_url}/pagination", settings.dict(by_alias=True)
             )  # type: ignore[attr-defined]

meilisearch_python_sdk/models/client.py

@@ -1,5 +1,6 @@
 from datetime import datetime
 from typing import Dict, List, Optional, Union
+from warnings import warn
 
 import pydantic
 from camel_converter.pydantic_base import CamelBase
@@ -21,6 +22,10 @@ def validate_last_update(cls, v: str) -> Union[datetime, None]:
             return iso_to_date_time(v)
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("last_update", pre=True)
         @classmethod
@@ -45,6 +50,10 @@ def validate_expires_at(cls, v: str) -> Union[datetime, None]:
             return iso_to_date_time(v)
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("expires_at", pre=True)
         @classmethod
@@ -86,6 +95,10 @@ def validate_updated_at(cls, v: str) -> Union[datetime, None]:
             return iso_to_date_time(v)
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("created_at", pre=True)
         @classmethod
@@ -114,6 +127,10 @@ class KeyCreate(CamelBase):
         model_config = pydantic.ConfigDict(ser_json_timedelta="iso8601")  # type: ignore[typeddict-unknown-key]
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         class Config:
             json_encoders = {
@@ -139,6 +156,10 @@ class KeyUpdate(CamelBase):
         model_config = pydantic.ConfigDict(ser_json_timedelta="iso8601")  # type: ignore[typeddict-unknown-key]
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         class Config:
             json_encoders = {

meilisearch_python_sdk/models/index.py

@@ -1,5 +1,6 @@
 from datetime import datetime
 from typing import Dict, Optional
+from warnings import warn
 
 import pydantic
 from camel_converter.pydantic_base import CamelBase
@@ -39,6 +40,10 @@ def validate_updated_at(cls, v: str) -> datetime:
             return converted
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("created_at", pre=True)
         @classmethod

meilisearch_python_sdk/models/settings.py

@@ -1,4 +1,5 @@
 from typing import Dict, List, Optional
+from warnings import warn
 
 import pydantic
 from camel_converter.pydantic_base import CamelBase
@@ -38,6 +39,10 @@ def validate_facet_order(cls, v: Optional[Dict[str, str]]) -> Optional[Dict[str,
             return v
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("sort_facet_values_by")  # type: ignore[attr-defined]
         @classmethod

meilisearch_python_sdk/models/task.py

@@ -1,5 +1,6 @@
 from datetime import datetime
 from typing import List, Optional, Union
+from warnings import warn
 
 import pydantic
 from camel_converter.pydantic_base import CamelBase
@@ -48,6 +49,10 @@ def validate_finished_at(cls, v: str) -> Union[datetime, None]:
             return iso_to_date_time(v)
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("enqueued_at", pre=True)
         @classmethod
@@ -98,6 +103,10 @@ def validate_enqueued_at(cls, v: str) -> datetime:
             return converted
 
     else:  # pragma: no cover
+        warn(
+            "The use of Pydantic less than version 2 is depreciated and will be removed in a future release",
+            DeprecationWarning,
+        )
 
         @pydantic.validator("enqueued_at", pre=True)
         @classmethod