Merge pull request #17 from adafruit/pylint-update

Ran black, updated to pylint 2.x

Author: kattni

.github/workflows/build.yml

@@ -40,7 +40,7 @@ jobs:
         source actions-ci/install.sh
     - name: Pip install pylint, black, & Sphinx
       run: |
-        pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme
+        pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme
     - name: Library version
       run: git describe --dirty --always --tags
     - name: PyLint

.pylintrc

@@ -119,7 +119,8 @@ spelling-store-unknown-words=no
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+# notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [TYPECHECK]

adafruit_ina219.py

@@ -58,59 +58,68 @@
 # pylint: disable=too-few-public-methods
 
 # Config Register (R/W)
-_REG_CONFIG                 = const(0x00)
+_REG_CONFIG = const(0x00)
+
 
 class BusVoltageRange:
     """Constants for ``bus_voltage_range``"""
-    RANGE_16V               = 0x00      # set bus voltage range to 16V
-    RANGE_32V               = 0x01      # set bus voltage range to 32V (default)
+
+    RANGE_16V = 0x00  # set bus voltage range to 16V
+    RANGE_32V = 0x01  # set bus voltage range to 32V (default)
+
 
 class Gain:
     """Constants for ``gain``"""
-    DIV_1_40MV              = 0x00      # shunt prog. gain set to  1, 40 mV range
-    DIV_2_80MV              = 0x01      # shunt prog. gain set to /2, 80 mV range
-    DIV_4_160MV             = 0x02      # shunt prog. gain set to /4, 160 mV range
-    DIV_8_320MV             = 0x03      # shunt prog. gain set to /8, 320 mV range
+
+    DIV_1_40MV = 0x00  # shunt prog. gain set to  1, 40 mV range
+    DIV_2_80MV = 0x01  # shunt prog. gain set to /2, 80 mV range
+    DIV_4_160MV = 0x02  # shunt prog. gain set to /4, 160 mV range
+    DIV_8_320MV = 0x03  # shunt prog. gain set to /8, 320 mV range
+
 
 class ADCResolution:
     """Constants for ``bus_adc_resolution`` or ``shunt_adc_resolution``"""
-    ADCRES_9BIT_1S          = 0x00      #  9bit,   1 sample,     84us
-    ADCRES_10BIT_1S         = 0x01      # 10bit,   1 sample,    148us
-    ADCRES_11BIT_1S         = 0x02      # 11 bit,  1 sample,    276us
-    ADCRES_12BIT_1S         = 0x03      # 12 bit,  1 sample,    532us
-    ADCRES_12BIT_2S         = 0x09      # 12 bit,  2 samples,  1.06ms
-    ADCRES_12BIT_4S         = 0x0A      # 12 bit,  4 samples,  2.13ms
-    ADCRES_12BIT_8S         = 0x0B      # 12bit,   8 samples,  4.26ms
-    ADCRES_12BIT_16S        = 0x0C      # 12bit,  16 samples,  8.51ms
-    ADCRES_12BIT_32S        = 0x0D      # 12bit,  32 samples, 17.02ms
-    ADCRES_12BIT_64S        = 0x0E      # 12bit,  64 samples, 34.05ms
-    ADCRES_12BIT_128S       = 0x0F      # 12bit, 128 samples, 68.10ms
+
+    ADCRES_9BIT_1S = 0x00  #  9bit,   1 sample,     84us
+    ADCRES_10BIT_1S = 0x01  # 10bit,   1 sample,    148us
+    ADCRES_11BIT_1S = 0x02  # 11 bit,  1 sample,    276us
+    ADCRES_12BIT_1S = 0x03  # 12 bit,  1 sample,    532us
+    ADCRES_12BIT_2S = 0x09  # 12 bit,  2 samples,  1.06ms
+    ADCRES_12BIT_4S = 0x0A  # 12 bit,  4 samples,  2.13ms
+    ADCRES_12BIT_8S = 0x0B  # 12bit,   8 samples,  4.26ms
+    ADCRES_12BIT_16S = 0x0C  # 12bit,  16 samples,  8.51ms
+    ADCRES_12BIT_32S = 0x0D  # 12bit,  32 samples, 17.02ms
+    ADCRES_12BIT_64S = 0x0E  # 12bit,  64 samples, 34.05ms
+    ADCRES_12BIT_128S = 0x0F  # 12bit, 128 samples, 68.10ms
+
 
 class Mode:
     """Constants for ``mode``"""
