# Copyright (c) 2010-2024 fastpyxl
import re
from fastpyxl.compat import safe_string
from fastpyxl.descriptors import (
Typed,
)
from fastpyxl.typed_serialisable.base import Serialisable
from fastpyxl.typed_serialisable.errors import FieldValidationError
from fastpyxl.typed_serialisable.fields import Field
# Default Color Index as per 18.8.27 of ECMA Part 4
COLOR_INDEX = (
'00000000', '00FFFFFF', '00FF0000', '0000FF00', '000000FF', #0-4
'00FFFF00', '00FF00FF', '0000FFFF', '00000000', '00FFFFFF', #5-9
'00FF0000', '0000FF00', '000000FF', '00FFFF00', '00FF00FF', #10-14
'0000FFFF', '00800000', '00008000', '00000080', '00808000', #15-19
'00800080', '00008080', '00C0C0C0', '00808080', '009999FF', #20-24
'00993366', '00FFFFCC', '00CCFFFF', '00660066', '00FF8080', #25-29
'000066CC', '00CCCCFF', '00000080', '00FF00FF', '00FFFF00', #30-34
'0000FFFF', '00800080', '00800000', '00008080', '000000FF', #35-39
'0000CCFF', '00CCFFFF', '00CCFFCC', '00FFFF99', '0099CCFF', #40-44
'00FF99CC', '00CC99FF', '00FFCC99', '003366FF', '0033CCCC', #45-49
'0099CC00', '00FFCC00', '00FF9900', '00FF6600', '00666699', #50-54
'00969696', '00003366', '00339966', '00003300', '00333300', #55-59
'00993300', '00993366', '00333399', '00333333', #60-63
)
# indices 64 and 65 are reserved for the system foreground and background colours respectively
# Will remove these definitions in a future release
BLACK = COLOR_INDEX[0]
WHITE = COLOR_INDEX[1]
#RED = COLOR_INDEX[2]
#DARKRED = COLOR_INDEX[8]
BLUE = COLOR_INDEX[4]
#DARKBLUE = COLOR_INDEX[12]
#GREEN = COLOR_INDEX[3]
#DARKGREEN = COLOR_INDEX[9]
#YELLOW = COLOR_INDEX[5]
#DARKYELLOW = COLOR_INDEX[19]
aRGB_REGEX = re.compile("^([A-Fa-f0-9]{8}|[A-Fa-f0-9]{6})$")
[docs]
class RGB(Typed):
"""
Descriptor for aRGB values
If not supplied alpha is 00
"""
expected_type = str
def __set__(self, instance, value):
if not self.allow_none:
m = aRGB_REGEX.match(value)
if m is None:
raise ValueError("Colors must be aRGB hex values")
if len(value) == 6:
value = "00" + value
super().__set__(instance, value)
[docs]
class Color(Serialisable):
"""Named colors for use in styles."""
tagname = "color"
rgb: str | None = Field.attribute(
expected_type=str,
allow_none=True,
converter=lambda v: _rgb_converter(v, "rgb"), default=None,
)
indexed: int | None = Field.attribute(expected_type=int, allow_none=True, default=None)
auto: bool | None = Field.attribute(expected_type=bool, allow_none=True, default=None)
theme: int | None = Field.attribute(expected_type=int, allow_none=True, default=None)
tint: float | None = Field.attribute(
expected_type=float,
allow_none=True,
converter=lambda v: _tint_converter(v, "tint"), default=None,
)
type: str | None = Field.attribute(expected_type=str, allow_none=True, default=None)
def __init__(self, rgb=BLACK, indexed=None, auto=None, theme=None, tint=0.0, index=None, type='rgb'):
if index is not None:
indexed = index
if indexed is not None:
self.type = 'indexed'
self.indexed = indexed
elif theme is not None:
self.type = 'theme'
self.theme = theme
elif auto is not None:
self.type = 'auto'
self.auto = auto
else:
self.rgb = rgb
self.type = 'rgb'
self.tint = tint
@property
def value(self):
t = self.type
assert t is not None
if t == 'rgb':
return self.rgb
if t == 'indexed':
return self.indexed
if t == 'theme':
return self.theme
return self.auto
@value.setter
def value(self, value):
t = self.type
assert t is not None
if t == 'rgb':
self.rgb = value
elif t == 'indexed':
self.indexed = value
elif t == 'theme':
self.theme = value
else:
self.auto = value
def __iter__(self):
attrs = [(self.type, self.value)]
if self.tint != 0:
attrs.append(('tint', self.tint))
for k, v in attrs:
yield k, safe_string(v)
@property
def index(self):
# legacy
return self.value
def __add__(self, other):
"""
Adding colours is undefined behaviour best do nothing
"""
if not isinstance(other, Color):
return super().__add__(other)
return self
[docs]
class ColorDescriptor(Typed):
expected_type = Color
def __set__(self, instance, value):
if isinstance(value, str):
value = Color(rgb=value)
super().__set__(instance, value)
[docs]
class RgbColor(Serialisable):
tagname = "rgbColor"
rgb: str | None = Field.attribute(
expected_type=str,
allow_none=True,
converter=lambda v: _rgb_converter(v, "rgb"), default=None,
)
def __init__(self,
rgb=None,
):
self.rgb = rgb
[docs]
class ColorList(Serialisable):
tagname = "colors"
indexedColors: list[RgbColor] = Field.nested_sequence(
expected_type=RgbColor,
allow_none=True, default=list,
)
mruColors: list[Color] = Field.nested_sequence(
expected_type=Color,
allow_none=True, default=list,
)
def __init__(self,
indexedColors=(),
mruColors=(),
):
self.indexedColors = [
RgbColor(rgb=c) if isinstance(c, str) else c for c in indexedColors
]
self.mruColors = list(mruColors)
def __bool__(self):
return bool(self.indexedColors) or bool(self.mruColors)
@property
def index(self):
return [val.rgb for val in self.indexedColors]
def _rgb_converter(value, field_name: str):
if value is None:
return None
if not isinstance(value, str):
raise TypeError("Colors must be aRGB hex values")
if aRGB_REGEX.match(value) is None:
raise FieldValidationError(f"{field_name} rejected value {value!r}")
if len(value) == 6:
return "00" + value
return value
def _tint_converter(value, field_name: str):
if value is None:
return None
try:
numeric = float(value)
except Exception as exc: # pragma: no cover
raise FieldValidationError(f"{field_name} rejected value {value!r}") from exc
if numeric < -1 or numeric > 1:
raise FieldValidationError(f"{field_name} rejected value {value!r}")
return numeric
