Migrate to Pydantic 2.0 standards (#195)

aiopurpleair/api.py

@@ -5,12 +5,12 @@
 
 from aiohttp import ClientSession, ClientTimeout
 from aiohttp.client_exceptions import ClientError
-from pydantic.v1 import BaseModel, ValidationError
+from pydantic import ValidationError
 
 from aiopurpleair.const import LOGGER
 from aiopurpleair.endpoints.sensors import SensorsEndpoints
 from aiopurpleair.errors import RequestError, raise_error
-from aiopurpleair.helpers.typing import ModelT
+from aiopurpleair.helpers.model import PurpleAirBaseModel, PurpleAirBaseModelT
 from aiopurpleair.models.keys import GetKeysResponse
 
 API_URL_BASE = "https://api.purpleair.com/v1"
@@ -52,9 +52,9 @@ async def async_request(
         self,
         method: str,
         endpoint: str,
-        response_model: type[BaseModel],
+        response_model: type[PurpleAirBaseModel],
         **kwargs: dict[str, Any],
-    ) -> ModelT:
+    ) -> PurpleAirBaseModelT:
         """Make an API request.
 
         Args:
@@ -100,7 +100,7 @@ async def async_request(
         LOGGER.debug("Data received for %s: %s", endpoint, data)
 
         try:
-            return cast(ModelT, response_model.parse_obj(data))
+            return cast(PurpleAirBaseModelT, response_model.model_validate(data))
         except ValidationError as err:
             raise RequestError(
                 f"Error while parsing response from {endpoint}: {err}"

aiopurpleair/endpoints/__init__.py

@@ -4,16 +4,18 @@
 from collections.abc import Awaitable, Callable, Iterable
 from typing import Any
 
-from pydantic.v1 import BaseModel, ValidationError
+from pydantic import ValidationError
 
 from aiopurpleair.errors import InvalidRequestError
-from aiopurpleair.helpers.typing import ModelT
+from aiopurpleair.helpers.model import PurpleAirBaseModel, PurpleAirBaseModelT
 
 
 class APIEndpointsBase:  # pylint: disable=too-few-public-methods
     """Define a base API endpoints manager."""
 
-    def __init__(self, async_request: Callable[..., Awaitable[ModelT]]) -> None:
+    def __init__(
+        self, async_request: Callable[..., Awaitable[PurpleAirBaseModelT]]
+    ) -> None:
         """Initialize.
 
         Args:
@@ -25,9 +27,9 @@ async def _async_endpoint_request_with_models(
         self,
         endpoint: str,
         query_param_map: Iterable[tuple[str, Any]],
-        request_model: type[BaseModel],
-        response_model: type[BaseModel],
-    ) -> ModelT:
+        request_model: type[PurpleAirBaseModel],
+        response_model: type[PurpleAirBaseModel],
+    ) -> PurpleAirBaseModelT:
         """Perform an API endpoint request.
 
         Args:
@@ -43,7 +45,7 @@ async def _async_endpoint_request_with_models(
             InvalidRequestError: Raised on invalid parameters.
         """
         try:
-            request = request_model.parse_obj(
+            request = request_model.model_validate(
                 {
                     api_query_param: func_param
                     for api_query_param, func_param in query_param_map
@@ -54,5 +56,8 @@ async def _async_endpoint_request_with_models(
             raise InvalidRequestError(err) from err
 
         return await self._async_request(
-            "get", endpoint, response_model, params=request.dict(exclude_none=True)
+            "get",
+            endpoint,
+            response_model,
+            params=request.model_dump(exclude_none=True),
         )

aiopurpleair/helpers/model.py

@@ -0,0 +1,13 @@
+"""Define model helpers."""
+from typing import TypeVar
+
+from pydantic import BaseModel, ConfigDict
+
+
+class PurpleAirBaseModel(BaseModel):
+    """Define a PurpleAir-specific base model."""
+
+    model_config = ConfigDict(frozen=True)
+
+
+PurpleAirBaseModelT = TypeVar("PurpleAirBaseModelT", bound=PurpleAirBaseModel)

aiopurpleair/models/keys.py

@@ -3,10 +3,11 @@
 
 from datetime import datetime
 
-from pydantic.v1 import BaseModel, validator
+from pydantic import Field, field_validator
 
 from aiopurpleair.backports.enum import StrEnum
-from aiopurpleair.helpers.validators import validate_timestamp
+from aiopurpleair.helpers.model import PurpleAirBaseModel
+from aiopurpleair.helpers.validator import validate_timestamp
 
 
 class ApiKeyType(StrEnum):
@@ -19,22 +20,14 @@ class ApiKeyType(StrEnum):
     WRITE_DISABLED = "WRITE_DISABLED"
 
 
-class GetKeysResponse(BaseModel):
+class GetKeysResponse(PurpleAirBaseModel):
     """Define a response to GET /v1/keys."""
 
     api_key_type: str
     api_version: str
-    timestamp_utc: datetime
+    timestamp_utc: datetime = Field(alias="time_stamp")
 
-    class Config:  # pylint: disable=too-few-public-methods
-        """Define configuration for this model."""
-
-        fields = {
-            "timestamp_utc": {"alias": "time_stamp"},
-        }
-        frozen = True
-
-    @validator("api_key_type")
+    @field_validator("api_key_type")
     @classmethod
     def validate_api_key_type(cls, value: str) -> ApiKeyType:
         """Validate the API key type.
@@ -53,6 +46,6 @@ def validate_api_key_type(cls, value: str) -> ApiKeyType:
         except ValueError as err:
             raise ValueError(f"{value} is an unknown API key type") from err
 
-    validate_utc_timestamp = validator("timestamp_utc", allow_reuse=True, pre=True)(
+    validate_utc_timestamp = field_validator("timestamp_utc", mode="before")(
         validate_timestamp
     )