-    POWERDOW                = 0x00      # power down
-    SVOLT_TRIGGERED         = 0x01      # shunt voltage triggered
-    BVOLT_TRIGGERED         = 0x02      # bus voltage triggered
-    SANDBVOLT_TRIGGERED     = 0x03      # shunt and bus voltage triggered
-    ADCOFF                  = 0x04      # ADC off
-    SVOLT_CONTINUOUS        = 0x05      # shunt voltage continuous
-    BVOLT_CONTINUOUS        = 0x06      # bus voltage continuous
-    SANDBVOLT_CONTINUOUS    = 0x07      # shunt and bus voltage continuous
+
+    POWERDOW = 0x00  # power down
+    SVOLT_TRIGGERED = 0x01  # shunt voltage triggered
+    BVOLT_TRIGGERED = 0x02  # bus voltage triggered
+    SANDBVOLT_TRIGGERED = 0x03  # shunt and bus voltage triggered
+    ADCOFF = 0x04  # ADC off
+    SVOLT_CONTINUOUS = 0x05  # shunt voltage continuous
+    BVOLT_CONTINUOUS = 0x06  # bus voltage continuous
+    SANDBVOLT_CONTINUOUS = 0x07  # shunt and bus voltage continuous
+
 
 # SHUNT VOLTAGE REGISTER (R)
-_REG_SHUNTVOLTAGE           = const(0x01)
+_REG_SHUNTVOLTAGE = const(0x01)
 
 # BUS VOLTAGE REGISTER (R)
-_REG_BUSVOLTAGE             = const(0x02)
+_REG_BUSVOLTAGE = const(0x02)
 
 # POWER REGISTER (R)
-_REG_POWER                  = const(0x03)
+_REG_POWER = const(0x03)
 
 # CURRENT REGISTER (R)
-_REG_CURRENT                = const(0x04)
+_REG_CURRENT = const(0x04)
 
 # CALIBRATION REGISTER (R/W)
-_REG_CALIBRATION            = const(0x05)
+_REG_CALIBRATION = const(0x05)
 # pylint: enable=too-few-public-methods
 
 
@@ -119,6 +128,7 @@ def _to_signed(num):
         num -= 0x10000
     return num
 
+
 class INA219:
     """Driver for the INA219 current sensor"""
 
@@ -164,36 +174,38 @@ def __init__(self, i2c_bus, addr=0x40):
         self.set_calibration_32V_2A()
 
     # config register break-up
-    reset                   = RWBits( 1, _REG_CONFIG, 15, 2, False)
-    bus_voltage_range       = RWBits( 1, _REG_CONFIG, 13, 2, False)
-    gain                    = RWBits( 2, _REG_CONFIG, 11, 2, False)
-    bus_adc_resolution      = RWBits( 4, _REG_CONFIG,  7, 2, False)
-    shunt_adc_resolution    = RWBits( 4, _REG_CONFIG,  3, 2, False)
-    mode                    = RWBits( 3, _REG_CONFIG,  0, 2, False)
+    reset = RWBits(1, _REG_CONFIG, 15, 2, False)
+    bus_voltage_range = RWBits(1, _REG_CONFIG, 13, 2, False)
+    gain = RWBits(2, _REG_CONFIG, 11, 2, False)
+    bus_adc_resolution = RWBits(4, _REG_CONFIG, 7, 2, False)
+    shunt_adc_resolution = RWBits(4, _REG_CONFIG, 3, 2, False)
+    mode = RWBits(3, _REG_CONFIG, 0, 2, False)
 
     # shunt voltage register
-    raw_shunt_voltage       = ROUnaryStruct(_REG_SHUNTVOLTAGE, ">h")
+    raw_shunt_voltage = ROUnaryStruct(_REG_SHUNTVOLTAGE, ">h")
 
-    #bus voltage register
-    raw_bus_voltage         = ROBits( 13, _REG_BUSVOLTAGE, 3, 2, False)
-    conversion_ready        = ROBit(      _REG_BUSVOLTAGE, 1, 2, False)
-    overflow                = ROBit(      _REG_BUSVOLTAGE, 0, 2, False)
+    # bus voltage register
+    raw_bus_voltage = ROBits(13, _REG_BUSVOLTAGE, 3, 2, False)
+    conversion_ready = ROBit(_REG_BUSVOLTAGE, 1, 2, False)
+    overflow = ROBit(_REG_BUSVOLTAGE, 0, 2, False)
 
     # power and current registers
