Merge pull request #111 from matt-land/add-types-pycon-2023

initial typing support, mypy passes

Author: FoamyGuy

.gitignore

@@ -1,4 +1,5 @@
 # SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries
+# SPDX-FileCopyrightText: 2023 Matt Land
 #
 # SPDX-License-Identifier: MIT
 
@@ -47,3 +48,5 @@ _build
 .idea
 .vscode
 *~
+
+.mypy_cache/

adafruit_rgb_display/hx8353.py

@@ -1,4 +1,5 @@
 # SPDX-FileCopyrightText: 2017 Radomir Dopieralski for Adafruit Industries
+# SPDX-FileCopyrightText: 2023 Matt Land
 #
 # SPDX-License-Identifier: MIT
 
@@ -8,11 +9,17 @@
 
 A simple driver for the HX8353-based displays.
 
-* Author(s): Radomir Dopieralski, Michael McWethy
+* Author(s): Radomir Dopieralski, Michael McWethy, Matt Land
 """
 from micropython import const
 from adafruit_rgb_display.rgb import DisplaySPI
 
+try:
+    from typing import Optional
+    import digitalio
+    import busio
+except ImportError:
+    pass
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git"
@@ -59,5 +66,14 @@ class HX8353(DisplaySPI):
     _ENCODE_POS = ">HH"
 
     # pylint: disable-msg=useless-super-delegation, too-many-arguments
-    def __init__(self, spi, dc, cs, rst=None, width=128, height=128, rotation=0):
+    def __init__(
+        self,
+        spi: busio.SPI,
+        dc: digitalio.DigitalInOut,
+        cs: digitalio.DigitalInOut,
+        rst: Optional[digitalio.DigitalInOut] = None,
+        width: int = 128,
+        height: int = 128,
+        rotation: int = 0,
+    ) -> None:
         super().__init__(spi, dc, cs, rst, width, height, rotation)

adafruit_rgb_display/hx8357.py

@@ -1,4 +1,5 @@
 # SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries
+# SPDX-FileCopyrightText: 2023 Matt Land
 #
 # SPDX-License-Identifier: MIT
 
@@ -8,11 +9,18 @@
 
 A simple driver for the HX8357-based displays.
 
-* Author(s): Melissa LeBlanc-Williams
+* Author(s): Melissa LeBlanc-Williams, Matt Land
 """
 from micropython import const
 from adafruit_rgb_display.rgb import DisplaySPI
 
+try:
+    from typing import Optional
+    import digitalio
+    import busio
+except ImportError:
+    pass
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git"
 
@@ -94,16 +102,16 @@ class HX8357(DisplaySPI):
     # pylint: disable-msg=useless-super-delegation, too-many-arguments
     def __init__(
         self,
-        spi,
-        dc,
-        cs,
-        rst=None,
-        width=480,
-        height=320,
-        baudrate=16000000,
-        polarity=0,
-        phase=0,
-        rotation=0,
+        spi: busio.SPI,
+        dc: digitalio.DigitalInOut,
+        cs: digitalio.DigitalInOut,
+        rst: Optional[digitalio.DigitalInOut] = None,
+        width: int = 480,
+        height: int = 320,
+        baudrate: int = 16000000,
+        polarity: int = 0,
+        phase: int = 0,
+        rotation: int = 0,
     ):
         super().__init__(
             spi,

adafruit_rgb_display/ili9341.py

@@ -1,4 +1,5 @@
 # SPDX-FileCopyrightText: 2017 Radomir Dopieralski for Adafruit Industries
+# SPDX-FileCopyrightText: 2023 Matt Land
 #
 # SPDX-License-Identifier: MIT
 
@@ -8,12 +9,19 @@
 
 A simple driver for the ILI9341/ILI9340-based displays.
 
-* Author(s): Radomir Dopieralski, Michael McWethy
+* Author(s): Radomir Dopieralski, Michael McWethy, Matt Land
 """
 import struct
 
 from adafruit_rgb_display.rgb import DisplaySPI
 
+try:
+    from typing import Optional
+    import digitalio
+    import busio
+except ImportError:
+    pass
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git"
 
@@ -74,16 +82,16 @@ class ILI9341(DisplaySPI):
     # pylint: disable-msg=too-many-arguments
     def __init__(
         self,
-        spi,
-        dc,
-        cs,
-        rst=None,
-        width=240,
-        height=320,
-        baudrate=16000000,
-        polarity=0,
-        phase=0,
-        rotation=0,
+        spi: busio.SPI,
+        dc: digitalio.DigitalInOut,
+        cs: digitalio.DigitalInOut,
+        rst: Optional[digitalio.DigitalInOut] = None,
+        width: int = 240,
+        height: int = 320,
+        baudrate: int = 16000000,
+        polarity: int = 0,
+        phase: int = 0,
+        rotation: int = 0,
     ):
         super().__init__(
             spi,
@@ -101,7 +109,9 @@ def __init__(
 
     # pylint: enable-msg=too-many-arguments
 
-    def scroll(self, dy=None):  # pylint: disable-msg=invalid-name
+    def scroll(
+        self, dy: Optional[int] = None  # pylint: disable-msg=invalid-name
+    ) -> Optional[int]:
         """Scroll the display by delta y"""
         if dy is None:
             return self._scroll