Switch to Mashumaro

 * Pydantic 2 is tough to use with Home Assistant due to reliance on
   v1 in it's internal classes. It's trivial to switch to Mashumaro
   so let's just do that instead.

Author: hyperb1iss

pyproject.toml

@@ -9,12 +9,12 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.9"
 requests = "^2.32.3"
-pydantic = "^2.8.2"
 rich = "^13.7.1"
 typer = "^0.12.3"
 ruff = "^0.5.4"
 pre-commit = "^3.7.1"
 types-requests = "^2.32.0.20240712"
+mashumaro = "^3.13.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"
@@ -23,6 +23,7 @@ mkdocs-material = "^9.5.29"
 mkdocstrings = {extras = ["python"], version = "^0.25.1"}
 mypy = "^1.11.0"
 pytest-cov = "^5.0.0"
+types-setuptools = "^71.1.0.20240724"
 
 [tool.pytest.ini_options]
 addopts = "--cov=signalrgb --cov-report=term-missing"

signalrgb/client.py

@@ -1,5 +1,5 @@
 """
-C lient for interacting with the SignalRGB API.
+Client for interacting with the SignalRGB API.
 
 This module provides a client class for interacting with the SignalRGB API,
 allowing users to retrieve, apply, and manage lighting effects.
@@ -139,7 +139,7 @@ def _request(self, method: str, endpoint: str, **kwargs) -> dict:
         except requests.HTTPError as e:
             if e.response is not None:
                 error_data = e.response.json().get("errors", [{}])[0]
-                error = Error(**error_data)
+                error = Error.from_dict(error_data)
                 raise APIError(f"HTTP error occurred: {e}", error)
             raise APIError(f"HTTP error occurred: {e}", Error(title=str(e)))
         except RequestException as e:
@@ -161,9 +161,8 @@ def get_effects(self) -> List[Effect]:
             >>> print(f"Found {len(effects)} effects")
         """
         try:
-            response = EffectListResponse.model_validate(
-                self._request("GET", "/api/v1/lighting/effects")
-            )
+            response_data = self._request("GET", "/api/v1/lighting/effects")
+            response = EffectListResponse.from_dict(response_data)
             self._ensure_response_ok(response)
             effects = response.data
             if effects is None or effects.items is None:
@@ -195,9 +194,10 @@ def get_effect(self, effect_id: str) -> Effect:
             >>> print(f"Effect name: {effect.attributes.name}")
         """
         try:
-            response = EffectDetailsResponse.model_validate(
-                self._request("GET", f"/api/v1/lighting/effects/{effect_id}")
+            response_data = self._request(
+                "GET", f"/api/v1/lighting/effects/{effect_id}"
             )
+            response = EffectDetailsResponse.from_dict(response_data)
             self._ensure_response_ok(response)
             if response.data is None:
                 raise APIError("No effect data in the response")
@@ -260,9 +260,8 @@ def get_current_effect(self) -> Effect:
             >>> print(f"Current effect: {current_effect.attributes.name}")
         """
         try:
-            response = EffectDetailsResponse.model_validate(
-                self._request("GET", "/api/v1/lighting")
-            )
+            response_data = self._request("GET", "/api/v1/lighting")
+            response = EffectDetailsResponse.from_dict(response_data)
             self._ensure_response_ok(response)
             if response.data is None:
                 raise APIError("No current effect data in the response")
@@ -288,9 +287,8 @@ def apply_effect(self, effect_id: str) -> None:
             >>> print("Effect applied successfully")
         """
         try:
-            response = SignalRGBResponse.model_validate(
-                self._request("POST", f"/api/v1/effects/{effect_id}/apply")
-            )
+            response_data = self._request("POST", f"/api/v1/effects/{effect_id}/apply")
+            response = SignalRGBResponse.from_dict(response_data)
             self._ensure_response_ok(response)
         except APIError as e:
             if e.error and e.error.code == "not_found":

signalrgb/model.py

@@ -1,17 +1,19 @@
 """
 Data models for the SignalRGB API client.
 
-This module contains Pydantic models that represent various data structures
+This module contains Mashumaro-based models that represent various data structures
 used in the SignalRGB API, including effects, responses, and error information.
 These models are used to validate and structure the data received from and sent to the API.
 """
 
 from typing import Any, Dict, List, Optional
+from dataclasses import dataclass, field
+from mashumaro import DataClassDictMixin
+from mashumaro.config import BaseConfig
 
-from pydantic import BaseModel, Field
 
-
-class Attributes(BaseModel):
+@dataclass
+class Attributes(DataClassDictMixin):
     """
     Attributes of an effect in SignalRGB.
 
@@ -32,31 +34,20 @@ class Attributes(BaseModel):
         uses_video (bool): Indicates whether the effect uses video input.
     """
 
-    description: Optional[str] = Field(
-        default=None, description="Description of the effect"
-    )
-    developer_effect: bool = Field(
-        default=False, description="Whether this is a developer effect"
-    )
-    image: Optional[str] = Field(
-        default=None, description="URL or path to the effect image"
-    )
-    name: str = Field(..., description="Name of the effect")
-    parameters: Dict[str, Any] = Field(
-        default_factory=dict, description="Effect parameters"
-    )
-    publisher: Optional[str] = Field(
-        default=None, description="Publisher of the effect"
-    )
-    uses_audio: bool = Field(default=False, description="Whether the effect uses audio")
-    uses_input: bool = Field(default=False, description="Whether the effect uses input")
-    uses_meters: bool = Field(
-        default=False, description="Whether the effect uses meters"
-    )
-    uses_video: bool = Field(default=False, description="Whether the effect uses video")
-
-
-class Links(BaseModel):
+    name: str
+    description: Optional[str] = None
+    developer_effect: bool = False
+    image: Optional[str] = None
+    parameters: Dict[str, Any] = field(default_factory=dict)
+    publisher: Optional[str] = None
+    uses_audio: bool = False
+    uses_input: bool = False
+    uses_meters: bool = False
+    uses_video: bool = False
+
+
+@dataclass
+class Links(DataClassDictMixin):
     """
     Links associated with an effect in SignalRGB.
 
@@ -65,14 +56,18 @@ class Links(BaseModel):
 
     Attributes:
         apply (Optional[str]): URL to apply the effect, if available.
-        self (Optional[str]): URL of the effect itself, typically for retrieving its details.
+        self_link (Optional[str]): URL of the effect itself, typically for retrieving its details.
     """
 
-    apply: Optional[str] = Field(default=None, description="URL to apply the effect")
-    self: Optional[str] = Field(default=None, description="URL of the effect itself")
+    apply: Optional[str] = None
+    self_link: Optional[str] = None
+
+    class Config(BaseConfig):
+        aliases = {"self_link": "self"}
 
 
-class Effect(BaseModel):
+@dataclass
+class Effect(DataClassDictMixin):
     """
     Represents a single effect in SignalRGB.
 
@@ -86,13 +81,14 @@ class Effect(BaseModel):
         type (str): Type of the object, typically 'lighting'.
     """
 
-    attributes: Attributes = Field(..., description="Attributes of the effect")
-    id: str = Field(..., description="Unique identifier of the effect")
-    links: Links = Field(..., description="Links associated with the effect")
-    type: str = Field(..., description="Type of the object, typically 'lighting'")
+    attributes: Attributes
+    id: str
+    links: Links
+    type: str
 
 
-class EffectList(BaseModel):
+@dataclass
+class EffectList(DataClassDictMixin):
     """
     A list of effects in SignalRGB.
 
@@ -103,10 +99,11 @@ class EffectList(BaseModel):
         items (List[Effect]): A list of Effect objects.
     """
 
-    items: List[Effect] = Field(default_factory=list, description="List of effects")
+    items: List[Effect] = field(default_factory=list)
 
 
-class Error(BaseModel):
+@dataclass
+class Error(DataClassDictMixin):
     """
     Represents an error returned by the SignalRGB API.
 
@@ -119,12 +116,13 @@ class Error(BaseModel):
         title (str): A brief title or summary of the error.
     """
 
-    code: Optional[str] = Field(default=None, description="Error code")
-    detail: Optional[str] = Field(default=None, description="Detailed error message")
-    title: str = Field(..., description="Error title")
+    title: str
+    code: Optional[str] = None
+    detail: Optional[str] = None
 
 
-class SignalRGBResponse(BaseModel):
+@dataclass
+class SignalRGBResponse(DataClassDictMixin):
     """
     Base class for responses from the SignalRGB API.
 
