Migrate fully to pydantic 2 (#268)

* Add Raises to validate docstring
* Update requirements

Author: steinmn

README.md

@@ -26,9 +26,10 @@ Confirmed to work with Zaptec products
 * Zaptec Home
 * Zaptec PRO
 
-To use this component, a user with access to
-[Zaptec Portal](https://portal.zaptec.com/) is required.
+# Requirements
 
+* Home Assistant 2025.7 or newer.
+* A user with access to [Zaptec Portal](https://portal.zaptec.com/).
 
 # ⭐ Version 0.8.*
 

custom_components/zaptec/manifest.json

@@ -13,7 +13,7 @@
   "issue_tracker": "https://github.com/custom-components/zaptec/issues",
   "requirements": [
     "azure-servicebus==7.14.2",
-    "pydantic==2.11.7",
+    "pydantic>=2.11.7,<2.12",
     "aiolimiter==1.2.1"
   ],
   "version": "0.8.2"

custom_components/zaptec/validate.py

@@ -4,98 +4,121 @@
 
 import logging
 import re
+from typing import Any
 
-try:
-    from pydantic.v1 import BaseModel, ConfigDict, ValidationError
-except ImportError:
-    from pydantic import BaseModel, ConfigDict, ValidationError
+from pydantic import BaseModel, ConfigDict, TypeAdapter, ValidationError
 
 _LOGGER = logging.getLogger(__name__)
 
 
-class TypeWrapper:
-    """Workaround class for v1 pydantic."""
-
-
 class Installation(BaseModel):
+    """Pydantic model for a Zaptec installation."""
+
     model_config = ConfigDict(extra="allow")
     Id: str
+    Active: bool
+    AuthenticationType: int
+    CurrentUserRoles: int
+    InstallationType: int
+    NetworkType: int
 
 
 class Installations(BaseModel):
+    """Pydantic model for a list of Zaptec installations."""
+
     model_config = ConfigDict(extra="allow")
     Data: list[Installation]
+    Pages: int
 
 
 class Charger(BaseModel):
+    """Pydantic model for a Zaptec charger."""
+
     model_config = ConfigDict(extra="allow")
     Id: str
     Name: str
+    Active: bool
+    DeviceType: int
 
 
 class ChargerState(BaseModel):
+    """Pydantic model for a single state of a Zaptec charger."""
+
     model_config = ConfigDict(extra="allow")
     StateId: int
     ValueAsString: str
 
 
-# pydantic v2
-# ChargerStates = TypeAdapter[list[ChargerState]]
-class ChargerStates(TypeWrapper, BaseModel):
-    _data: list[ChargerState]
-
-
-class ChargerUpdate(TypeWrapper, BaseModel):
-    _data: dict[str, str]
+ChargerStates = TypeAdapter[list[ChargerState]]
+ChargerUpdate = TypeAdapter[dict[str, str]]
 
 
 class Chargers(BaseModel):
+    """Pydantic model for a list of Zaptec chargers."""
+
     model_config = ConfigDict(extra="allow")
     Data: list[Charger]
+    Pages: int
 
 
 class Circuit(BaseModel):
+    """Pydantic model for a Zaptec circuit."""
+
     model_config = ConfigDict(extra="allow")
     Id: str
     Name: str
     Chargers: list[Charger]
 
 
 class Hierarchy(BaseModel):
+    """Pydantic model for the hierarchy of Zaptec objects in an installation."""
+
     model_config = ConfigDict(extra="allow")
     Id: str
     Name: str
+    NetworkType: int
     Circuits: list[Circuit]
 
 
 class ChargerFirmware(BaseModel):
+    """Pydantic model for the firmware information of a Zaptec charger."""
+
     model_config = ConfigDict(extra="allow")
     ChargerId: str
+    DeviceType: int
+    IsOnline: bool
     CurrentVersion: str
     AvailableVersion: str
     IsUpToDate: bool
 
 
 class ChargerLocalSettings(BaseModel):
+    """
+    Pydantic model for the local settings of a Zaptec charger.
+
+    Note: This model is used in an undocumented API-call, and should be removed as soon as we have
+    official API-calls that can cover the necessary functionality
+    """
+
     model_config = ConfigDict(extra="allow")
     Id: str
-    # Name: str
-    # DeviceId: str
+    Name: str | None = None
+    DeviceId: str | None = None
 
 
-# pydantic v2
-# ChargerFirmwares = TypeAdapter[list[ChargerFirmware]]
-class ChargerFirmwares(TypeWrapper, BaseModel):
-    _data: list[ChargerFirmware]
+ChargerFirmwares = TypeAdapter[list[ChargerFirmware]]
 
 
 class InstallationConnectionDetails(BaseModel):
+    """Pydantic model for the servicebus connection details of a Zaptec installation."""
+
     model_config = ConfigDict(extra="allow")
     Host: str
     Password: str
-    # Port: int
+    Port: int
+    UseSSL: bool
     Subscription: str
-    # Type: int
+    Type: int
     Username: str
     Topic: str
 
@@ -121,29 +144,24 @@ class InstallationConnectionDetails(BaseModel):
 _URLS = [(k, re.compile(k), v) for k, v in URLS.items()]
 
 
-def validate(data, url):
-    """Validate the data."""
+def validate(data: Any, url: str) -> None:
+    """
+    Validate the data.
+
+    Raises:
+        ValidationError: If data doesn't match the pydantic model associated with the url.
+
+    """
 
     for pat, re_pat, model in _URLS:
         # Mathes either the exact string or its regexp
         if url == pat or re_pat.fullmatch(url):
             try:
-                d = data
-
-                # pydantic v1
-                if isinstance(model, TypeWrapper):
-                    d = {"_data": data}
-
                 if isinstance(model, BaseModel):
-                    # pydantic v1
-                    model.parse_obj(d)
-
-                    # pydantic v2
-                    # model.model_validate(data, strict=True)
+                    model.model_validate(data, strict=True)
 
-                # pydantic v2
-                # elif isinstance(model, TypeAdapter):
-                #     model.validate_python(data, strict=True)
+                elif isinstance(model, TypeAdapter):
+                    model.validate_python(data, strict=True)
 
             except ValidationError as err:
                 _LOGGER.error("Failed to validate %s (pattern %s): %s", url, pat, err)

hacs.json

@@ -1,5 +1,5 @@
 {
     "name": "Zaptec EV charger",
-    "homeassistant": "2025.2.4",
+    "homeassistant": "2025.7.0",
     "hacs": "2.0.5"
 }

requirements.txt

@@ -1,7 +1,7 @@
 colorlog==6.9.0
-homeassistant==2025.7.3
+homeassistant==2025.8.3
 pip>=25.0
-ruff==0.12.4
+ruff==0.12.10
 
 # Copy from manifest.json to get this into the dev container
 # without needing to start HA