Updated type annotations

Author: isacben

adafruit_bitmap_font/bdf.py

@@ -23,14 +23,14 @@
 """
 
 try:
-    from typing import Union, Optional, Tuple
+    from typing import Union, Optional, Tuple, Iterable
+    from io import FileIO
+    from displayio import Bitmap
 except ImportError:
     pass
 
 import gc
-from io import FileIO
 from fontio import Glyph
-from displayio import Bitmap
 from .glyph_cache import GlyphCache
 
 __version__ = "0.0.0-auto.0"
@@ -120,7 +120,7 @@ def get_bounding_box(self) -> Tuple[int, int, int, int]:
         """Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset"""
         return self._boundingbox
 
-    def load_glyphs(self, code_points: Union[int, str, set]) -> None:
+    def load_glyphs(self, code_points: Union[int, str, Iterable]) -> None:
         # pylint: disable=too-many-statements,too-many-branches,too-many-nested-blocks,too-many-locals
         metadata = True
         character = False

adafruit_bitmap_font/bitmap_font.py

@@ -24,32 +24,39 @@
 
 try:
     from typing import Optional, Union
+    from displayio import Bitmap
+    from . import bdf
+    from . import pcf
+    from . import ttf
 except ImportError:
     pass
 
-from displayio import Bitmap
-from . import bdf
-from . import pcf
-from . import ttf
-
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git"
 
 
 def load_font(
     filename: str, bitmap: Optional[Bitmap] = None
-) -> Union[bdf.BDF, pcf.PCF, ttf.TTF, None]:
+) -> Union[bdf.BDF, pcf.PCF, ttf.TTF]:
     """Loads a font file. Returns None if unsupported."""
-    # pylint: disable=import-outside-toplevel, consider-using-with
+    # pylint: disable=import-outside-toplevel, redefined-outer-name, consider-using-with
     if not bitmap:
-        bitmap = Bitmap
+        import displayio
+
+        bitmap = displayio.Bitmap
     font_file = open(filename, "rb")
     first_four = font_file.read(4)
     if filename.endswith("bdf") and first_four == b"STAR":
+        from . import bdf
+
         return bdf.BDF(font_file, bitmap)
     if filename.endswith("pcf") and first_four == b"\x01fcp":
+        from . import pcf
+
         return pcf.PCF(font_file, bitmap)
     if filename.endswith("ttf") and first_four == b"\x00\x01\x00\x00":
+        from . import ttf
+
         return ttf.TTF(font_file, bitmap)
 
     raise ValueError("Unknown magic number %r" % first_four)

adafruit_bitmap_font/glyph_cache.py

@@ -23,12 +23,12 @@
 """
 
 try:
-    from typing import Union, Optional
+    from typing import Union, Iterable
+    from fontio import Glyph
 except ImportError:
     pass
 
 import gc
-from fontio import Glyph
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font.git"
@@ -40,10 +40,10 @@ class GlyphCache:
     def __init__(self) -> None:
         self._glyphs = {}
 
-    def load_glyphs(self, code_points: Union[int, str, set]) -> None:
+    def load_glyphs(self, code_points: Union[int, str, Iterable]) -> None:
         """Loads displayio.Glyph objects into the GlyphCache from the font."""
 
-    def get_glyph(self, code_point: int) -> Optional[Glyph]:
+    def get_glyph(self, code_point: int) -> Glyph:
         """Returns a displayio.Glyph for the given code point or None is unsupported."""
         if code_point in self._glyphs:
             return self._glyphs[code_point]

adafruit_bitmap_font/pcf.py

@@ -23,17 +23,17 @@
 """
 
 try:
-    from typing import Union, Generator
+    from typing import Union, Tuple, Iterator, Iterable
+    from io import FileIO
+    from displayio import Bitmap as displayioBitmap
 except ImportError:
     pass
 
 from collections import namedtuple
 import gc
 import struct
-from io import FileIO
 from micropython import const
 from fontio import Glyph
-from displayio import Bitmap as displayioBitmap
 from .glyph_cache import GlyphCache
 
 try:
@@ -148,18 +148,18 @@ def descent(self) -> int:
         """The number of pixels below the baseline of a typical descender"""
         return self._descent
 
-    def get_bounding_box(self) -> tuple:
+    def get_bounding_box(self) -> Tuple[int, int, int, int]:
         """Return the maximum glyph size as a 4-tuple of: width, height, x_offset, y_offset"""
         return self._bounding_box
 
-    def _read(self, format_: str) -> tuple:
+    def _read(self, format_: str) -> Tuple:
         size = struct.calcsize(format_)
         if size != len(self.buffer):
             self.buffer = bytearray(size)
         self.file.readinto(self.buffer)
         return struct.unpack_from(format_, self.buffer)
 
-    def _seek_table(self, table: dict) -> int:
+    def _seek_table(self, table: Table) -> int:
         self.file.seek(table.offset)
         (format_,) = self._read("<I")
 
@@ -266,7 +266,7 @@ def _read_accelerator_tables(self) -> Accelerators:
             ink_maxbounds,
         )
 
-    def _read_properties(self) -> Generator[tuple, None, None]:
+    def _read_properties(self) -> Iterator[Tuple[bytes, Union[bytes, int]]]:
         property_table_offset = self.tables[_PCF_PROPERTIES]["offset"]
         self.file.seek(property_table_offset)
         (format_,) = self._read("<I")
@@ -297,7 +297,7 @@ def _read_properties(self) -> Generator[tuple, None, None]:
             else:
                 yield (string_map[name_offset], value)
 
-    def load_glyphs(self, code_points: Union[int, str, set]) -> None:
+    def load_glyphs(self, code_points: Union[int, str, Iterable]) -> None:
         # pylint: disable=too-many-statements,too-many-branches,too-many-nested-blocks,too-many-locals
         if isinstance(code_points, int):
             code_points = (code_points,)

adafruit_bitmap_font/ttf.py

@@ -5,9 +5,14 @@
 # pylint: skip-file
 # Remove the above when TTF is actually supported.
 
+try:
+    from typing import Tuple
+    from io import FileIO
+    from displayio import Bitmap
+except ImportError:
+    pass
+
 import struct
-from io import FileIO
-from displayio import Bitmap
 
 # https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6glyf.html
 
@@ -19,7 +24,7 @@ def __init__(self, f: FileIO, bitmap: Bitmap) -> None:
 
         self.characters = {}
 
-        def read(format: str) -> tuple:
+        def read(format: str) -> Tuple:
             s = struct.calcsize(format)
             return struct.unpack_from(format, f.read(s))
 

docs/conf.py

@@ -25,7 +25,7 @@
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["displayio", "fontio"]
+autodoc_mock_imports = ["fontio"]
 
 
 intersphinx_mapping = {

requirements.txt

@@ -3,3 +3,4 @@
 # SPDX-License-Identifier: Unlicense
 
 Adafruit-Blinka
+Adafruit-Blinka-displayio

setup.py

@@ -33,7 +33,10 @@
     # Author details
     author="Adafruit Industries",
     author_email="[email protected]",
-    install_requires=["Adafruit-Blinka"],
+    install_requires=[
+        "Adafruit-Blinka",
+        "Adafruit-Blinka-displayio",
+    ],
     # Choose your license
     license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers