Merge pull request #21 from adafruit/pylint-update

Ran black, updated to pylint 2.x

.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,7 @@ 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
 
 
@@ -301,7 +301,7 @@ function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
 
 # Good variable names which should always be accepted, separated by a comma
 # good-names=i,j,k,ex,Run,_
-good-names=r,g,b,i,j,k,n,ex,Run,_
+good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
 
 # Include a hint for the correct naming format with invalid-name
 include-naming-hint=no
@@ -423,7 +423,7 @@ max-returns=6
 max-statements=50
 
 # Minimum number of public methods for a class (see R0903).
-min-public-methods=2
+min-public-methods=1
 
 
 [EXCEPTIONS]

adafruit_lsm9ds1.py

@@ -50,6 +50,7 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS1.git"
 
 import time
+
 try:
     import struct
 except ImportError:
@@ -61,79 +62,79 @@
 
 # Internal constants and register values:
 # pylint: disable=bad-whitespace
-_LSM9DS1_ADDRESS_ACCELGYRO       = const(0x6B)
-_LSM9DS1_ADDRESS_MAG             = const(0x1E)
-_LSM9DS1_XG_ID                   = const(0b01101000)
-_LSM9DS1_MAG_ID                  = const(0b00111101)
-_LSM9DS1_ACCEL_MG_LSB_2G         = 0.061
-_LSM9DS1_ACCEL_MG_LSB_4G         = 0.122
-_LSM9DS1_ACCEL_MG_LSB_8G         = 0.244
-_LSM9DS1_ACCEL_MG_LSB_16G        = 0.732
-_LSM9DS1_MAG_MGAUSS_4GAUSS       = 0.14
-_LSM9DS1_MAG_MGAUSS_8GAUSS       = 0.29
-_LSM9DS1_MAG_MGAUSS_12GAUSS      = 0.43
-_LSM9DS1_MAG_MGAUSS_16GAUSS      = 0.58
-_LSM9DS1_GYRO_DPS_DIGIT_245DPS   = 0.00875
-_LSM9DS1_GYRO_DPS_DIGIT_500DPS   = 0.01750
-_LSM9DS1_GYRO_DPS_DIGIT_2000DPS  = 0.07000
-_LSM9DS1_TEMP_LSB_DEGREE_CELSIUS = 8 # 1°C = 8, 25° = 200, etc.
-_LSM9DS1_REGISTER_WHO_AM_I_XG    = const(0x0F)
-_LSM9DS1_REGISTER_CTRL_REG1_G    = const(0x10)
-_LSM9DS1_REGISTER_CTRL_REG2_G    = const(0x11)
-_LSM9DS1_REGISTER_CTRL_REG3_G    = const(0x12)
-_LSM9DS1_REGISTER_TEMP_OUT_L     = const(0x15)
-_LSM9DS1_REGISTER_TEMP_OUT_H     = const(0x16)
-_LSM9DS1_REGISTER_STATUS_REG     = const(0x17)
-_LSM9DS1_REGISTER_OUT_X_L_G      = const(0x18)
-_LSM9DS1_REGISTER_OUT_X_H_G      = const(0x19)
-_LSM9DS1_REGISTER_OUT_Y_L_G      = const(0x1A)
-_LSM9DS1_REGISTER_OUT_Y_H_G      = const(0x1B)
-_LSM9DS1_REGISTER_OUT_Z_L_G      = const(0x1C)
-_LSM9DS1_REGISTER_OUT_Z_H_G      = const(0x1D)
-_LSM9DS1_REGISTER_CTRL_REG4      = const(0x1E)
-_LSM9DS1_REGISTER_CTRL_REG5_XL   = const(0x1F)
-_LSM9DS1_REGISTER_CTRL_REG6_XL   = const(0x20)
-_LSM9DS1_REGISTER_CTRL_REG7_XL   = const(0x21)
-_LSM9DS1_REGISTER_CTRL_REG8      = const(0x22)
-_LSM9DS1_REGISTER_CTRL_REG9      = const(0x23)
-_LSM9DS1_REGISTER_CTRL_REG10     = const(0x24)
-_LSM9DS1_REGISTER_OUT_X_L_XL     = const(0x28)
-_LSM9DS1_REGISTER_OUT_X_H_XL     = const(0x29)
-_LSM9DS1_REGISTER_OUT_Y_L_XL     = const(0x2A)
-_LSM9DS1_REGISTER_OUT_Y_H_XL     = const(0x2B)
-_LSM9DS1_REGISTER_OUT_Z_L_XL     = const(0x2C)
-_LSM9DS1_REGISTER_OUT_Z_H_XL     = const(0x2D)
-_LSM9DS1_REGISTER_WHO_AM_I_M     = const(0x0F)
-_LSM9DS1_REGISTER_CTRL_REG1_M    = const(0x20)
-_LSM9DS1_REGISTER_CTRL_REG2_M    = const(0x21)
-_LSM9DS1_REGISTER_CTRL_REG3_M    = const(0x22)
-_LSM9DS1_REGISTER_CTRL_REG4_M    = const(0x23)
-_LSM9DS1_REGISTER_CTRL_REG5_M    = const(0x24)
-_LSM9DS1_REGISTER_STATUS_REG_M   = const(0x27)
-_LSM9DS1_REGISTER_OUT_X_L_M      = const(0x28)
-_LSM9DS1_REGISTER_OUT_X_H_M      = const(0x29)
-_LSM9DS1_REGISTER_OUT_Y_L_M      = const(0x2A)
-_LSM9DS1_REGISTER_OUT_Y_H_M      = const(0x2B)
-_LSM9DS1_REGISTER_OUT_Z_L_M      = const(0x2C)
-_LSM9DS1_REGISTER_OUT_Z_H_M      = const(0x2D)
-_LSM9DS1_REGISTER_CFG_M          = const(0x30)
-_LSM9DS1_REGISTER_INT_SRC_M      = const(0x31)
-_MAGTYPE                         = True
-_XGTYPE                          = False
-_SENSORS_GRAVITY_STANDARD        = 9.80665
+_LSM9DS1_ADDRESS_ACCELGYRO = const(0x6B)
+_LSM9DS1_ADDRESS_MAG = const(0x1E)
+_LSM9DS1_XG_ID = const(0b01101000)
+_LSM9DS1_MAG_ID = const(0b00111101)
+_LSM9DS1_ACCEL_MG_LSB_2G = 0.061
+_LSM9DS1_ACCEL_MG_LSB_4G = 0.122
+_LSM9DS1_ACCEL_MG_LSB_8G = 0.244
+_LSM9DS1_ACCEL_MG_LSB_16G = 0.732
+_LSM9DS1_MAG_MGAUSS_4GAUSS = 0.14
+_LSM9DS1_MAG_MGAUSS_8GAUSS = 0.29
+_LSM9DS1_MAG_MGAUSS_12GAUSS = 0.43
+_LSM9DS1_MAG_MGAUSS_16GAUSS = 0.58
+_LSM9DS1_GYRO_DPS_DIGIT_245DPS = 0.00875
+_LSM9DS1_GYRO_DPS_DIGIT_500DPS = 0.01750
+_LSM9DS1_GYRO_DPS_DIGIT_2000DPS = 0.07000
+_LSM9DS1_TEMP_LSB_DEGREE_CELSIUS = 8  # 1°C = 8, 25° = 200, etc.
+_LSM9DS1_REGISTER_WHO_AM_I_XG = const(0x0F)
+_LSM9DS1_REGISTER_CTRL_REG1_G = const(0x10)
+_LSM9DS1_REGISTER_CTRL_REG2_G = const(0x11)
+_LSM9DS1_REGISTER_CTRL_REG3_G = const(0x12)
+_LSM9DS1_REGISTER_TEMP_OUT_L = const(0x15)
+_LSM9DS1_REGISTER_TEMP_OUT_H = const(0x16)
+_LSM9DS1_REGISTER_STATUS_REG = const(0x17)
+_LSM9DS1_REGISTER_OUT_X_L_G = const(0x18)
+_LSM9DS1_REGISTER_OUT_X_H_G = const(0x19)
+_LSM9DS1_REGISTER_OUT_Y_L_G = const(0x1A)
+_LSM9DS1_REGISTER_OUT_Y_H_G = const(0x1B)
+_LSM9DS1_REGISTER_OUT_Z_L_G = const(0x1C)
+_LSM9DS1_REGISTER_OUT_Z_H_G = const(0x1D)
+_LSM9DS1_REGISTER_CTRL_REG4 = const(0x1E)
+_LSM9DS1_REGISTER_CTRL_REG5_XL = const(0x1F)
+_LSM9DS1_REGISTER_CTRL_REG6_XL = const(0x20)
+_LSM9DS1_REGISTER_CTRL_REG7_XL = const(0x21)
+_LSM9DS1_REGISTER_CTRL_REG8 = const(0x22)
+_LSM9DS1_REGISTER_CTRL_REG9 = const(0x23)
+_LSM9DS1_REGISTER_CTRL_REG10 = const(0x24)
+_LSM9DS1_REGISTER_OUT_X_L_XL = const(0x28)
+_LSM9DS1_REGISTER_OUT_X_H_XL = const(0x29)
+_LSM9DS1_REGISTER_OUT_Y_L_XL = const(0x2A)
+_LSM9DS1_REGISTER_OUT_Y_H_XL = const(0x2B)
+_LSM9DS1_REGISTER_OUT_Z_L_XL = const(0x2C)
+_LSM9DS1_REGISTER_OUT_Z_H_XL = const(0x2D)
+_LSM9DS1_REGISTER_WHO_AM_I_M = const(0x0F)
+_LSM9DS1_REGISTER_CTRL_REG1_M = const(0x20)
+_LSM9DS1_REGISTER_CTRL_REG2_M = const(0x21)
+_LSM9DS1_REGISTER_CTRL_REG3_M = const(0x22)
+_LSM9DS1_REGISTER_CTRL_REG4_M = const(0x23)
+_LSM9DS1_REGISTER_CTRL_REG5_M = const(0x24)
+_LSM9DS1_REGISTER_STATUS_REG_M = const(0x27)
+_LSM9DS1_REGISTER_OUT_X_L_M = const(0x28)
+_LSM9DS1_REGISTER_OUT_X_H_M = const(0x29)
+_LSM9DS1_REGISTER_OUT_Y_L_M = const(0x2A)
+_LSM9DS1_REGISTER_OUT_Y_H_M = const(0x2B)
+_LSM9DS1_REGISTER_OUT_Z_L_M = const(0x2C)
+_LSM9DS1_REGISTER_OUT_Z_H_M = const(0x2D)
+_LSM9DS1_REGISTER_CFG_M = const(0x30)
+_LSM9DS1_REGISTER_INT_SRC_M = const(0x31)
+_MAGTYPE = True
+_XGTYPE = False
+_SENSORS_GRAVITY_STANDARD = 9.80665
 
 # User facing constants/module globals.
-ACCELRANGE_2G                = (0b00 << 3)
-ACCELRANGE_16G               = (0b01 << 3)
-ACCELRANGE_4G                = (0b10 << 3)
-ACCELRANGE_8G                = (0b11 << 3)
-MAGGAIN_4GAUSS               = (0b00 << 5)  # +/- 4 gauss
-MAGGAIN_8GAUSS               = (0b01 << 5)  # +/- 8 gauss
-MAGGAIN_12GAUSS              = (0b10 << 5)  # +/- 12 gauss
-MAGGAIN_16GAUSS              = (0b11 << 5)  # +/- 16 gauss
-GYROSCALE_245DPS             = (0b00 << 3)  # +/- 245 degrees/s rotation
-GYROSCALE_500DPS             = (0b01 << 3)  # +/- 500 degrees/s rotation
-GYROSCALE_2000DPS            = (0b11 << 3)  # +/- 2000 degrees/s rotation
+ACCELRANGE_2G = 0b00 << 3
+ACCELRANGE_16G = 0b01 << 3
+ACCELRANGE_4G = 0b10 << 3
+ACCELRANGE_8G = 0b11 << 3
+MAGGAIN_4GAUSS = 0b00 << 5  # +/- 4 gauss
+MAGGAIN_8GAUSS = 0b01 << 5  # +/- 8 gauss
+MAGGAIN_12GAUSS = 0b10 << 5  # +/- 12 gauss
+MAGGAIN_16GAUSS = 0b11 << 5  # +/- 16 gauss
+GYROSCALE_245DPS = 0b00 << 3  # +/- 245 degrees/s rotation
+GYROSCALE_500DPS = 0b01 << 3  # +/- 500 degrees/s rotation
+GYROSCALE_2000DPS = 0b11 << 3  # +/- 2000 degrees/s rotation
 # pylint: enable=bad-whitespace
 
 
@@ -160,11 +161,13 @@ def __init__(self):
         self._write_u8(_MAGTYPE, _LSM9DS1_REGISTER_CTRL_REG2_M, 0x0C)
         time.sleep(0.01)
         # Check ID registers.
-        if self._read_u8(_XGTYPE, _LSM9DS1_REGISTER_WHO_AM_I_XG) != _LSM9DS1_XG_ID or \
-           self._read_u8(_MAGTYPE, _LSM9DS1_REGISTER_WHO_AM_I_M) != _LSM9DS1_MAG_ID:
-            raise RuntimeError('Could not find LSM9DS1, check wiring!')
+        if (
+            self._read_u8(_XGTYPE, _LSM9DS1_REGISTER_WHO_AM_I_XG) != _LSM9DS1_XG_ID
+            or self._read_u8(_MAGTYPE, _LSM9DS1_REGISTER_WHO_AM_I_M) != _LSM9DS1_MAG_ID
+        ):
+            raise RuntimeError("Could not find LSM9DS1, check wiring!")
         # enable gyro continuous
-        self._write_u8(_XGTYPE, _LSM9DS1_REGISTER_CTRL_REG1_G, 0xC0) # on XYZ
+        self._write_u8(_XGTYPE, _LSM9DS1_REGISTER_CTRL_REG1_G, 0xC0)  # on XYZ
         # Enable the accelerometer continous
         self._write_u8(_XGTYPE, _LSM9DS1_REGISTER_CTRL_REG5_XL, 0x38)
         self._write_u8(_XGTYPE, _LSM9DS1_REGISTER_CTRL_REG6_XL, 0xC0)
