Type Annotations

Author: jposada202020

adafruit_display_text/__init__.py

@@ -6,7 +6,10 @@
 Display Text module helper functions
 """
 from displayio import Group, Palette
-
+try:
+    from typing import Tuple
+except:
+    pass
 
 def wrap_text_to_pixels(string, max_width, font=None, indent0="", indent1=""):
     """wrap_text_to_pixels function
@@ -183,27 +186,26 @@ class LabelBase(Group):
     def __init__(
         self,
         font,
-        x=0,
-        y=0,
-        text="",
-        max_glyphs=None,
-        # with label.py
-        color=0xFFFFFF,
-        background_color=None,
-        line_spacing=1.25,
-        background_tight=False,
-        padding_top=0,
-        padding_bottom=0,
-        padding_left=0,
-        padding_right=0,
-        anchor_point=None,
-        anchored_position=None,
-        save_text=True,  # can reduce memory use if save_text = False
-        scale=1,
-        base_alignment=False,
-        tab_replacement=(4, " "),
+        x: int = 0,
+        y: int = 0,
+        text: str = "",
+        max_glyphs: int = None,
+        color: int = 0xFFFFFF,
+        background_color: int = None,
+        line_spacing: float = 1.25,
+        background_tight: bool = False,
+        padding_top: int = 0,
+        padding_bottom: int = 0,
+        padding_left: int = 0,
+        padding_right: int = 0,
+        anchor_point: Tuple[float, float] = None,
+        anchored_position: Tuple[int, int] = None,
+        save_text: bool = True,  # can reduce memory use if save_text = False
+        scale:int = 1,
+        base_alignment: bool = False,
+        tab_replacement: Tuple[int, str] = (4, " "),
         **kwargs,
-    ):
+    ) -> None:
         super().__init__(max_size=1, x=x, y=y, scale=1)
 
         self._font = font
@@ -230,7 +232,7 @@ def __init__(
         else:
             self._y_offset = self._get_ascent() // 2
 
-    def _get_ascent_descent(self):
+    def _get_ascent_descent(self) -> Tuple[int, int]:
         """ Private function to calculate ascent and descent font values """
         if hasattr(self.font, "ascent"):
             return self.font.ascent, self.font.descent
@@ -251,29 +253,29 @@ def _get_ascent_descent(self):
                 descender_max = max(descender_max, -this_glyph.dy)
         return ascender_max, descender_max
 
-    def _get_ascent(self):
+    def _get_ascent(self) -> int:
         return self._get_ascent_descent()[0]
 
     @property
-    def font(self):
+    def font(self) -> None:
         """Font to use for text display."""
         return self._font
 
-    def _set_font(self, new_font):
+    def _set_font(self, new_font) -> None:
         # subclasses should override this
         pass
 
     @font.setter
-    def font(self, new_font):
+    def font(self, new_font) -> None:
         self._set_font(new_font)
 
     @property
-    def color(self):
+    def color(self) -> int:
         """Color of the text as an RGB hex number."""
         return self._color
 
     @color.setter
-    def color(self, new_color):
+    def color(self, new_color: int):
         self._color = new_color
         if new_color is not None:
             self.palette[1] = new_color
@@ -283,12 +285,12 @@ def color(self, new_color):
             self.palette.make_transparent(1)
 
     @property
-    def background_color(self):
+    def background_color(self) -> int:
         """Color of the background as an RGB hex number."""
         return self._background_color
 
     @background_color.setter
-    def background_color(self, new_color):
+    def background_color(self, new_color: int) -> None:
         self._background_color = new_color
         if new_color is not None:
             self.palette[0] = new_color
@@ -298,14 +300,14 @@ def background_color(self, new_color):
             self.palette.make_transparent(0)
 
     @property
-    def anchor_point(self):
+    def anchor_point(self) -> Tuple[float, float]:
         """Point that anchored_position moves relative to.
         Tuple with decimal percentage of width and height.
         (E.g. (0,0) is top left, (1.0, 0.5): is middle right.)"""
         return self._anchor_point
 
     @anchor_point.setter
-    def anchor_point(self, new_anchor_point):
+    def anchor_point(self, new_anchor_point: Tuple[float, float]) -> None:
         if new_anchor_point[1] == self.baseline:
             self._anchor_point = (new_anchor_point[0], -1.0)
         else:
@@ -315,13 +317,13 @@ def anchor_point(self, new_anchor_point):
         )  # update the anchored_position using setter
 
     @property
-    def anchored_position(self):
+    def anchored_position(self) -> Tuple[int, int]:
         """Position relative to the anchor_point. Tuple containing x,y
         pixel coordinates."""
         return self._anchored_position
 
     @anchored_position.setter
