adafruit#56 finish, rename types

Author: matt-land

adafruit_imageload/__init__.py

@@ -25,7 +25,7 @@
     )
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from .displayio_types import Palette_Constructor, Bitmap_Constructor
+    from .displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -36,8 +36,8 @@
 def load(
     file_or_filename: Union[str, BufferedReader],
     *,
-    bitmap: Optional[Bitmap_Constructor] = None,
-    palette: Optional[Palette_Constructor] = None
+    bitmap: Optional[BitmapConstructor] = None,
+    palette: Optional[PaletteConstructor] = None
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """Load pixel values (indices or colors) into a bitmap and colors into a palette.
 

adafruit_imageload/bmp/__init__.py

@@ -18,7 +18,7 @@
     from typing import Tuple, Optional, Set, List
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ..displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ..displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -29,8 +29,8 @@
 def load(
     file: BufferedReader,
     *,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """Loads a bmp image from the open ``file``.
 

adafruit_imageload/bmp/indexed.py

@@ -20,7 +20,7 @@
     from typing import Tuple, Optional
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ..displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ..displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -43,8 +43,8 @@ def load(
     color_depth: int,
     compression: int,
     *,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None,
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None,
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """Loads indexed bitmap data into bitmap and palette objects.
 

adafruit_imageload/displayio_types.py

@@ -5,8 +5,10 @@
 `adafruit_imageload.displayio_types`
 ====================================================
 
-This is a utility file for typing, to keep compound function arguments that are used in many places
-in a single definition.
+This is a utility file for type aliases.
+https://mypy.readthedocs.io/en/stable/kinds_of_types.html#type-aliases
+Type aliases contain compound declarations (used many places in the project) with a single
+definition readable by humans.
 
 * Author(s): Matt Land
 
@@ -15,8 +17,8 @@
     from typing import Callable
     from displayio import Palette, Bitmap
 
-    Palette_Constructor = Callable[[int], Palette]
-    Bitmap_Constructor = Callable[[int, int, int], Bitmap]
+    PaletteConstructor = Callable[[int], Palette]
+    BitmapConstructor = Callable[[int, int, int], Bitmap]
 except ImportError:
     pass
 

adafruit_imageload/gif.py

@@ -20,7 +20,7 @@
     from typing import Tuple, Iterator, Optional, List
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from .displayio_types import Palette_Constructor, Bitmap_Constructor
+    from .displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -31,8 +31,8 @@
 def load(
     file: BufferedReader,
     *,
-    bitmap: Bitmap_Constructor,
-    palette: Palette_Constructor = None
+    bitmap: BitmapConstructor,
+    palette: PaletteConstructor = None
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """Loads a GIF image from the open ``file``.
 

adafruit_imageload/pnm/__init__.py

@@ -28,7 +28,7 @@
     )
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ..displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ..displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -40,8 +40,8 @@ def load(
     file: BufferedReader,
     header: bytes,
     *,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None
 ) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     Scan for netpbm format info, skip over comments, and delegate to a submodule
@@ -92,19 +92,19 @@ def load(
                 )
 
         if len(pnm_header) == 2 and magic_number in [b"P1", b"P4"]:
-            bitmap_obj = bitmap(pnm_header[0], pnm_header[1], 1)
+            bitmap = bitmap(pnm_header[0], pnm_header[1], 1)  # type: Bitmap
             if palette:
-                palette_obj = palette(1)
-                palette_obj[0] = b"\xFF\xFF\xFF"
+                palette = palette(1)  # type: Palette
+                palette[0] = b"\xFF\xFF\xFF"
             if magic_number.startswith(b"P1"):
                 from . import pbm_ascii
 
                 return pbm_ascii.load(
                     file,
                     pnm_header[0],
                     pnm_header[1],
-                    bitmap=bitmap_obj,
-                    palette=palette_obj,
+                    bitmap=bitmap,
+                    palette=palette,
                 )
 
             from . import pbm_binary
@@ -113,8 +113,8 @@ def load(
                 file,
                 pnm_header[0],
                 pnm_header[1],
-                bitmap=bitmap_obj,
-                palette=palette_obj,
+                bitmap=bitmap,
+                palette=palette,
             )
 
         next_byte = file.read(1)

adafruit_imageload/pnm/pgm/__init__.py

@@ -19,7 +19,7 @@
     from typing import Tuple, Optional, Set, List
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ...displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ...displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -29,8 +29,8 @@ def load(
     magic_number: bytes,
     header: List[int],
     *,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None
 ) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     Perform the load of Netpbm greyscale images (P2, P5)

adafruit_imageload/pnm/pgm/ascii.py

@@ -18,7 +18,7 @@
     from typing import Tuple, Set, Optional
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ...displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ...displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -27,8 +27,8 @@ def load(
     file: BufferedReader,
     width: int,
     height: int,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None,
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None,
 ) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     Load a PGM ascii file (P2)
@@ -66,7 +66,7 @@ def load(
 
 
 def build_palette(
-    palette_class: Palette_Constructor, palette_colors: Set[int]
+    palette_class: PaletteConstructor, palette_colors: Set[int]
 ) -> Palette:  # pylint: disable=duplicate-code
     """
     construct the Palette, and populate it with the set of palette_colors

adafruit_imageload/pnm/pgm/binary.py

@@ -18,7 +18,7 @@
     from typing import Tuple, Optional, Set, List
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ...displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ...displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -27,8 +27,8 @@ def load(
     file: BufferedReader,
     width: int,
     height: int,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None,
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None,
 ) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     Load a P5 format file (binary), handle PGM (greyscale)
@@ -54,7 +54,7 @@ def load(
 
 
 def build_palette(
-    palette_class: Palette_Constructor, palette_colors: Set[int]
+    palette_class: PaletteConstructor, palette_colors: Set[int]
 ) -> Palette:
     """
     construct the Palette, and populate it with the set of palette_colors

adafruit_imageload/pnm/ppm_ascii.py

@@ -29,7 +29,7 @@
     )
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ..displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ..displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -38,8 +38,8 @@ def load(
     file: BufferedReader,
     width: int,
     height: int,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None,
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None,
 ) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     :param stream file: infile with the position set at start of data

adafruit_imageload/pnm/ppm_binary.py

@@ -19,7 +19,7 @@
     from typing import Tuple, Optional, List, Set
     from io import BufferedReader
     from displayio import Palette, Bitmap
-    from ..displayio_types import Palette_Constructor, Bitmap_Constructor
+    from ..displayio_types import PaletteConstructor, BitmapConstructor
 except ImportError:
     pass
 
@@ -31,8 +31,8 @@ def load(
     file: BufferedReader,
     width: int,
     height: int,
-    bitmap: Bitmap_Constructor = None,
-    palette: Palette_Constructor = None,
+    bitmap: BitmapConstructor = None,
+    palette: PaletteConstructor = None,
 ) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """Load pixel values (indices or colors) into a bitmap and for a binary
     ppm, return None for pallet."""

docs/developing.rst

@@ -115,3 +115,18 @@ For example, the Bitmap coordinate ``[0,0]`` has the value (integer) ``5``.
 
 
 This corresponds to the the Palette object's, ``[5]`` which is ``b'\x00\x00\xff\x00'``. This is a byte string that represents a color.
+
+====================
+Mypy & type checking
+====================
+
+Mypy was tested with version 0.950 and the mypy.ini in project root.
+Since checks are not currently not passing, it is not installed as a commit hook.
+
+Setup: In your virtual environment, run:
+
+    pip3 install mypy==0.050
+
+Developing: To manually run checks, run:
+
+    mypy .