@@ -141,18 +139,15 @@ class SignalRGBResponse(BaseModel):
         errors (List[Error]): A list of Error objects if any errors occurred.
     """
 
-    api_version: str = Field(..., description="API version")
-    id: int = Field(..., description="Response ID")
-    method: str = Field(..., description="HTTP method used")
-    params: Dict[str, Any] = Field(
-        default_factory=dict, description="Request parameters"
-    )
-    status: str = Field(..., description="Response status")
-    errors: List[Error] = Field(
-        default_factory=list, description="List of errors if any"
-    )
+    api_version: str
+    id: int
+    method: str
+    status: str
+    params: Dict[str, Any] = field(default_factory=dict)
+    errors: List[Error] = field(default_factory=list)
 
 
+@dataclass
 class EffectDetailsResponse(SignalRGBResponse):
     """
     Response model for requests that return details of a single effect.
@@ -164,9 +159,10 @@ class EffectDetailsResponse(SignalRGBResponse):
         data (Optional[Effect]): The details of the requested effect, if available.
     """
 
-    data: Optional[Effect] = Field(default=None, description="Effect details")
+    data: Optional[Effect] = None
 
 
+@dataclass
 class EffectListResponse(SignalRGBResponse):
     """
     Response model for requests that return a list of effects.
@@ -178,4 +174,4 @@ class EffectListResponse(SignalRGBResponse):
         data (Optional[EffectList]): The list of effects returned by the API, if available.
     """
 
-    data: Optional[EffectList] = Field(default=None, description="List of effects")
+    data: Optional[EffectList] = None

tests/test_model.py

@@ -21,7 +21,7 @@ def load_json_data(self, filename: str) -> Dict[str, Any]:
 
     def test_effect_deserialization(self):
         data = self.load_json_data("effect.json")
-        response = EffectDetailsResponse.model_validate(data)
+        response = EffectDetailsResponse.from_dict(data)
         self.assertEqual(response.status, "ok")
         self.assertIsInstance(response.data, Effect)
 
@@ -41,15 +41,15 @@ def test_effect_deserialization(self):
 
         # Test Links
         self.assertIsInstance(effect.links.apply, str)
-        self.assertIsInstance(effect.links.self, str)
+        self.assertIsInstance(effect.links.self_link, str)
 
         # Test single effect
         self.assertIsInstance(effect.id, str)
         self.assertIsInstance(effect.type, str)
 
     def test_effect_list_deserialization(self):
         data = self.load_json_data("effect_list.json")
-        response = EffectListResponse.model_validate(data)
+        response = EffectListResponse.from_dict(data)
         self.assertEqual(response.status, "ok")
         self.assertIsInstance(response.data, EffectList)
 
@@ -64,7 +64,7 @@ def test_effect_list_deserialization(self):
 
     def test_effect_error_deserialization(self):
         data = self.load_json_data("error.json")
-        response = EffectDetailsResponse.model_validate(data)
+        response = EffectDetailsResponse.from_dict(data)
         self.assertEqual(response.status, "error")
         self.assertIsInstance(response.errors, list)
         self.assertGreater(len(response.errors), 0)
@@ -88,7 +88,7 @@ def test_attributes_model(self):
             "uses_meters": True,
             "uses_video": False,
         }
-        attrs = Attributes.model_validate(attrs_data)
+        attrs = Attributes.from_dict(attrs_data)
         for field, value in attrs_data.items():
             self.assertEqual(getattr(attrs, field), value)
 
@@ -97,9 +97,9 @@ def test_links_model(self):
             "apply": "http://api.example.com/apply",
             "self": "http://api.example.com/effect/1",
         }
-        links = Links.model_validate(links_data)
+        links = Links.from_dict(links_data)
         self.assertEqual(links.apply, links_data["apply"])
-        self.assertEqual(links.self, links_data["self"])
+        self.assertEqual(links.self_link, links_data["self"])
 
     def test_signal_rgb_response(self):
         response_data = {
@@ -110,7 +110,7 @@ def test_signal_rgb_response(self):
             "status": "ok",
             "errors": [],
         }
-        response = SignalRGBResponse.model_validate(response_data)
+        response = SignalRGBResponse.from_dict(response_data)
         self.assertEqual(response.api_version, "1.0")
         self.assertEqual(response.id, 12345)
         self.assertEqual(response.method, "GET")
@@ -124,7 +124,7 @@ def test_error_model(self):
             "title": "Internal Server Error",
             "detail": "An unexpected error occurred",
         }
-        error = Error.model_validate(error_data)
+        error = Error.from_dict(error_data)
         self.assertEqual(error.code, "500")
         self.assertEqual(error.title, "Internal Server Error")
         self.assertEqual(error.detail, "An unexpected error occurred")