restore color module removed in #11

ovos_utils/colors.py

@@ -1,125 +1,258 @@
-from colorsys import rgb_to_yiq, yiq_to_rgb, rgb_to_hls, hls_to_rgb, \
-    rgb_to_hsv, hsv_to_rgb
-from webcolors import name_to_rgb, rgb_to_hex, rgb_to_name, \
-    hex_to_name, hex_to_rgb
+from colorsys import rgb_to_yiq, rgb_to_hls, yiq_to_rgb, hls_to_rgb, rgb_to_hsv, hsv_to_rgb
+from colour import Color as _Color
+from ovos_utils import camel_case_split
 
-# TODO - lang support, we should translate names https://github.com/ubernostrum/webcolors/blob/trunk/src/webcolors/constants.py
-# does this belong in LF ?
 
+class UnrecognizedColorName(ValueError):
+    """ No color defined with this name """
 
-def name_to_hsv(name):
-    name = name.replace(" ", "")  # see link above, requires exact matches
-    r, g, b = name_to_rgb(name)
-    return rgb_to_hsv(r, g, b)
 
+class Color(_Color):
+    """ A well defined Color, just the way computers love colors"""
+    @property
+    def name(self):
+        if self.web != self.hex:
+            return camel_case_split(self.web).lower()
+        return None
+
+    @staticmethod
+    def from_name(name):
+        try:
+            name = name.lower().replace(" ", "").strip()
+            return Color(name)
+        except:
+            # try to parse color description
+            color = ColorOutOfSpace()
 
-def hsv_to_name(h, s, v):
-    rgb = hsv_to_rgb(h, s, v)
-    return rgb_to_name(rgb)
+            if "bright" in name:
+                color.set_luminance(0.7)
+            if "dark" in name:
+                color.set_luminance(0.3)
 
+            if "light" in name:
+                color.set_saturation(0.4)
+            if "grey" in name or "gray" in name:
+                color.set_saturation(0.25)
 
-def hex_to_hsv(hex_color):
-    r, g, b = hex_to_rgb(hex_color)
-    h, s, v = rgb_to_hsv(r, g, b)
-    return h, s, v
+            if "black" in name:
+                color.set_luminance(0.1)
+            if "white" in name:
+                color.set_luminance(1)
 
+            red = 0.0
+            orange = 0.10
+            yellow = 0.16
+            green = 0.33
+            cyan = 0.5
+            blue = 0.66
+            violet = 0.83
 
-class Color:
-    def __init__(self, r=255, g=255, b=255):
-        self._r = r
-        self._g = g
-        self._b = b
+            if "orange" in name:
+                color.hue = orange
+            elif "yellow" in name:
+                color.hue = yellow
+            elif "green" in name:
+                color.hue = green
+            elif "cyan" in name:
+                color.hue = cyan
+            elif "blue" in name:
+                color.hue = blue
+            elif "violet" in name:
+                color.hue = violet
+            else:
+                color.hue = red
 
-    @staticmethod
-    def from_name(name):
-        name = name.replace(" ", "")  # see link on top of file, requires exact matches
-        return Color(*name_to_rgb(name))
+            return color
 
-    @staticmethod
-    def from_hls(h, l, s):
-        return Color(*hls_to_rgb(h, l, s))
+    @property
+    def main_color(self):
+        """
+        reduce to 1 color of the following:
+        - grey
+        - black
+        - white
+        - orange
+        - yellow
+        - green
+        - cyan
+        - blue
+        - violet
+        - red
+        """
+        if self.saturation <= 0.3:
+            return Color("grey")
+        if self.luminance <= 0.15:
+            return Color("black")
+        elif self.luminance >= 0.85:
+            return Color("white")
 
+        thresh = 0.5
+        orange = 0.10
+        yellow = 0.16
+        green = 0.33
+        cyan = 0.5
+        blue = 0.66
+        violet = 0.83
+
+        if orange - thresh <= self.hue <= orange + thresh:
+            return Color("orange")
+        elif yellow - thresh <= self.hue <= yellow + thresh:
+            return Color("yellow")
+        elif green - thresh <= self.hue <= green + thresh:
+            return Color("green")
+        elif cyan - thresh <= self.hue <= cyan + thresh:
+            return Color("cyan")
+        elif blue - thresh <= self.hue <= blue + thresh:
+            return Color("blue")
+        elif violet - thresh <= self.hue <= violet + thresh:
+            return Color("violet")
+        else:
+            return Color("red")
+
+    @property
+    def color_description(self):
+        if self.web != self.hex:
+            return camel_case_split(self.web).lower()
+        name = ""
+        # light vs dark
+        if self.luminance <= 0.3:
+            name += "dark "
+        elif self.luminance >= 0.6:
+            name += "bright "
+
+        # hue
+        # R >== B >= G Red
+        if self.red >= self.blue >= self.green:
+            name += "red-ish "
+        # R >== G >= = B 	Orange
+        elif self.red >= self.green >= self.blue:
+            name += "orange-ish "
+        # G >= R >== B Yellow
+        elif self.green >= self.red >= self.blue:
+            name += "yellow-ish "
+        # G >== B >= R  Green
+        elif self.green >= self.blue >= self.red:
+            name += "green-ish "
+        # B >= G >= R  Blue
+        elif self.blue >= self.green >= self.red:
+            name += "blue-ish "
+        # B >= R >== G  Violet
+        elif self.blue >= self.red >= self.green:
+            name += "purple-ish "
+
+        # luminance
+        if self.luminance <= 0.15:
+            name += "black-ish "
+        elif self.luminance >= 0.85:
+            name += "white-ish "
+
+        # saturation
+        if self.saturation >= 0.85:
+            name += "intense "
+        name += self.main_color.name + " color"
+
+        return name
+
+    #### HEX ####
     @staticmethod
