1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
|
import re
from collections import namedtuple
from collections.abc import Sequence
from colorsys import rgb_to_hsv
from enum import Enum
from typing import Any, Optional, Union
from ._const import CSI, RESET, AnsiBGColor, AnsiFGColor, AnsiStyle
RGBTuple = tuple[int, int, int]
HSV = namedtuple("HSV", "hue saturation value")
_regexp_color_code = re.compile(
"^#?(?P<red>[0-9a-f]{2})(?P<green>[0-9a-f]{2})(?P<blue>[0-9a-f]{2})$", re.IGNORECASE
)
_regexp_normalize = re.compile(r"[\s_-]")
name_to_rgb = {
"BLACK": (0, 0, 0),
"RED": (205, 49, 49),
"GREEN": (13, 188, 121),
"YELLOW": (229, 229, 16),
"BLUE": (36, 114, 200),
"MAGENTA": (188, 63, 188),
"CYAN": (17, 168, 205),
"WHITE": (229, 229, 229),
"LIGHTBLACK": (102, 102, 102),
"LIGHTRED": (241, 76, 76),
"LIGHTGREEN": (35, 209, 139),
"LIGHTYELLOW": (245, 245, 67),
"LIGHTBLUE": (59, 142, 234),
"LIGHTMAGENTA": (214, 112, 214),
"LIGHTCYAN": (41, 184, 219),
"LIGHTWHITE": (255, 255, 255),
}
def _normalize_name(name: str) -> str:
return _regexp_normalize.sub("", name).upper()
class Color:
def __init__(self, color: Union["Color", str, RGBTuple]) -> None:
self.__name = ""
self.__is_color_code_src = False
self.__hsv: Optional[HSV] = None
if color is None:
raise TypeError("color must be one of Color/str/RGBTuple")
if isinstance(color, str):
color = _normalize_name(color)
try:
self.__from_color_name(color)
except KeyError:
self.__from_color_code(color)
return
try:
# from a RGBTuple instance
self.red, self.green, self.blue = color # type: ignore
self.__validate_rgb_value(self.red)
self.__validate_rgb_value(self.green)
self.__validate_rgb_value(self.blue)
except TypeError:
# from a Color instance
self.__name = color.name # type: ignore
self.red, self.green, self.blue = color.red, color.green, color.blue # type: ignore
def __eq__(self, other: Any) -> bool:
if not isinstance(other, Color):
return False
if self.name and other.name:
return self.name == other.name
elif self.name or other.name:
return False
if all([self.red == other.red, self.green == other.green, self.blue == other.blue]):
return True
return False
def __ne__(self, other: Any) -> bool:
if not isinstance(other, Color):
return True
return not self.__eq__(other)
def __repr__(self) -> str:
items = [f"code={self.color_code}, rgb=({self.red}, {self.green}, {self.blue})"]
if self.__name:
items.append(f"name={self.__name}")
return "Color({})".format(", ".join(items))
def __from_color_code(self, color_code: str) -> None:
match = _regexp_color_code.search(color_code)
if match is None:
raise ValueError(f"invalid color code found: {color_code}")
self.__is_color_code_src = True
red, green, blue = match.group(1, 2, 3)
self.red = int(red, 16)
self.green = int(green, 16)
self.blue = int(blue, 16)
def __from_color_name(self, name: str) -> None:
self.red, self.green, self.blue = name_to_rgb[name]
self.__name = name
def __validate_rgb_value(self, n: int) -> None:
if not (0 <= n <= 255):
raise ValueError("value must be within 0-255")
@property
def name(self) -> str:
return self.__name
@property
def is_color_code_src(self) -> bool:
return self.__is_color_code_src
@property
def color_code(self) -> str:
return f"#{self.red:02x}{self.green:02x}{self.blue:02x}"
@property
def hsv(self) -> HSV:
if self.__hsv is None:
self.__hsv = HSV(*rgb_to_hsv(self.red / 255, self.green / 255, self.blue / 255))
return self.__hsv
def calc_scaler(self) -> int:
return self.red + self.green + self.blue
def calc_complementary(self) -> "Color":
rgb = (self.red, self.green, self.blue)
n = max(rgb) + min(rgb)
return Color((n - self.red, n - self.green, n - self.blue))
def _normalize_enum(value: Any, enum_class: type[Enum]) -> Any:
if isinstance(value, enum_class):
return value
try:
return enum_class[_normalize_name(value)]
except AttributeError:
raise TypeError(f"value must be a {enum_class} or a str: actual={type(value)}")
except KeyError:
raise ValueError(
"invalid value found: expected={}, actual={}".format(
"/".join([item.name for item in enum_class]), value
)
)
def _ansi_escape(value: str) -> str:
return f"{CSI}{value}m"
def _to_ansi_style(style: Union[str, AnsiStyle]) -> str:
return _ansi_escape(f"{_normalize_enum(style, AnsiStyle).value}")
def _to_ansi_fg_truecolor(color: Color) -> str:
return _ansi_escape(f"38;2;{color.red};{color.green};{color.blue}")
def _to_ansi_bg_truecolor(color: Color) -> str:
return _ansi_escape(f"48;2;{color.red};{color.green};{color.blue}")
def _to_ansi_fg_color(color: AnsiFGColor) -> str:
return _ansi_escape(f"{color.value}")
def _to_ansi_bg_color(color: AnsiBGColor) -> str:
return _ansi_escape(f"{color.value}")
def _make_ansi_fg_truecolor(color: Union[Color, str, RGBTuple, AnsiFGColor, None]) -> str:
if isinstance(color, AnsiFGColor):
return _to_ansi_fg_color(color)
if isinstance(color, Color):
if color.name:
return _to_ansi_fg_color(_normalize_enum(color.name, AnsiFGColor))
return _to_ansi_fg_truecolor(color)
if isinstance(color, str):
try:
return _to_ansi_fg_color(_normalize_enum(color, AnsiFGColor))
except ValueError:
c = Color(color)
elif isinstance(color, (tuple, list)):
c = Color(color)
else:
c = color # type: ignore
return _to_ansi_fg_truecolor(c) if c else ""
def _make_ansi_bg_truecolor(color: Union[Color, str, RGBTuple, AnsiBGColor, None]) -> str:
if isinstance(color, AnsiBGColor):
return _to_ansi_bg_color(color)
if isinstance(color, Color):
if color.name:
return _to_ansi_bg_color(_normalize_enum(color.name, AnsiBGColor))
return _to_ansi_bg_truecolor(color)
if isinstance(color, str):
try:
return _to_ansi_bg_color(_normalize_enum(color, AnsiBGColor))
except ValueError:
c = Color(color)
elif isinstance(color, (tuple, list)):
c = Color(color)
else:
c = color # type: ignore
return _to_ansi_bg_truecolor(c) if c else ""
def tcolor(
string: str,
color: Union[Color, str, RGBTuple, AnsiFGColor, None] = None,
bg_color: Union[Color, str, RGBTuple, AnsiBGColor, None] = None,
styles: Optional[Sequence[Union[str, AnsiStyle]]] = None,
) -> str:
ansi_fg_color = _make_ansi_fg_truecolor(color)
ansi_bg_color = _make_ansi_bg_truecolor(bg_color)
ansi_styles: list[str] = []
if styles:
ansi_styles = [_to_ansi_style(style) for style in styles]
reset = RESET
if not ansi_fg_color and not ansi_bg_color and not ansi_styles:
reset = ""
return "".join(ansi_styles + [ansi_bg_color, ansi_fg_color, string, reset])
|