Refactor color, background_color & palette

adafruit_display_text/__init__.py

@@ -213,36 +213,36 @@ def __init__(
         super().__init__(x=x, y=y, scale=1)
 
         self._font = font
+        self._text = text
+        self._palette = Palette(2)
+        self._color = 0xFFFFFF
+        self._background_color = None
         self._line_spacing = line_spacing
         self._background_tight = background_tight
         self._padding_top = padding_top
         self._padding_bottom = padding_bottom
         self._padding_left = padding_left
         self._padding_right = padding_right
-        self._ascent, self._descent = self._get_ascent_descent()
-        self.palette = Palette(2)
-        self._color = color
-        self._background_color = background_color
-
-        self._bounding_box = None
         self._anchor_point = anchor_point
         self._anchored_position = anchored_position
+        self.base_alignment = base_alignment
+        self._label_direction = label_direction
+        self._tab_replacement = tab_replacement
+        self._tab_text = self._tab_replacement[1] * self._tab_replacement[0]
+
+        self._ascent, self._descent = self._get_ascent_descent()
+        self._bounding_box = None
+
+        self.color = color
+        self.background_color = background_color
 
         # local group will hold background and text
         # the self group scale should always remain at 1, the self.local_group will
         # be used to set the scale of the label
         self.local_group = None
 
-        self._text = text
-
-        self._label_direction = label_direction
-
         self.baseline = -1.0
 
-        self.base_alignment = base_alignment
-        self._tab_replacement = tab_replacement
-        self._tab_text = self._tab_replacement[1] * self._tab_replacement[0]
-
         if self.base_alignment:
             self._y_offset = 0
         else:
@@ -290,20 +290,21 @@ def color(self) -> int:
     def color(self, new_color: int):
         self._color = new_color
         if new_color is not None:
-            self.palette[1] = new_color
-            self.palette.make_opaque(1)
+            self._palette[1] = new_color
+            self._palette.make_opaque(1)
         else:
-            self.palette[1] = 0
-            self.palette.make_transparent(1)
+            self._palette[1] = 0
+            self._palette.make_transparent(1)
 
     @property
     def background_color(self) -> int:
         """Color of the background as an RGB hex number."""
         return self._background_color
 
     def _set_background_color(self, new_color):
-        # subclasses should override this
-        pass
+        raise NotImplementedError(
+            "{} MUST override '_set_background_color'".format(type(self))
+        )
 
     @background_color.setter
     def background_color(self, new_color: int) -> None:

adafruit_display_text/bitmap_label.py

@@ -98,10 +98,6 @@ def __init__(self, font, save_text=True, **kwargs) -> None:
         self._save_text = save_text
         self._text = self._replace_tabs(text)
 
-        # Create the two-color palette
-        self.color = kwargs.get("color", 0xFFFFFF)
-        self.background_color = kwargs.get("background_color", None)
-
         if self._label_direction == "RTL":
             self._text = "".join(reversed(self._text))
 
@@ -200,7 +196,7 @@ def _reset_text(
             box_y = box_y + self._padding_top + self._padding_bottom
 
             # Create the bitmap and TileGrid
-            self.bitmap = displayio.Bitmap(box_x, box_y, len(self.palette))
+            self.bitmap = displayio.Bitmap(box_x, box_y, len(self._palette))
 
             # Place the text into the Bitmap
             self._place_text(
@@ -218,7 +214,7 @@ def _reset_text(
 
             self.tilegrid = displayio.TileGrid(
                 self.bitmap,
-                pixel_shader=self.palette,
+                pixel_shader=self._palette,
                 width=1,
                 height=1,
                 tile_width=box_x,
@@ -546,11 +542,11 @@ def _set_text(self, new_text: str, scale: int) -> None:
     def _set_background_color(self, new_color):
         self._background_color = new_color
         if new_color is not None:
-            self.palette[0] = new_color
-            self.palette.make_opaque(0)
+            self._palette[0] = new_color
+            self._palette.make_opaque(0)
         else:
-            self.palette[0] = 0
-            self.palette.make_transparent(0)
+            self._palette[0] = 0
+            self._palette.make_transparent(0)
 
     def _set_label_direction(self, new_label_direction: str) -> None:
         self._label_direction = new_label_direction

adafruit_display_text/label.py

@@ -47,6 +47,7 @@ class Label(LabelBase):
     :param str text: Text to display
     :param int max_glyphs: The largest quantity of glyphs we will display
     :param int color: Color of all text in RGB hex
+    :param int background_color: Color of the background, use `None` for transparent
     :param float line_spacing: Line spacing of text to display
     :param bool background_tight: Set `True` only if you want background box to tightly
      surround text. When set to 'True' Padding parameters will be ignored.
@@ -81,6 +82,9 @@ class Label(LabelBase):
     # This has a lot of getters/setters, maybe it needs cleanup.
 
     def __init__(self, font, **kwargs) -> None:
+        self._background_palette = displayio.Palette(1)
+        self._added_background_tilegrid = False
+
         super().__init__(font, **kwargs)
 
         max_glyphs = kwargs.get("max_glyphs", None)
@@ -105,14 +109,8 @@ def __init__(self, font, **kwargs) -> None:
         self._bounding_box = None
 
         # Create the two-color text palette
-        self.palette = displayio.Palette(2)
-        self.palette[0] = 0
-        self.palette.make_transparent(0)
-        self.color = kwargs.get("color", 0xFFFFFF)
-
-        self._background_color = kwargs.get("background_color", None)
-        self._background_palette = displayio.Palette(1)
-        self._added_background_tilegrid = False
+        self._palette[0] = 0
+        self._palette.make_transparent(0)
 
         self.base_alignment = kwargs.get("base_alignment", False)
 
@@ -192,9 +190,9 @@ def _create_background_box(self, lines: int, y_offset: int) -> None:
 
         return tile_grid
 
-    def _update_background_color(self, new_color: int) -> None:
+    def _set_background_color(self, new_color: int) -> None:
         """Private class function that allows updating the font box background color
-        :param new_color: int color as an RGB hex number."""
+        :param int new_color: color as an RGB hex number."""
 
         if new_color is None:
             self._background_palette.make_transparent(0)
@@ -209,6 +207,10 @@ def _update_background_color(self, new_color: int) -> None:
         lines = self._text.rstrip("\n").count("\n") + 1
         y_offset = self._ascent // 2
 
+        if self._bounding_box is None:
+            # Still in initialization
+            return
+
         if not self._added_background_tilegrid:  # no bitmap is in the self Group
             # add bitmap if text is present and bitmap sizes > 0 pixels
             if (
@@ -354,7 +356,7 @@ def _update_text(
                     # pylint: disable=unexpected-keyword-arg
                     face = displayio.TileGrid(
                         glyph.bitmap,
-                        pixel_shader=self.palette,
+                        pixel_shader=self._palette,
                         default_tile=glyph.tile_index,
                         tile_width=glyph.width,
                         tile_height=glyph.height,
@@ -363,7 +365,7 @@ def _update_text(
                 except TypeError:
                     face = displayio.TileGrid(
                         glyph.bitmap,
-                        pixel_shader=self.palette,
+                        pixel_shader=self._palette,
                         default_tile=glyph.tile_index,
                         tile_width=glyph.width,
                         tile_height=glyph.height,
@@ -423,8 +425,8 @@ def _update_text(
 
         self._text = new_text
 
-        if self.background_color is not None:
-            self._update_background_color(self._background_color)
+        if self._background_color is not None:
+            self._set_background_color(self._background_color)
 
     def _reset_text(self, new_text: str) -> None:
         try:
@@ -450,9 +452,6 @@ def _set_line_spacing(self, new_line_spacing: float) -> None:
     def _set_text(self, new_text: str, scale: int) -> None:
         self._reset_text(new_text)
 
-    def _set_background_color(self, new_color: int) -> None:
-        self._update_background_color(new_color)
-
     def _set_label_direction(self, new_label_direction: str) -> None:
         self._label_direction = new_label_direction
         self._update_text(str(self._text))