-    def from_yiq(y, i, q):
-        return Color(*yiq_to_rgb(y, i, q))
+    def from_hex(hex_value):
+        return Color(hex_value)
+
+    #### RGB ####
+    @property
+    def rgb255(self):
+        return (int(self.red * 255),
+                int(self.green * 255),
+                int(self.blue * 255))
+
+    def rgb_percent(self):
+        return self.rgb
 
     @staticmethod
     def from_rgb(r, g, b):
-        return Color(r, g, b)
+        return Color(rgb=(r / 255, g / 255, b / 255))
 
     @staticmethod
-    def from_hsv(h, s, v):
-        return Color(*hsv_to_rgb(h, s, v))
+    def from_rgb_percent(r, g, b):
+        if isinstance(r, str) or isinstance(g, str) or isinstance(b, str):
+            r = float(r.replace("%", ""))
+            g = float(g.replace("%", ""))
+            b = float(b.replace("%", ""))
+        return Color(rgb=(r, g, b))
 
+    #### HSV ####
     @staticmethod
-    def from_hex(hexcode):
-        return Color(*hex_to_rgb(hexcode))
+    def from_hsv(h, s, v):
+        r, g, b = hsv_to_rgb(h, s, v)
+        return Color.from_rgb(r, g, b)
 
     @property
-    def rgb(self):
-        return (int(self._r), int(self._g), int(self._b))
+    def hsv(self):
+        return rgb_to_hsv(self.red, self.green, self.blue)
 
-    @property
-    def yiq(self):
-        return rgb_to_yiq(*self.rgb)
+    #### HLS ####
+    @staticmethod
+    def from_hls(h, l, s):
+        r, g, b = hls_to_rgb(h, l, s)
+        return Color.from_rgb(r, g, b)
 
     @property
     def hls(self):
-        return rgb_to_hls(*self.rgb)
+        return rgb_to_hls(self.red, self.green, self.blue)
 
-    @property
-    def hsv(self):
-        return rgb_to_hsv(*self.rgb)
+    #### YIQ ####
+    @staticmethod
+    def from_yiq(y, i, q):
+        r, g, b = yiq_to_rgb(y, i, q)
+        return Color.from_rgb(r, g, b)
 
     @property
-    def name(self):
-        try:
-            return rgb_to_name(self.rgb)
-        except:
-            return "unnamed color"
+    def yiq(self):
+        return rgb_to_yiq(self.red, self.green, self.blue)
 
-    @property
-    def hex(self):
-        return rgb_to_hex(self.rgb)
+    def __str__(self):
+        return self.hex_l
 
-    def __repr__(self):
-        return "{name}:{rgb}".format(name=self.name, rgb=self.rgb)
 
+class ColorOutOfSpace(Color):
+    """ Some Human described this color, but humans suck at this"""
     @property
-    def as_dict(self):
-        return {
-            "name": self.name,
-            "rgb": self.rgb,
-            "hsv": self.hsv,
-            "hex": self.hex,
-            "hls": self.hls,
-            "yiq": self.yiq
-        }
+    def name(self):
+        # H.P. Lovecraft - https://www.youtube.com/watch?v=4liRxrDzS5I
+        # return "The Color Out of Space"
+        return self.hex
 
 
 if __name__ == "__main__":
-    hex_color = "#ff0000"
-    color_name = hex_to_name(hex_color)
-    print(color_name)
-    h, s, v = name_to_hsv(color_name)
-    print(h, s, v)
-    r, g, b = hex_to_rgb(hex_color)
-    print(r, g, b)
-    h, s, v = rgb_to_hsv(r, g, b)
-    print(h, s, v)
-
-    color = Color()
-    print(color.name)
-    print(color.as_dict)
-    color = Color.from_name("red")
-    print(color.name, color.rgb)
-    color = Color.from_name("dark red")
-    print(color.name, color.rgb)
-    color = Color.from_name("darkred")
-    print(color.name, color.rgb)
-    print(color.as_dict)
-    color = Color.from_name("violet")
-    print(color.name, color.rgb)
-
-    # color = Color()
-    print(color.as_dict)
+    black = Color()
+    assert black == Color("black")
+
+    # NOTE this is the web name
+    try:
+        color = Color("dark green")
+    except ValueError:
+        color = Color("DarkGreen")
+        color.from_name("dark green")  # use this one instead
+
+    assert color.web == "DarkGreen"
+    assert color.name == "dark green"
+
+    white = Color.from_name("white")
+    assert white == Color.from_rgb(255, 255, 255)
+
+    color = Color.from_name("NNNNNNNNNNNNNNNNNN")
+    assert isinstance(color, ColorOutOfSpace)
+    assert color.name != "black"
+    assert color.color_description == "black"
+
+    color = Color.from_rgb(0, 120, 240)
+    assert color.name is None
+    color.set_saturation(0.3)
+    color.set_luminance(0.7)
+    assert color.color_description == "bright blue-ish gray color"
+    assert color.rgb255 == (155, 178, 201)
+
+    aprox_color = Color.from_name("bright blue-ish grey color")
+    assert aprox_color.color_description == "bright blue-ish gray color"
+    assert aprox_color.rgb255 != color.rgb255
+    assert aprox_color.rgb255 == (159, 160, 197)