@@ -191,8 +194,7 @@ def accel_range(self):
 
     @accel_range.setter
     def accel_range(self, val):
-        assert val in (ACCELRANGE_2G, ACCELRANGE_4G, ACCELRANGE_8G,
-                       ACCELRANGE_16G)
+        assert val in (ACCELRANGE_2G, ACCELRANGE_4G, ACCELRANGE_8G, ACCELRANGE_16G)
         reg = self._read_u8(_XGTYPE, _LSM9DS1_REGISTER_CTRL_REG6_XL)
         reg = (reg & ~(0b00011000)) & 0xFF
         reg |= val
@@ -219,8 +221,7 @@ def mag_gain(self):
 
     @mag_gain.setter
     def mag_gain(self, val):
-        assert val in (MAGGAIN_4GAUSS, MAGGAIN_8GAUSS, MAGGAIN_12GAUSS,
-                       MAGGAIN_16GAUSS)
+        assert val in (MAGGAIN_4GAUSS, MAGGAIN_8GAUSS, MAGGAIN_12GAUSS, MAGGAIN_16GAUSS)
         reg = self._read_u8(_MAGTYPE, _LSM9DS1_REGISTER_CTRL_REG2_M)
         reg = (reg & ~(0b01100000)) & 0xFF
         reg |= val
@@ -265,9 +266,8 @@ def read_accel_raw(self):
         accelerometer property!
         """
         # Read the accelerometer
-        self._read_bytes(_XGTYPE, 0x80 | _LSM9DS1_REGISTER_OUT_X_L_XL, 6,
-                         self._BUFFER)
-        raw_x, raw_y, raw_z = struct.unpack_from('<hhh', self._BUFFER[0:6])
+        self._read_bytes(_XGTYPE, 0x80 | _LSM9DS1_REGISTER_OUT_X_L_XL, 6, self._BUFFER)
+        raw_x, raw_y, raw_z = struct.unpack_from("<hhh", self._BUFFER[0:6])
         return (raw_x, raw_y, raw_z)
 
     @property
@@ -276,8 +276,9 @@ def acceleration(self):
         m/s^2 values.
         """
         raw = self.read_accel_raw()
-        return map(lambda x: x * self._accel_mg_lsb / 1000.0 * _SENSORS_GRAVITY_STANDARD,
-                   raw)
+        return map(
+            lambda x: x * self._accel_mg_lsb / 1000.0 * _SENSORS_GRAVITY_STANDARD, raw
+        )
 
     def read_mag_raw(self):
         """Read the raw magnetometer sensor values and return it as a
@@ -286,9 +287,8 @@ def read_mag_raw(self):
         magnetometer property!
         """
         # Read the magnetometer
-        self._read_bytes(_MAGTYPE, 0x80 | _LSM9DS1_REGISTER_OUT_X_L_M, 6,
-                         self._BUFFER)
-        raw_x, raw_y, raw_z = struct.unpack_from('<hhh', self._BUFFER[0:6])
+        self._read_bytes(_MAGTYPE, 0x80 | _LSM9DS1_REGISTER_OUT_X_L_M, 6, self._BUFFER)
+        raw_x, raw_y, raw_z = struct.unpack_from("<hhh", self._BUFFER[0:6])
         return (raw_x, raw_y, raw_z)
 
     @property