-    def anchored_position(self, new_position):
+    def anchored_position(self, new_position: Tuple[int, int]) -> None:
         self._anchored_position = new_position
         # Set anchored_position
         if (self._anchor_point is not None) and (self._anchored_position is not None):
@@ -340,44 +342,44 @@ def anchored_position(self, new_position):
                 )
 
     @property
-    def scale(self):
+    def scale(self) -> int:
         """Set the scaling of the label, in integer values"""
         return self.local_group.scale
 
     @scale.setter
-    def scale(self, new_scale):
+    def scale(self, new_scale: int) -> None:
         self.local_group.scale = new_scale
         self.anchored_position = self._anchored_position  # update the anchored_position
 
-    def _set_text(self, new_text, scale):
+    def _set_text(self, new_text: str, scale: int) -> None:
         # subclasses should override this
         pass
 
     @property
-    def text(self):
+    def text(self) -> str:
         """Text to be displayed."""
         return self._text
 
     @text.setter  # Cannot set color or background color with text setter, use separate setter
-    def text(self, new_text):
+    def text(self, new_text: str) -> None:
         self._set_text(new_text, self.scale)
 
     @property
-    def bounding_box(self):
+    def bounding_box(self) -> Tuple[int, int]:
         """An (x, y, w, h) tuple that completely covers all glyphs. The
         first two numbers are offset from the x, y origin of this group"""
         return tuple(self._bounding_box)
 
     @property
-    def line_spacing(self):
+    def line_spacing(self) -> float:
         """The amount of space between lines of text, in multiples of the font's
         bounding-box height. (E.g. 1.0 is the bounding-box height)"""
         return self._line_spacing
 
-    def _set_line_spacing(self, new_line_spacing):
+    def _set_line_spacing(self, new_line_spacing: float) -> None:
         # subclass should override this.
         pass
 
     @line_spacing.setter
-    def line_spacing(self, new_line_spacing):
+    def line_spacing(self, new_line_spacing: float) -> None:
         self._set_line_spacing(new_line_spacing)

adafruit_display_text/label.py

@@ -23,6 +23,10 @@
 """
 
 import displayio
+try:
+    from typing import Tuple
+except:
+    pass
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Display_Text.git"
@@ -71,7 +75,7 @@ class Label(LabelBase):
     # pylint: disable=too-many-instance-attributes, too-many-locals
     # This has a lot of getters/setters, maybe it needs cleanup.
 
-    def __init__(self, font, **kwargs):
+    def __init__(self, font, **kwargs) -> None:
         super().__init__(font, **kwargs)
 
         max_glyphs = kwargs.get("max_glyphs", None)
@@ -130,7 +134,7 @@ def __init__(self, font, **kwargs):
         ):
             self.anchored_position = kwargs.get("anchored_position", None)
 
-    def _create_background_box(self, lines, y_offset):
+    def _create_background_box(self, lines: int, y_offset: int) -> None:
         """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"""
@@ -172,7 +176,7 @@ def _create_background_box(self, lines, y_offset):
 
         return tile_grid
 
-    def _update_background_color(self, new_color):
+    def _update_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."""
 
@@ -228,8 +232,8 @@ def _update_background_color(self, new_color):
                 self._added_background_tilegrid = False
 
     def _update_text(
-        self, new_text
-    ):  # pylint: disable=too-many-locals ,too-many-branches, too-many-statements
+        self, new_text: str
+    ) -> None:  # pylint: disable=too-many-locals ,too-many-branches, too-many-statements
         x = 0
         y = 0
         if self._added_background_tilegrid:
@@ -305,7 +309,7 @@ def _update_text(
         if self.background_color is not None:
             self._update_background_color(self._background_color)
 
-    def _reset_text(self, new_text):
+    def _reset_text(self, new_text: str) -> None:
         new_text = self._tab_text.join(new_text.split("\t"))
         try:
             current_anchored_position = self.anchored_position
@@ -314,7 +318,7 @@ def _reset_text(self, new_text):
         except RuntimeError as run_error:
             raise RuntimeError("Text length exceeds max_glyphs") from run_error
 
-    def _set_font(self, new_font):
+    def _set_font(self, new_font) -> None:
         old_text = self._text
         current_anchored_position = self.anchored_position
         self._text = ""
@@ -323,9 +327,9 @@ def _set_font(self, new_font):
         self._update_text(str(old_text))
         self.anchored_position = current_anchored_position
 
-    def _set_line_spacing(self, new_line_spacing):
+    def _set_line_spacing(self, new_line_spacing: float) -> None:
         self._line_spacing = new_line_spacing
         self.text = self._text  # redraw the box
 
-    def _set_text(self, new_text, scale):
+    def _set_text(self, new_text: str, scale: int) -> None:
         self._reset_text(new_text)