feat: enhance ColorV1 with from_list and from_hex methods; update color field validation in models

Author: raimannma

deadlock_assets_api/models/v1/colors.py

@@ -1,3 +1,5 @@
+from typing import Self
+
 from pydantic import BaseModel, ConfigDict, Field
 
 
@@ -8,3 +10,31 @@ class ColorV1(BaseModel):
     green: int = Field(..., description="The green value of the color.", ge=0, le=255)
     blue: int = Field(..., description="The blue value of the color.", ge=0, le=255)
     alpha: int = Field(..., description="The alpha value of the color.", ge=0, le=255)
+
+    @classmethod
+    def from_list(cls, color: list[int]) -> Self:
+        if len(color) == 3:
+            r, g, b = color
+            a = 255
+        elif len(color) == 4:
+            r, g, b, a = color
+        else:
+            raise ValueError("Color must be a tuple or list of 3 or 4 integers.")
+        return cls(red=r, green=g, blue=b, alpha=a)
+
+    @classmethod
+    def from_hex(cls, hex_str: str) -> Self:
+        hex_str = hex_str.lstrip("#")
+        if len(hex_str) == 6:
+            r = int(hex_str[0:2], 16)
+            g = int(hex_str[2:4], 16)
+            b = int(hex_str[4:6], 16)
+            a = 255
+        elif len(hex_str) == 8:
+            r = int(hex_str[0:2], 16)
+            g = int(hex_str[2:4], 16)
+            b = int(hex_str[4:6], 16)
+            a = int(hex_str[6:8], 16)
+        else:
+            raise ValueError("Hex string must be in the format RRGGBB or RRGGBBAA.")
+        return cls(red=r, green=g, blue=b, alpha=a)

deadlock_assets_api/models/v1/generic_data.py

@@ -1,7 +1,9 @@
 import os
 from functools import lru_cache
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+from deadlock_assets_api.models.v1.colors import ColorV1
 
 
 class FlashDataV1(BaseModel):
@@ -11,11 +13,22 @@ class FlashDataV1(BaseModel):
     coverage: float = Field(..., validation_alias="m_flCoverage")
     hardness: float = Field(..., validation_alias="m_flHardness")
     brightness: float = Field(..., validation_alias="m_flBrightness")
-    color: list[int] = Field(..., validation_alias="m_Color")
+    color: ColorV1 = Field(..., validation_alias="m_Color")
     brightness_in_light_sensitivity_mode: float | None = Field(
         None, validation_alias="m_flBrightnessInLightSensitivityMode"
     )
 
+    @field_validator("color", mode="before")
+    @classmethod
+    def validate_colors(cls, v: ColorV1 | list[int] | dict[str, int]) -> ColorV1:
+        if isinstance(v, ColorV1):
+            return v
+        if isinstance(v, dict):
+            return ColorV1.model_validate(v)
+        if isinstance(v, list):
+            return ColorV1.from_list(v)
+        raise TypeError(f"Invalid type for color field: {type(v)}")
+
 
 class DamageFlashV1(BaseModel):
     model_config = ConfigDict(populate_by_name=True)

deadlock_assets_api/models/v1/map.py

@@ -11,6 +11,7 @@
     LANES,
     MAP_RADIUS,
 )
+from deadlock_assets_api.models.v1.colors import ColorV1
 
 TOWER_IDS = {
     **{f"#Team{team_id + 1}Core": f"team{team_id}_core" for team_id in range(2)},
@@ -116,6 +117,11 @@ def from_pathnodes(cls, pathnodes: list[list[float]], **kwargs) -> ZiplanePathV1
             **kwargs,
         )
 
+    @computed_field
+    @property
+    def color_parsed(self) -> ColorV1:
+        return ColorV1.from_hex(self.color)
+
 
 class MapV1(BaseModel):
     model_config = ConfigDict(populate_by_name=True)

deadlock_assets_api/models/v2/npc_unit.py

@@ -130,27 +130,7 @@ def validate_colors(cls, v: ColorV1 | list[int] | None | dict[str, int]) -> Colo
         if isinstance(v, ColorV1):
             return v
         if isinstance(v, dict):
-            try:
-                return ColorV1.model_validate(v)
-            except ValueError as e:
-                LOGGER.error(f"Error parsing color {v}: {e}")
-                raise
+            return ColorV1.model_validate(v)
         if isinstance(v, list):
-            try:
-                color = parse_color(v)
-                return color
-            except ValueError as e:
-                LOGGER.error(f"Error parsing color {v}: {e}")
-                raise
+            return ColorV1.from_list(v)
         raise TypeError(f"Invalid type for color field: {type(v)}")
-
-
-def parse_color(color: list[int]) -> ColorV1:
-    if len(color) == 3:
-        r, g, b = color
-        a = 255
-    elif len(color) == 4:
-        r, g, b, a = color
-    else:
-        raise ValueError("Color must be a tuple or list of 3 or 4 integers.")
-    return ColorV1(red=r, green=g, blue=b, alpha=a)

res/builds/5972/v2/generic_data.json

@@ -3,59 +3,64 @@
     "bullet_damage": {
       "brightness": 1.2,
       "brightness_in_light_sensitivity_mode": null,
-      "color": [
-        255,
-        0,
-        0
-      ],
+      "color": {
+        "alpha": 255,
+        "blue": 0,
+        "green": 0,
+        "red": 255
+      },
       "coverage": 0.5,
       "duration": 0.25,
       "hardness": 0.7
     },
     "crit_damage": {
       "brightness": 1.7,
       "brightness_in_light_sensitivity_mode": null,
-      "color": [
-        255,
-        255,
-        0
-      ],
+      "color": {
+        "alpha": 255,
+        "blue": 0,
+        "green": 255,
+        "red": 255
+      },
       "coverage": 0.6,
       "duration": 0.33,
       "hardness": 0.9
     },
     "healing_damage": {
       "brightness": 1.2,
       "brightness_in_light_sensitivity_mode": 0.6,
-      "color": [
-        0,
-        195,
-        45
-      ],
+      "color": {
+        "alpha": 255,
+        "blue": 45,
+        "green": 195,
+        "red": 0
+      },
       "coverage": 0.5,
       "duration": 1.0,
       "hardness": 0.0
     },
     "melee_damage": {
       "brightness": 3.0,
       "brightness_in_light_sensitivity_mode": null,
-      "color": [
-        254,
-        101,
-        40
-      ],
+      "color": {
+        "alpha": 255,
+        "blue": 40,
+        "green": 101,
+        "red": 254
+      },
       "coverage": 0.5,
       "duration": 0.275,
       "hardness": 0.0
     },
     "tech_damage": {
       "brightness": 1.5,
       "brightness_in_light_sensitivity_mode": null,
-      "color": [
-        35,
-        17,
-        236
-      ],
+      "color": {
+        "alpha": 255,
+        "blue": 236,
+        "green": 17,
+        "red": 35
+      },
       "coverage": 0.5,
       "duration": 0.25,
       "hardness": 0.5