[color] Fix crash when hex color parses as int, improve error reporting. (#6707)

This commit is contained in:
Clyde Stubbs 2024-05-09 13:14:31 +10:00 committed by Jesse Hills
parent 26048d18ef
commit 819bb9f8bc
No known key found for this signature in database
GPG Key ID: BEAAE804EFD8E83A
2 changed files with 40 additions and 9 deletions

View File

@ -14,15 +14,41 @@ CONF_HEX = "hex"
def hex_color(value): def hex_color(value):
if isinstance(value, int):
value = str(value)
if not isinstance(value, str):
raise cv.Invalid("Invalid value for hex color")
if len(value) != 6: if len(value) != 6:
raise cv.Invalid("Color must have six digits") raise cv.Invalid("Hex color must have six digits")
try: try:
return (int(value[0:2], 16), int(value[2:4], 16), int(value[4:6], 16)) return int(value[0:2], 16), int(value[2:4], 16), int(value[4:6], 16)
except ValueError as exc: except ValueError as exc:
raise cv.Invalid("Color must be hexadecimal") from exc raise cv.Invalid("Color must be hexadecimal") from exc
CONFIG_SCHEMA = cv.Any( components = {
CONF_RED,
CONF_RED_INT,
CONF_GREEN,
CONF_GREEN_INT,
CONF_BLUE,
CONF_BLUE_INT,
CONF_WHITE,
CONF_WHITE_INT,
}
def validate_color(config):
has_components = set(config) & components
has_hex = CONF_HEX in config
if has_hex and has_components:
raise cv.Invalid("Hex color value may not be combined with component values")
if not has_hex and not has_components:
raise cv.Invalid("Must provide at least one color option")
return config
CONFIG_SCHEMA = cv.All(
cv.Schema( cv.Schema(
{ {
cv.Required(CONF_ID): cv.declare_id(ColorStruct), cv.Required(CONF_ID): cv.declare_id(ColorStruct),
@ -34,14 +60,10 @@ CONFIG_SCHEMA = cv.Any(
cv.Exclusive(CONF_BLUE_INT, "blue"): cv.uint8_t, cv.Exclusive(CONF_BLUE_INT, "blue"): cv.uint8_t,
cv.Exclusive(CONF_WHITE, "white"): cv.percentage, cv.Exclusive(CONF_WHITE, "white"): cv.percentage,
cv.Exclusive(CONF_WHITE_INT, "white"): cv.uint8_t, cv.Exclusive(CONF_WHITE_INT, "white"): cv.uint8_t,
cv.Optional(CONF_HEX): hex_color,
} }
).extend(cv.COMPONENT_SCHEMA), ).extend(cv.COMPONENT_SCHEMA),
cv.Schema( validate_color,
{
cv.Required(CONF_ID): cv.declare_id(ColorStruct),
cv.Required(CONF_HEX): hex_color,
}
).extend(cv.COMPONENT_SCHEMA),
) )

View File

@ -9,3 +9,12 @@ color:
blue: 100% blue: 100%
- id: kbx_green - id: kbx_green
hex: "3DEC55" hex: "3DEC55"
- id: kbx_green_1
hex: 3DEC55
- id: cps_red
hex: 800000
- id: cps_green
hex: 008000
- id: cps_blue
hex: 000080