Refactor local_group to a protected variable.

Author: lesamouraipourpre

adafruit_display_text/__init__.py

@@ -37,15 +37,15 @@ def wrap_text_to_pixels(
     # pylint: disable=too-many-locals, too-many-branches
     if font is None:
 
-        def measure(string):
-            return len(string)
+        def measure(text):
+            return len(text)
 
     else:
         if hasattr(font, "load_glyphs"):
             font.load_glyphs(string)
 
-        def measure(string):
-            return sum(font.get_glyph(ord(c)).shift_x for c in string)
+        def measure(text):
+            return sum(font.get_glyph(ord(c)).shift_x for c in text)
 
     lines = []
     partial = [indent0]
@@ -237,9 +237,10 @@ def __init__(
         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
+        # 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._local_group = Group(scale=scale)
+        self.append(self._local_group)
 
         self.baseline = -1.0
 
@@ -250,7 +251,7 @@ def __init__(
 
     def _get_ascent_descent(self) -> Tuple[int, int]:
         """ Private function to calculate ascent and descent font values """
-        if hasattr(self.font, "ascent"):
+        if hasattr(self.font, "ascent") and hasattr(self.font, "descent"):
             return self.font.ascent, self.font.descent
 
         # check a few glyphs for maximum ascender and descender height
@@ -355,11 +356,11 @@ def anchored_position(self, new_position: Tuple[int, int]) -> None:
     @property
     def scale(self) -> int:
         """Set the scaling of the label, in integer values"""
-        return self.local_group.scale
+        return self._local_group.scale
 
     @scale.setter
     def scale(self, new_scale: int) -> None:
-        self.local_group.scale = new_scale
+        self._local_group.scale = new_scale
         self.anchored_position = self._anchored_position  # update the anchored_position
 
     def _set_text(self, new_text: str, scale: int) -> None:

adafruit_display_text/bitmap_label.py

@@ -87,13 +87,6 @@ def __init__(self, font, save_text=True, **kwargs) -> None:
 
         super().__init__(font, **kwargs)
 
-        self.local_group = displayio.Group(
-            scale=kwargs.get("scale", 1)
-        )  # local_group holds the tileGrid and sets the scaling
-        self.append(
-            self.local_group
-        )  # the local_group will always stay in the self Group
-
         text = kwargs.get("text", "")
         self._save_text = save_text
         self._text = self._replace_tabs(text)
@@ -145,10 +138,10 @@ def _reset_text(
                 0,  # zero width with text == ""
                 0,  # zero height with text == ""
             )
-            # Clear out any items in the self.local_group Group, in case this is an
+            # Clear out any items in the self._local_group Group, in case this is an
             # update to the bitmap_label
-            for _ in self.local_group:
-                self.local_group.pop(0)
+            for _ in self._local_group:
+                self._local_group.pop(0)
 
         else:  # The text string is not empty, so create the Bitmap and TileGrid and
             # append to the self Group
@@ -222,9 +215,9 @@ def _reset_text(
 
             # Clear out any items in the local_group Group, in case this is an update to
             # the bitmap_label
-            for _ in self.local_group:
-                self.local_group.pop(0)
-            self.local_group.append(
+            for _ in self._local_group:
+                self._local_group.pop(0)
+            self._local_group.append(
                 self.tilegrid
             )  # add the bitmap's tilegrid to the group
 
@@ -345,8 +338,6 @@ def _place_text(
         font,
         xposition: int,
         yposition: int,
-        text_palette_index: int = 1,
-        background_palette_index: int = 0,
         skip_index: int = 0,  # set to None to write all pixels, other wise skip this palette index
         # when copying glyph bitmaps (this is important for slanted text
         # where rectangular glyph boxes overlap)
@@ -403,8 +394,8 @@ def _place_text(
                     # Clip glyph y-direction if outside the font ascent/descent metrics.
                     # Note: bitmap.blit will automatically clip the bottom of the glyph.
                     y_clip = 0
-                    if (y_blit_target) < 0:
-                        y_clip = -(y_blit_target)  # clip this amount from top of bitmap
+                    if y_blit_target < 0:
+                        y_clip = -y_blit_target  # clip this amount from top of bitmap
                         y_blit_target = 0  # draw the clipped bitmap at y=0
 
                         print(
@@ -434,7 +425,8 @@ def _place_text(
 
                     xposition = xposition + my_glyph.shift_x
 
-        return (left, top, right - left, bottom - top)  # bounding_box
+        # bounding_box
+        return left, top, right - left, bottom - top
 
     def _blit(
         self,

adafruit_display_text/label.py

@@ -31,7 +31,7 @@
 except ImportError:
     pass
 
-import displayio
+from displayio import Bitmap, Palette, TileGrid
 
 from adafruit_display_text import LabelBase
 
@@ -81,17 +81,13 @@ 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._background_palette = Palette(1)
         self._added_background_tilegrid = False
 
         super().__init__(font, **kwargs)
 
         text = self._replace_tabs(self._text)
 
-        # local_group will set the scale
-        self.local_group = displayio.Group(scale=kwargs.get("scale", 1))
-        self.append(self.local_group)
-
         self.width = len(text)
         self._font = font
         self._text = None
@@ -106,7 +102,7 @@ def __init__(self, font, **kwargs) -> None:
         if text is not None:
             self._reset_text(str(text))
 
-    def _create_background_box(self, lines: int, y_offset: int) -> None:
+    def _create_background_box(self, lines: int, y_offset: int) -> TileGrid:
         """Private Class function to create a background_box
         :param lines: int number of lines
         :param y_offset: int y pixel bottom coordinate for the background_box"""
@@ -165,8 +161,8 @@ def _create_background_box(self, lines: int, y_offset: int) -> None:
             movx = left + x_box_offset
             movy = y_box_offset
 
-        background_bitmap = displayio.Bitmap(box_width, box_height, 1)
-        tile_grid = displayio.TileGrid(
+        background_bitmap = Bitmap(box_width, box_height, 1)
+        tile_grid = TileGrid(
             background_bitmap,
             pixel_shader=self._background_palette,
             x=movx,
@@ -182,7 +178,7 @@ def _set_background_color(self, new_color: int) -> None:
         if new_color is None:
             self._background_palette.make_transparent(0)
             if self._added_background_tilegrid:
-                self.local_group.pop(0)
+                self._local_group.pop(0)
                 self._added_background_tilegrid = False
         else:
             self._background_palette.make_opaque(0)
@@ -207,15 +203,9 @@ def _set_background_color(self, new_color: int) -> None:
                     self._bounding_box[3] + self._padding_top + self._padding_bottom > 0
                 )
             ):
-                # This can be simplified in CP v6.0, when group.append(0) bug is corrected
-                if len(self.local_group) > 0:
-                    self.local_group.insert(
-                        0, self._create_background_box(lines, y_offset)
-                    )
-                else:
-                    self.local_group.append(
-                        self._create_background_box(lines, y_offset)
-                    )
+                self._local_group.insert(
+                    0, self._create_background_box(lines, y_offset)
+                )
                 self._added_background_tilegrid = True
 
         else:  # a bitmap is present in the self Group
@@ -229,9 +219,11 @@ def _set_background_color(self, new_color: int) -> None:
                     self._bounding_box[3] + self._padding_top + self._padding_bottom > 0
                 )
             ):
-                self.local_group[0] = self._create_background_box(lines, self._y_offset)
+                self._local_group[0] = self._create_background_box(
+                    lines, self._y_offset
+                )
             else:  # delete the existing bitmap
-                self.local_group.pop(0)
+                self._local_group.pop(0)
                 self._added_background_tilegrid = False
 
     # pylint: disable = too-many-branches, too-many-statements
@@ -269,6 +261,8 @@ def _update_text(
             if not glyph:
                 continue
 
+            position_x, position_y = 0, 0
+
             if self._label_direction in ("LTR", "RTL"):
                 bottom = max(bottom, y - glyph.dy + self._y_offset)
                 if y == 0:  # first line, find the Ascender height
@@ -337,26 +331,15 @@ def _update_text(
                 position_x = x + glyph.dy - self._y_offset
 
             if glyph.width > 0 and glyph.height > 0:
-                try:
-                    # pylint: disable=unexpected-keyword-arg
-                    face = displayio.TileGrid(
-                        glyph.bitmap,
-                        pixel_shader=self._palette,
-                        default_tile=glyph.tile_index,
-                        tile_width=glyph.width,
-                        tile_height=glyph.height,
-                        position=(position_x, position_y),
-                    )
-                except TypeError:
-                    face = displayio.TileGrid(
-                        glyph.bitmap,
-                        pixel_shader=self._palette,
-                        default_tile=glyph.tile_index,
-                        tile_width=glyph.width,
-                        tile_height=glyph.height,
-                        x=position_x,
-                        y=position_y,
-                    )
+                face = TileGrid(
+                    glyph.bitmap,
+                    pixel_shader=self._palette,
+                    default_tile=glyph.tile_index,
+                    tile_width=glyph.width,
+                    tile_height=glyph.height,
+                    x=position_x,
+                    y=position_y,
+                )
 
                 if self._label_direction == "UPR":
                     face.transpose_xy = True
@@ -365,10 +348,10 @@ def _update_text(
                     face.transpose_xy = True
                     face.flip_y = True
 
-                if tilegrid_count < len(self.local_group):
-                    self.local_group[tilegrid_count] = face
+                if tilegrid_count < len(self._local_group):
+                    self._local_group[tilegrid_count] = face
                 else:
-                    self.local_group.append(face)
+                    self._local_group.append(face)
                 tilegrid_count += 1
 
             if self._label_direction == "RTL":
@@ -394,8 +377,8 @@ def _update_text(
         if self._label_direction == "TTB" and top is None:
             top = 0
 
-        while len(self.local_group) > tilegrid_count:  # i:
-            self.local_group.pop()
+        while len(self._local_group) > tilegrid_count:  # i:
+            self._local_group.pop()
         # pylint: disable=invalid-unary-operand-type
         if self._label_direction == "RTL":
             self._bounding_box = (-left, top, left - right, bottom - top)