adafruit#56 more linting

Author: matt-land

.gitignore

@@ -45,3 +45,8 @@ _build
 .idea
 .vscode
 *~
+
+# virtualenv
+Pipfile
+Pipfile.lock
+Makefile

.pre-commit-config.yaml

@@ -25,6 +25,7 @@ repos:
         types: [python]
         args:
           - --disable=consider-using-f-string
+          - --min-similarity-lines=14
         exclude: "^(docs/|examples/|tests/|setup.py$)"
     -   id: pylint
         name: pylint (example code)

.pylintrc

@@ -252,8 +252,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=4
-
+min-similarity-lines=14
 
 [BASIC]
 

adafruit_imageload/__init__.py

@@ -23,7 +23,7 @@
         Iterable,
         Union,
     )
-    from io import BufferedReader, FileIO
+    from io import BufferedReader
     from displayio import Palette, Bitmap
     from .displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
@@ -75,9 +75,7 @@ def load(
         if header.startswith(b"P"):
             from . import pnm
 
-            return pnm.load(
-                file, header, bitmap_constructor=bitmap, palette_constructor=palette
-            )
+            return pnm.load(file, header, bitmap=bitmap, palette=palette)
         if header.startswith(b"GIF"):
             from . import gif
 

adafruit_imageload/bmp/indexed.py

@@ -17,9 +17,9 @@
 import sys
 
 try:
-    from typing import Tuple, Optional, Set, List
+    from typing import Tuple, Optional, List
     from displayio import Palette, Bitmap
-    from io import FileIO
+    from io import BufferedReader
     from ..displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
     pass
@@ -35,7 +35,7 @@
 
 
 def load(
-    file: FileIO,
+    file: BufferedReader,
     width: int,
     height: int,
     data_start: int,
@@ -135,7 +135,7 @@ def load(
 
 def decode_rle(
     bitmap: Bitmap,
-    file: FileIO,
+    file: BufferedReader,
     compression: int,
     y_range: Tuple[int, int, int],
     width: int,

adafruit_imageload/displayio_types.py

@@ -12,8 +12,8 @@
 
 """
 try:
-    from typing import Callable, Optional
-    from displayio import Palette, Bitmap, OnDiskBitmap
+    from typing import Callable
+    from displayio import Palette, Bitmap
 
     Palette_Constructor = Callable[[int], Palette]
     Bitmap_Constructor = Callable[[int, int, int], Bitmap]

adafruit_imageload/gif.py

@@ -17,9 +17,10 @@
 import struct
 
 try:
-    from typing import Tuple, Iterator, Optional, List, Iterable, Union, BinaryIO
+    from typing import Tuple, Iterator, Optional, List
     from displayio import Palette, Bitmap
     from .displayio_types import Palette_Constructor, Bitmap_Constructor
+    from io import BufferedReader
 except ImportError:
     pass
 
@@ -28,7 +29,10 @@
 
 
 def load(
-    file: BinaryIO, *, bitmap: Bitmap_Constructor, palette: Palette_Constructor = None
+    file: BufferedReader,
+    *,
+    bitmap: Bitmap_Constructor,
+    palette: Palette_Constructor = None
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """Loads a GIF image from the open ``file``.
 
@@ -42,7 +46,11 @@ def load(
     header = file.read(6)
     if header not in {b"GIF87a", b"GIF89a"}:
         raise ValueError("Not a GIF file")
-    width, height, flags, _, _ = struct.unpack("<HHBBB", file.read(7))
+
+    width, height, flags, _, _ = struct.unpack(  # pylint: disable=no-member
+        "<HHBBB", file.read(7)
+    )
+
     if (flags & 0x80) != 0:
         palette_size = 1 << ((flags & 0x07) + 1)
         palette_obj = palette(palette_size)
@@ -67,9 +75,11 @@ def load(
     return bitmap_obj, palette_obj
 
 
-def _read_frame(file: FileIO, bitmap: Bitmap) -> None:
+def _read_frame(file: BufferedReader, bitmap: Bitmap) -> None:
     """Read a single frame and apply it to the bitmap."""
-    ddx, ddy, width, _, flags = struct.unpack("<HHHHB", file.read(9))
+    ddx, ddy, width, _, flags = struct.unpack(  # pylint: disable=no-member
+        "<HHHHB", file.read(9)
+    )
     if (flags & 0x40) != 0:
         raise NotImplementedError("Interlacing not supported")
     if (flags & 0x80) != 0:
@@ -88,7 +98,7 @@ def _read_frame(file: FileIO, bitmap: Bitmap) -> None:
                 y += 1
 
 
-def _read_blockstream(file: FileIO) -> Iterator[int]:
+def _read_blockstream(file: BufferedReader) -> Iterator[int]:
     """Read a block from a file."""
     while True:
         size = file.read(1)[0]

adafruit_imageload/pnm/__init__.py

@@ -25,10 +25,10 @@
         Iterable,
         Union,
         Callable,
-        BinaryIO,
     )
     from displayio import Palette, Bitmap
     from ..displayio_types import Palette_Constructor, Bitmap_Constructor
+    from io import BufferedReader
 except ImportError:
     pass
 
@@ -37,7 +37,7 @@
 
 
 def load(
-    file: BinaryIO,
+    file: BufferedReader,
     header: bytes,
     *,
     bitmap: Bitmap_Constructor = None,
@@ -110,7 +110,11 @@ def load(
             from . import pbm_binary
 
             return pbm_binary.load(
-                file, pnm_header[0], pnm_header[1], bitmap=bitmap_obj, palette=palette_obj
+                file,
+                pnm_header[0],
+                pnm_header[1],
+                bitmap=bitmap_obj,
+                palette=palette_obj,
             )
 
         next_byte = file.read(1)

adafruit_imageload/pnm/pbm_ascii.py

@@ -18,7 +18,7 @@
 
 try:
     from typing import Tuple, Optional
-    from io import FileIO
+    from io import BufferedReader
     from displayio import Palette, Bitmap
 except ImportError:
     pass
@@ -28,7 +28,11 @@
 
 
 def load(
-    file: FileIO, width: int, height: int, bitmap: Bitmap, palette: Palette = None
+    file: BufferedReader,
+    width: int,
+    height: int,
+    bitmap: Bitmap,
+    palette: Palette = None,
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """
     Load a P1 'PBM' ascii image into the displayio.Bitmap

adafruit_imageload/pnm/pbm_binary.py

@@ -16,8 +16,8 @@
 
 """
 try:
-    from typing import Tuple, Iterator, Optional
-    from io import FileIO
+    from typing import Tuple, Optional, Iterator
+    from io import BufferedReader
     from displayio import Palette, Bitmap
 except ImportError:
     pass
@@ -27,7 +27,11 @@
 
 
 def load(
-    file: FileIO, width: int, height: int, bitmap: Bitmap, palette: Palette = None
+    file: BufferedReader,
+    width: int,
+    height: int,
+    bitmap: Bitmap,
+    palette: Palette = None,
 ) -> Tuple[Bitmap, Optional[Palette]]:
     """
     Load a P4 'PBM' binary image into the Bitmap

adafruit_imageload/pnm/pgm/__init__.py

@@ -17,21 +17,21 @@
 # pylint: disable=import-outside-toplevel
 try:
     from typing import Tuple, Optional, Set, List
-    from io import FileIO
+    from io import BufferedReader
     from displayio import Palette, Bitmap
     from ...displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
     pass
 
 
 def load(
-    file: FileIO,
+    file: BufferedReader,
     magic_number: bytes,
     header: List[int],
     *,
     bitmap: Bitmap_Constructor = None,
     palette: Palette_Constructor = None
-) -> Tuple[Bitmap, Palette]:
+) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     Perform the load of Netpbm greyscale images (P2, P5)
     """

adafruit_imageload/pnm/pgm/ascii.py

@@ -15,21 +15,21 @@
 
 """
 try:
-    from typing import Tuple, Optional, Set
+    from typing import Tuple, Set, Optional
     from displayio import Palette, Bitmap
-    from io import FileIO
+    from io import BufferedReader
     from ...displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
     pass
 
 
 def load(
-    file: FileIO,
+    file: BufferedReader,
     width: int,
     height: int,
     bitmap: Bitmap_Constructor = None,
     palette: Palette_Constructor = None,
-):
+) -> Tuple[Optional[Bitmap], Optional[Palette]]:
     """
     Load a PGM ascii file (P2)
     """

adafruit_imageload/pnm/pgm/binary.py

@@ -16,15 +16,15 @@
 """
 try:
     from typing import Tuple, Optional, Set, List
-    from io import FileIO
+    from io import BufferedReader
     from displayio import Palette, Bitmap
     from ...displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
     pass
 
 
 def load(
-    file: FileIO,
+    file: BufferedReader,
     width: int,
     height: int,
     bitmap: Bitmap_Constructor = None,
@@ -44,7 +44,7 @@ def load(
         palette = build_palette(palette, palette_colors)  # type: Palette
     if bitmap:
         bitmap = bitmap(width, height, len(palette_colors))  # type: Bitmap
-        palette_colors = list(palette_colors)
+        palette_colors = list(palette_colors)  # type: List[int]
         file.seek(data_start)
         for y in range(height):
             data_line = iter(bytes(file.read(width)))
@@ -53,7 +53,9 @@ def load(
     return bitmap, palette
 
 
-def build_palette(palette_class: Palette, palette_colors: Set[int]) -> Palette:
+def build_palette(
+    palette_class: Palette_Constructor, palette_colors: Set[int]
+) -> Palette:
     """
     construct the Palette, and populate it with the set of palette_colors
     """

adafruit_imageload/pnm/ppm_ascii.py

@@ -25,19 +25,17 @@
         Iterator,
         Optional,
         List,
-        Union,
         Set,
-        SupportsIndex,
     )
     from displayio import Palette, Bitmap
-    from io import FileIO
+    from io import BufferedReader
     from ..displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
     pass
 
 
 def load(
-    file: FileIO,
+    file: BufferedReader,
     width: int,
     height: int,
     bitmap: Bitmap_Constructor = None,
@@ -73,7 +71,7 @@ def load(
     return bitmap, palette
 
 
-def read_three_colors(file: FileIO) -> Iterator[bytes]:
+def read_three_colors(file: BufferedReader) -> Iterator[bytes]:
     """
     Generator to read integer values from file, in groups of three.
     Each value can be len 1-3, for values 0 - 255, space padded.

adafruit_imageload/pnm/ppm_binary.py

@@ -16,8 +16,8 @@
 
 """
 try:
-    from typing import Tuple, Iterator, Optional, Union, List, Set
-    from io import FileIO
+    from typing import Tuple, Optional, List, Set
+    from io import BufferedReader
     from displayio import Palette, Bitmap
     from ..displayio_types import Palette_Constructor, Bitmap_Constructor
 except ImportError:
@@ -28,7 +28,7 @@
 
 
 def load(
-    file: FileIO,
+    file: BufferedReader,
     width: int,
     height: int,
     bitmap: Bitmap_Constructor = None,

adafruit_imageload/tilegrid_inflator.py

@@ -17,8 +17,8 @@
 import adafruit_imageload
 
 try:
-    from typing import Tuple, Iterator, Optional, List, Iterable, Union
-    from displayio import Palette, Bitmap, OnDiskBitmap, TileGrid, Colorspace
+    from typing import Tuple, Optional, List, Union
+    from displayio import Palette, Bitmap, OnDiskBitmap, TileGrid
 except ImportError:
     pass
 

mypy.ini

@@ -1,6 +1,9 @@
+# SPDX-FileCopyrightText: 2022 Matt Land
+#
+# SPDX-License-Identifier: Unlicense
 [mypy]
 python_version = 3.9
 disallow_untyped_defs = True
 disable_error_code = no-redef
 # type: ignore[no-redef]
-exclude = (examples|tests|setup.py|docs)
+exclude = (examples|tests|setup.py|docs)