-    raw_power               = ROUnaryStruct(_REG_POWER, ">H")
-    raw_current             = ROUnaryStruct(_REG_CURRENT, ">h")
+    raw_power = ROUnaryStruct(_REG_POWER, ">H")
+    raw_current = ROUnaryStruct(_REG_CURRENT, ">h")
 
     # calibration register
-    _raw_calibration        = UnaryStruct(_REG_CALIBRATION, ">H")
+    _raw_calibration = UnaryStruct(_REG_CALIBRATION, ">H")
 
     @property
     def calibration(self):
         """Calibration register (cached value)"""
-        return self._cal_value # return cached value
+        return self._cal_value  # return cached value
 
     @calibration.setter
     def calibration(self, cal_value):
-        self._cal_value = cal_value # value is cached for ``current`` and ``power`` properties
+        self._cal_value = (
+            cal_value  # value is cached for ``current`` and ``power`` properties
+        )
         self._raw_calibration = self._cal_value
 
     @property
@@ -231,7 +243,7 @@ def power(self):
         # Now we can safely read the CURRENT register!
         return self.raw_power * self._power_lsb
 
-    def set_calibration_32V_2A(self): # pylint: disable=invalid-name
+    def set_calibration_32V_2A(self):  # pylint: disable=invalid-name
         """Configures to INA219 to be able to measure up to 32V and 2A of current. Counter
            overflow occurs at 3.2A.
 
@@ -264,7 +276,7 @@ def set_calibration_32V_2A(self): # pylint: disable=invalid-name
         # 4. Choose an LSB between the min and max values
         #    (Preferrably a roundish number close to MinLSB)
         # CurrentLSB = 0.0001 (100uA per bit)
-        self._current_lsb = .1  # Current LSB = 100uA per bit
+        self._current_lsb = 0.1  # Current LSB = 100uA per bit
 
         # 5. Compute the calibration register
         # Cal = trunc (0.04096 / (Current_LSB * RSHUNT))
@@ -275,7 +287,7 @@ def set_calibration_32V_2A(self): # pylint: disable=invalid-name
         # 6. Calculate the power LSB
         # PowerLSB = 20 * CurrentLSB
         # PowerLSB = 0.002 (2mW per bit)
-        self._power_lsb = .002  # Power LSB = 2mW per bit
+        self._power_lsb = 0.002  # Power LSB = 2mW per bit
 
         # 7. Compute the maximum current and shunt voltage values before overflow
         #
@@ -312,7 +324,7 @@ def set_calibration_32V_2A(self): # pylint: disable=invalid-name
         self.shunt_adc_resolution = ADCResolution.ADCRES_12BIT_1S
         self.mode = Mode.SANDBVOLT_CONTINUOUS
 
-    def set_calibration_32V_1A(self): # pylint: disable=invalid-name
+    def set_calibration_32V_1A(self):  # pylint: disable=invalid-name
         """Configures to INA219 to be able to measure up to 32V and 1A of current. Counter overflow
            occurs at 1.3A.
 
@@ -344,7 +356,7 @@ def set_calibration_32V_1A(self): # pylint: disable=invalid-name
         # 4. Choose an LSB between the min and max values
         #    (Preferrably a roundish number close to MinLSB)
         # CurrentLSB = 0.0000400 (40uA per bit)
-        self._current_lsb = 0.04 # In milliamps
+        self._current_lsb = 0.04  # In milliamps
 
         # 5. Compute the calibration register
         # Cal = trunc (0.04096 / (Current_LSB * RSHUNT))
@@ -394,7 +406,7 @@ def set_calibration_32V_1A(self): # pylint: disable=invalid-name
         self.shunt_adc_resolution = ADCResolution.ADCRES_12BIT_1S
         self.mode = Mode.SANDBVOLT_CONTINUOUS
 
-    def set_calibration_16V_400mA(self): # pylint: disable=invalid-name
+    def set_calibration_16V_400mA(self):  # pylint: disable=invalid-name
         """Configures to INA219 to be able to measure up to 16V and 400mA of current. Counter
            overflow occurs at 1.6A.
 
@@ -477,7 +489,7 @@ def set_calibration_16V_400mA(self): # pylint: disable=invalid-name
         self.shunt_adc_resolution = ADCResolution.ADCRES_12BIT_1S
         self.mode = Mode.SANDBVOLT_CONTINUOUS
 
-    def set_calibration_16V_5A(self): # pylint: disable=invalid-name
+    def set_calibration_16V_5A(self):  # pylint: disable=invalid-name
         """Configures to INA219 to be able to measure up to 16V and 5000mA of current. Counter
            overflow occurs at 8.0A.