add type notations, docstrings

Author: rsbohn

adafruit_bme280/advanced.py

@@ -142,7 +142,7 @@ class Adafruit_BME280_Advanced(Adafruit_BME280):
     """
 
     # pylint: disable=too-many-instance-attributes
-    def __init__(self, proxy) -> None:
+    def __init__(self, proxy: typing.Union[I2C_Impl, SPI_Impl]) -> None:
         """Check the BME280 was found, read the coefficients and enable the sensor"""
         self._overscan_humidity = OVERSCAN_X1
         self._overscan_temperature = OVERSCAN_X1

adafruit_bme280/protocol.py

@@ -6,33 +6,43 @@
 from busio import I2C, SPI
 from digitalio import DigitalInOut
 
+
 class I2C_Impl:
+    "Protocol implementation for the I2C bus."
+
     def __init__(self, i2c: I2C, address: int) -> None:
         from adafruit_bus_device import (  # pylint: disable=import-outside-toplevel
             i2c_device,
         )
 
         self._i2c = i2c_device.I2CDevice(i2c, address)
-    
+
     def read_register(self, register: int, length: int) -> bytearray:
+        "Read from the device register."
         with self._i2c as i2c:
             i2c.write(bytes([register & 0xFF]))
             result = bytearray(length)
             i2c.readinto(result)
             return result
+
     def write_register_byte(self, register: int, value: int) -> None:
+        "Write to the device register."
         with self._i2c as i2c:
             i2c.write(bytes([register & 0xFF, value & 0xFF]))
 
+
 class SPI_Impl:
+    "Protocol implemenation for the SPI bus."
+
     def __init__(self, spi: SPI, cs: DigitalInOut, baudrate: int = 100000) -> None:
         from adafruit_bus_device import (  # pylint: disable=import-outside-toplevel
             spi_device,
         )
 
         self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate)
 
-    def _read_register(self, register: int, length: int) -> bytearray:
+    def read_register(self, register: int, length: int) -> bytearray:
+        "Read from the device register."
         register = (register | 0x80) & 0xFF  # Read single, bit 7 high.
         with self._spi as spi:
             spi.write(bytearray([register]))  # pylint: disable=no-member
@@ -41,7 +51,8 @@ def _read_register(self, register: int, length: int) -> bytearray:
             # print("$%02X => %s" % (register, [hex(i) for i in result]))
             return result
 
-    def _write_register_byte(self, register: int, value: int) -> None:
+    def write_register_byte(self, register: int, value: int) -> None:
+        "Write value to the device register."
         register &= 0x7F  # Write, bit 7 low.
         with self._spi as spi:
             spi.write(bytes([register, value & 0xFF]))  # pylint: disable=no-member