@@ -306,9 +306,8 @@ def read_gyro_raw(self):
         gyroscope property!
         """
         # Read the gyroscope
-        self._read_bytes(_XGTYPE, 0x80 | _LSM9DS1_REGISTER_OUT_X_L_G, 6,
-                         self._BUFFER)
-        raw_x, raw_y, raw_z = struct.unpack_from('<hhh', self._BUFFER[0:6])
+        self._read_bytes(_XGTYPE, 0x80 | _LSM9DS1_REGISTER_OUT_X_L_G, 6, self._BUFFER)
+        raw_x, raw_y, raw_z = struct.unpack_from("<hhh", self._BUFFER[0:6])
         return (raw_x, raw_y, raw_z)
 
     @property
@@ -325,8 +324,7 @@ def read_temp_raw(self):
         want to use the temperature property!
         """
         # Read temp sensor
-        self._read_bytes(_XGTYPE, 0x80 | _LSM9DS1_REGISTER_TEMP_OUT_L, 2,
-                         self._BUFFER)
+        self._read_bytes(_XGTYPE, 0x80 | _LSM9DS1_REGISTER_TEMP_OUT_L, 2, self._BUFFER)
         temp = ((self._BUFFER[1] << 8) | self._BUFFER[0]) >> 4
         return _twos_comp(temp, 12)
 
@@ -337,7 +335,7 @@ def temperature(self):
         # See discussion from:
         #  https://github.com/kriswiner/LSM9DS1/issues/3
         temp = self.read_temp_raw()
-        temp = 27.5 + temp/16
+        temp = 27.5 + temp / 16
         return temp
 
     def _read_u8(self, sensor_type, address):
@@ -379,16 +377,23 @@ class LSM9DS1_I2C(LSM9DS1):
         Defaults to ``0x6B``.
 
     """
-    def __init__(self, i2c, mag_address=_LSM9DS1_ADDRESS_MAG,
-                 xg_address=_LSM9DS1_ADDRESS_ACCELGYRO):
-        if mag_address in (0x1c, 0x1e) and xg_address in (0x6a, 0x6b):
+
+    def __init__(
+        self,
+        i2c,
+        mag_address=_LSM9DS1_ADDRESS_MAG,
+        xg_address=_LSM9DS1_ADDRESS_ACCELGYRO,
+    ):
+        if mag_address in (0x1C, 0x1E) and xg_address in (0x6A, 0x6B):
             self._mag_device = i2c_device.I2CDevice(i2c, mag_address)
             self._xg_device = i2c_device.I2CDevice(i2c, xg_address)
             super().__init__()
         else:
-            raise ValueError('address parmeters are incorrect. Read the docs at '
-                             'circuitpython.rtfd.io/projects/lsm9ds1/en/latest'
-                             '/api.html#adafruit_lsm9ds1.LSM9DS1_I2C')
+            raise ValueError(
+                "address parmeters are incorrect. Read the docs at "
+                "circuitpython.rtfd.io/projects/lsm9ds1/en/latest"
+                "/api.html#adafruit_lsm9ds1.LSM9DS1_I2C"
+            )
 
     def _read_u8(self, sensor_type, address):
         if sensor_type == _MAGTYPE:
@@ -397,7 +402,9 @@ def _read_u8(self, sensor_type, address):
             device = self._xg_device
         with device as i2c:
             self._BUFFER[0] = address & 0xFF
-            i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_start=1, in_end=2)
+            i2c.write_then_readinto(
+                self._BUFFER, self._BUFFER, out_end=1, in_start=1, in_end=2
+            )
         return self._BUFFER[1]
 
     def _read_bytes(self, sensor_type, address, count, buf):
@@ -435,10 +442,15 @@ class LSM9DS1_SPI(LSM9DS1):
         LSM9DS1's CSAG (Chip Select Accelerometer/Gyroscope) pin.
 
     """
+
     # pylint: disable=no-member
     def __init__(self, spi, xgcs, mcs):
-        self._mag_device = spi_device.SPIDevice(spi, mcs, baudrate=200000, phase=1, polarity=1)
-        self._xg_device = spi_device.SPIDevice(spi, xgcs, baudrate=200000, phase=1, polarity=1)
+        self._mag_device = spi_device.SPIDevice(
+            spi, mcs, baudrate=200000, phase=1, polarity=1
+        )
+        self._xg_device = spi_device.SPIDevice(
+            spi, xgcs, baudrate=200000, phase=1, polarity=1
+        )
         super().__init__()
 
     def _read_u8(self, sensor_type, address):