Merge remote-tracking branch 'origin/fix-annotations-ssd1675.py' into fix-annotations-epd.py

Author: sdomoszlai13

adafruit_epd/ssd1675.py

@@ -14,6 +14,15 @@
 import adafruit_framebuf
 from adafruit_epd.epd import Adafruit_EPD
 
+try:
+    """Needed for type annotations"""
+    from typing import Union, Any
+    from busio import SPI
+    from digitalio import DigitalInOut
+
+except ImportError:
+    pass
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EPD.git"
 
@@ -51,7 +60,16 @@ class Adafruit_SSD1675(Adafruit_EPD):
 
     # pylint: disable=too-many-arguments
     def __init__(
-        self, width, height, spi, *, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin
+        self,
+        width: int,
+        height: int,
+        spi: SPI,
+        *,
+        cs_pin: DigitalInOut,
+        dc_pin: DigitalInOut,
+        sramcs_pin: DigitalInOut,
+        rst_pin: DigitalInOut,
+        busy_pin: DigitalInOut
     ):
         super().__init__(
             width, height, spi, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin
@@ -89,13 +107,13 @@ def __init__(
         self.set_color_buffer(0, True)
         # pylint: enable=too-many-arguments
 
-    def begin(self, reset=True):
+    def begin(self, reset: bool = True) -> None:
         """Begin communication with the display and set basic settings"""
         if reset:
             self.hardware_reset()
         self.power_down()
 
-    def busy_wait(self):
+    def busy_wait(self) -> None:
         """Wait for display to be done with current task, either by polling the
         busy pin, or pausing"""
         if self._busy:
@@ -104,7 +122,7 @@ def busy_wait(self):
         else:
             time.sleep(0.5)
 
-    def power_up(self):
+    def power_up(self) -> None:
         """Power up the display in preparation for writing RAM and updating"""
         self.hardware_reset()
         time.sleep(0.1)
@@ -147,20 +165,20 @@ def power_up(self):
 
         self.busy_wait()
 
-    def power_down(self):
+    def power_down(self) -> None:
         """Power down the display - required when not actively displaying!"""
         self.command(_SSD1675_DEEP_SLEEP, bytearray([0x01]))
         time.sleep(0.1)
 
-    def update(self):
+    def update(self) -> None:
         """Update the display from internal memory"""
         self.command(_SSD1675_DISP_CTRL2, bytearray([0xC7]))
         self.command(_SSD1675_MASTER_ACTIVATE)
         self.busy_wait()
         if not self._busy:
             time.sleep(3)  # wait 3 seconds
 
-    def write_ram(self, index):
+    def write_ram(self, index: Union[0, 1]) -> Any:
         """Send the one byte command for starting the RAM write process. Returns
         the byte read at the same time over SPI. index is the RAM buffer, can be
         0 or 1 for tri-color displays."""
@@ -170,7 +188,9 @@ def write_ram(self, index):
             return self.command(_SSD1675_WRITE_RAM2, end=False)
         raise RuntimeError("RAM index must be 0 or 1")
 
-    def set_ram_address(self, x, y):  # pylint: disable=unused-argument, no-self-use
+    def set_ram_address(
+        self, x: int, y: int
+    ) -> None:  # pylint: disable=unused-argument, no-self-use
         """Set the RAM address location, not used on this chipset but required by
         the superclass"""
         self.command(_SSD1675_SET_RAMXCOUNT, bytearray([x]))

adafruit_epd/ssd1680.py

@@ -14,6 +14,15 @@
 import adafruit_framebuf
 from adafruit_epd.epd import Adafruit_EPD
 
+try:
+    """Needed for type annotations"""
+    from typing import Union, Any
+    from busio import SPI
+    from digitalio import DigitalInOut
+
+except ImportError:
+    pass
+
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EPD.git"
 
@@ -72,8 +81,17 @@ class Adafruit_SSD1680(Adafruit_EPD):
 
     # pylint: disable=too-many-arguments
     def __init__(
-        self, width, height, spi, *, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin
-    ):
+        self,
+        width: int,
+        height: int,
+        spi: SPI,
+        *,
+        cs_pin: DigitalInOut,
+        dc_pin: DigitalInOut,
+        sramcs_pin: DigitalInOut,
+        rst_pin: DigitalInOut,
+        busy_pin: DigitalInOut
+    ) -> None:
         super().__init__(
             width, height, spi, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin
         )
@@ -110,13 +128,13 @@ def __init__(
         self.set_color_buffer(1, False)
         # pylint: enable=too-many-arguments
 
-    def begin(self, reset=True):
+    def begin(self, reset: bool = True) -> None:
         """Begin communication with the display and set basic settings"""
         if reset:
             self.hardware_reset()
         self.power_down()
 
-    def busy_wait(self):
+    def busy_wait(self) -> None:
         """Wait for display to be done with current task, either by polling the
         busy pin, or pausing"""
         if self._busy:
@@ -125,7 +143,7 @@ def busy_wait(self):
         else:
             time.sleep(0.5)
 
-    def power_up(self):
+    def power_up(self) -> None:
         """Power up the display in preparation for writing RAM and updating"""
         self.hardware_reset()
         self.busy_wait()
@@ -160,20 +178,20 @@ def power_up(self):
         self.command(_SSD1680_SET_RAMYCOUNT, bytearray([self._height - 1, 0]))
         self.busy_wait()
 
-    def power_down(self):
+    def power_down(self) -> None:
         """Power down the display - required when not actively displaying!"""
         self.command(_SSD1680_DEEP_SLEEP, bytearray([0x01]))
         time.sleep(0.1)
 
-    def update(self):
+    def update(self) -> None:
         """Update the display from internal memory"""
         self.command(_SSD1680_DISP_CTRL2, bytearray([0xF4]))
         self.command(_SSD1680_MASTER_ACTIVATE)
         self.busy_wait()
         if not self._busy:
             time.sleep(3)  # wait 3 seconds
 
-    def write_ram(self, index):
+    def write_ram(self, index: Union[0, 1]) -> Any:
         """Send the one byte command for starting the RAM write process. Returns
         the byte read at the same time over SPI. index is the RAM buffer, can be
         0 or 1 for tri-color displays."""
@@ -183,7 +201,9 @@ def write_ram(self, index):
             return self.command(_SSD1680_WRITE_REDRAM, end=False)
         raise RuntimeError("RAM index must be 0 or 1")
 
-    def set_ram_address(self, x, y):  # pylint: disable=unused-argument, no-self-use
+    def set_ram_address(
+        self, x: int, y: int
+    ) -> None:  # pylint: disable=unused-argument, no-self-use
         """Set the RAM address location, not used on this chipset but required by
         the superclass"""
         # Set RAM X address counter