baserow.color

  1import enum
  2import random
  3from typing import Optional
  4
  5from typing_extensions import Self
  6
  7
  8class Color(str, enum.Enum):
  9    """The colors defined and provided by Baserow."""
 10
 11    DARK_BLUE = "dark-blue"
 12    """Hex: #acc8f8"""
 13    DARK_GREEN = "dark-green"
 14    """Hex: #a0eeba"""
 15    DARK_CYAN = "dark-cyan"
 16    """Hex: #70e0ef"""
 17    DARK_YELLOW = "dark-yellow"
 18    """Hex: #ffdd8f"""
 19    DARK_ORANGE = "dark-orange"
 20    """Hex: #ffe9b4"""
 21    DARK_RED = "dark-red"
 22    """Hex: #ffbdb4"""
 23    DARK_BROWN = "dark-brown"
 24    """Hex: #f5c098"""
 25    DARK_PURPLE = "dark-purple"
 26    """Hex: #cf96f2"""
 27    DARK_PINK = "dark-pink"
 28    """Hex: #f285d9"""
 29    DARK_GRAY = "dark-gray"
 30    """Hex: #b5b5b7"""
 31    LIGHT_BLUE = "light-blue"
 32    """Hex: #f0f4fc"""
 33    LIGHT_GREEN = "light-green"
 34    """Hex: #ecfcf1"""
 35    LIGHT_CYAN = "light-cyan"
 36    """Hex: #cff5fa"""
 37    LIGHT_YELLOW = "light-yellow"
 38    """Hex: #fffbf0"""
 39    LIGHT_ORANGE = "light-orange"
 40    """Hex: #fffbf0"""
 41    LIGHT_RED = "light-red"
 42    """Hex: #fff2f0"""
 43    LIGHT_BROWN = "light-brown"
 44    """Hex: #f5e6dc"""
 45    LIGHT_PURPLE = "light-purple"
 46    """Hex: #f9f1fd"""
 47    LIGHT_PINK = "light-pink"
 48    """Hex: #f7e1f2"""
 49    LIGHT_GRAY = "light-gray"
 50    """Hex: #f5f5f5"""
 51    BLUE = "blue"
 52    """Hex: #dae4fd"""
 53    GREEN = "green"
 54    """Hex: #d0f6dc"""
 55    CYAN = "cyan"
 56    """Hex: #a0ebf5"""
 57    YELLOW = "yellow"
 58    """Hex: #ffe9b4"""
 59    ORANGE = "orange"
 60    """Hex: #fff4da"""
 61    RED = "red"
 62    """Hex: #ffdeda"""
 63    BROWN = "brown"
 64    """Hex: #f5ceb0"""
 65    PURPLE = "purple"
 66    """Hex: #dfb9f7"""
 67    PINK = "pink"
 68    """Hex: #f7b2e7"""
 69    GRAY = "gray"
 70    """Hex: #d7d8d9"""
 71    DARKER_BLUE = "darker-blue"
 72    """Hex: #689ef1"""
 73    DARKER_GREEN = "darker-green"
 74    """Hex: #41dd75"""
 75    DARKER_CYAN = "darker-cyan"
 76    """Hex: #41d6ea"""
 77    DARKER_YELLOW = "darker-yellow"
 78    """Hex: #ffd269"""
 79    DARKER_ORANGE = "darker-orange"
 80    """Hex: #ffd269"""
 81    DARKER_RED = "darker-red"
 82    """Hex: #ff7b69"""
 83    DARKER_BROWN = "darker-brown"
 84    """Hex: #f5a96e"""
 85    DARKER_PURPLE = "darker-purple"
 86    """Hex: #bf73ee"""
 87    DARKER_PINK = "darker-pink"
 88    """Hex: #ff6dde"""
 89    DARKER_GRAY = "darker-gray"
 90    """Hex: #b5b5b7"""
 91
 92    @classmethod
 93    def random(cls):
 94        """
 95        Returns a random color.
 96        """
 97        return random.choice(list(cls))
 98
 99
100class BasicColor(str, enum.Enum):
101    """
102    Limited color palette from Baserow, as used in the rating field, for
103    example.
104    """
105
106    DARK_BLUE = "dark-blue"
107    """Hex: #acc8f8"""
108    DARK_GREEN = "dark-green"
109    """Hex: #a0eeba"""
110    DARK_YELLOW = "dark-yellow"
111    """Hex: #ffdd8f"""
112    DARK_RED = "dark-red"
113    """Hex: #ffbdb4"""
114
115    @classmethod
116    def random(cls) -> Self:
117        """
118        Returns a random color.
119        """
120        return random.choice(list(cls))
121
122
123class ColorSequence:
124    """
125    This class provides the ability to obtain appealing color gradients. Using
126    the method `ColorProvider.get_color()`, you can retrieve the colors
127    sequentially.
128    """
129
130    def __init__(self):
131        self.__current_index: int = 0
132
133    def get_color(self) -> Color:
134        """
135        Returns the next `Color` in the order of the Enum.
136        """
137        color_list = list(Color)
138        rsl = color_list[self.__current_index]
139        self.__current_index = (self.__current_index + 1) % len(color_list)
140        return rsl