Set a custom named color

[michaelfromyeg]

Hi all,

Working on this PR and was wondering how (or if) I can extend the base Color class to add named colors?

In our code, certain shades have developer-friendly (but not CSS-defined) names, e.g., correct_green, incorrect_red and it would be nice to be able to do CustomColor(name).to_string(hex=True) where name is either a CSS color or one of our custom ones. The current workaround is,

def get_css_color(name: str) -> Optional[str]:
    """
    Tries to look up a hex code value from a named css color, otherwise will
    return None if not a valid color.
    """
    name = name.lower()
    if name in pl_colors:
        return pl_colors[name]

    if Color.match(name) is None:
        warnings.warn(f"{name} is not a valid color name; defaulting to no color")
        return None

    return Color(name).to_string(hex=True)

Any insight is appreciated.

[facelessuser]

I imagine you are working within sRGB, so I'd create a custom sRGB color space class. Probably good to use the CSS variant so you can fall back to all the CSS serialization.

Check out this working example here. Just press edit to see/copy all the code.

You can omit the to_string serialization override if you have no need to serialize to those custom names.

[michaelfromyeg]

Thanks so much; this is fantastic. Really appreciate the detailed discussion on the issue as well.

Have a great week-end :)