Merge pull request #46 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]
@@ -155,7 +156,7 @@ ignored-classes=optparse.Values,thread._local,_thread._local
 # (useful for modules/projects where namespaces are manipulated during runtime
 # and thus existing member attributes cannot be deduced by static analysis. It
 # supports qualified module names, as well as Unix pattern matching.
-ignored-modules=board,pulseio
+ignored-modules=board
 
 # Show a hint with possible names when a member name was not found. The aspect
 # of finding the hint is based on edit distance.
@@ -300,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
@@ -422,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_character_lcd/character_lcd.py

@@ -54,39 +54,39 @@
 
 # pylint: disable-msg=bad-whitespace
 # Commands
-_LCD_CLEARDISPLAY        = const(0x01)
-_LCD_RETURNHOME          = const(0x02)
-_LCD_ENTRYMODESET        = const(0x04)
-_LCD_DISPLAYCONTROL      = const(0x08)
-_LCD_CURSORSHIFT         = const(0x10)
-_LCD_FUNCTIONSET         = const(0x20)
-_LCD_SETCGRAMADDR        = const(0x40)
-_LCD_SETDDRAMADDR        = const(0x80)
+_LCD_CLEARDISPLAY = const(0x01)
+_LCD_RETURNHOME = const(0x02)
+_LCD_ENTRYMODESET = const(0x04)
+_LCD_DISPLAYCONTROL = const(0x08)
+_LCD_CURSORSHIFT = const(0x10)
+_LCD_FUNCTIONSET = const(0x20)
+_LCD_SETCGRAMADDR = const(0x40)
+_LCD_SETDDRAMADDR = const(0x80)
 
 # Entry flags
-_LCD_ENTRYLEFT           = const(0x02)
+_LCD_ENTRYLEFT = const(0x02)
 _LCD_ENTRYSHIFTDECREMENT = const(0x00)
 
 # Control flags
-_LCD_DISPLAYON           = const(0x04)
-_LCD_CURSORON            = const(0x02)
-_LCD_CURSOROFF           = const(0x00)
-_LCD_BLINKON             = const(0x01)
-_LCD_BLINKOFF            = const(0x00)
+_LCD_DISPLAYON = const(0x04)
+_LCD_CURSORON = const(0x02)
+_LCD_CURSOROFF = const(0x00)
+_LCD_BLINKON = const(0x01)
+_LCD_BLINKOFF = const(0x00)
 
 # Move flags
-_LCD_DISPLAYMOVE         = const(0x08)
-_LCD_MOVERIGHT           = const(0x04)
-_LCD_MOVELEFT            = const(0x00)
+_LCD_DISPLAYMOVE = const(0x08)
+_LCD_MOVERIGHT = const(0x04)
+_LCD_MOVELEFT = const(0x00)
 
 # Function set flags
-_LCD_4BITMODE            = const(0x00)
-_LCD_2LINE               = const(0x08)
-_LCD_1LINE               = const(0x00)
-_LCD_5X8DOTS             = const(0x00)
+_LCD_4BITMODE = const(0x00)
+_LCD_2LINE = const(0x08)
+_LCD_1LINE = const(0x00)
+_LCD_5X8DOTS = const(0x00)
 
 # Offset for up to 4 rows.
-_LCD_ROW_OFFSETS         = (0x00, 0x40, 0x14, 0x54)
+_LCD_ROW_OFFSETS = (0x00, 0x40, 0x14, 0x54)
 
 # pylint: enable-msg=bad-whitespace
 
@@ -128,12 +128,12 @@ class Character_LCD:
     :param lines: The lines on the charLCD
 
     """
+
     LEFT_TO_RIGHT = const(0)
     RIGHT_TO_LEFT = const(1)
 
     # pylint: disable-msg=too-many-arguments
-    def __init__(self, rs, en, d4, d5, d6, d7, columns, lines
-                ):
+    def __init__(self, rs, en, d4, d5, d6, d7, columns, lines):
 
         self.columns = columns
         self.lines = lines
@@ -146,7 +146,7 @@ def __init__(self, rs, en, d4, d5, d6, d7, columns, lines
         self.dl7 = d7
 
         # set all pins as outputs
-        for pin in(rs, en, d4, d5, d6, d7):
+        for pin in (rs, en, d4, d5, d6, d7):
             pin.direction = digitalio.Direction.OUTPUT
 
         # Initialise the display
@@ -174,6 +174,7 @@ def __init__(self, rs, en, d4, d5, d6, d7, columns, lines
         self.row = 0
         self.column = 0
         self._column_align = False
+
     # pylint: enable-msg=too-many-arguments
 
     def home(self):
@@ -215,7 +216,7 @@ def column_align(self, enable):
         if isinstance(enable, bool):
             self._column_align = enable
         else:
-            raise ValueError('The column_align value must be either True or False')
+            raise ValueError("The column_align value must be either True or False")
 
     @property
     def cursor(self):
@@ -379,7 +380,7 @@ def message(self, message):
                 self.cursor_position(col, line)
                 initial_character += 1
             # If character is \n, go to next line
-            if character == '\n':
+            if character == "\n":
                 line += 1
                 # Start the second line at (0, 1) unless direction is set right to left in
                 # which case start on the opposite side of the display if cursor_position
@@ -540,6 +541,8 @@ def _pulse_enable(self):
         time.sleep(0.0000001)
         self.enable.value = False
         time.sleep(0.0000001)
+
+
 # pylint: enable-msg=too-many-instance-attributes
 
 
@@ -561,9 +564,21 @@ class Character_LCD_Mono(Character_LCD):
             to common cathode.
 
     """
+
     # pylint: disable-msg=too-many-arguments
-    def __init__(self, rs, en, db4, db5, db6, db7, columns, lines,
-                 backlight_pin=None, backlight_inverted=False):
+    def __init__(
+        self,
+        rs,
+        en,
+        db4,
+        db5,
+        db6,
+        db7,
+        columns,
+        lines,
+        backlight_pin=None,
+        backlight_inverted=False,
+    ):
 
         # Backlight pin and inversion
         self.backlight_pin = backlight_pin
@@ -574,6 +589,7 @@ def __init__(self, rs, en, db4, db5, db6, db7, columns, lines,
             self.backlight_pin.direction = digitalio.Direction.OUTPUT
             self.backlight = True
         super().__init__(rs, en, db4, db5, db6, db7, columns, lines)
+
     # pylint: enable-msg=too-many-arguments
 
     @property
@@ -631,9 +647,23 @@ class Character_LCD_RGB(Character_LCD):
             write from the display. Not necessary if only writing to the display. Used on shield.
 
     """
+
     # pylint: disable-msg=too-many-arguments
-    def __init__(self, rs, en, db4, db5, db6, db7, columns, lines,
-                 red, green, blue, read_write=None):
+    def __init__(
+        self,
+        rs,
+        en,
+        db4,
+        db5,
+        db6,
+        db7,
+        columns,
+        lines,
+        red,
+        green,
+        blue,
+        read_write=None,
+    ):
 
         # Define read_write (rw) pin
         self.read_write = read_write
@@ -646,13 +676,13 @@ def __init__(self, rs, en, db4, db5, db6, db7, columns, lines,
         self.rgb_led = [red, green, blue]
 
         for pin in self.rgb_led:
-            if hasattr(pin, 'direction'):
+            if hasattr(pin, "direction"):
                 # Assume a digitalio.DigitalInOut or compatible interface:
                 pin.direction = digitalio.Direction.OUTPUT
-            elif not hasattr(pin, 'duty_cycle'):
+            elif not hasattr(pin, "duty_cycle"):
                 raise TypeError(
-                    'RGB LED objects must be instances of digitalio.DigitalInOut'
-                    ' or pulseio.PWMOut, or provide a compatible interface.'
+                    "RGB LED objects must be instances of digitalio.DigitalInOut"
+                    " or pulseio.PWMOut, or provide a compatible interface."
                 )
 
         self._color = [0, 0, 0]
@@ -691,10 +721,10 @@ def color(self):
     def color(self, color):
         self._color = color
         for number, pin in enumerate(self.rgb_led):
-            if hasattr(pin, 'duty_cycle'):
+            if hasattr(pin, "duty_cycle"):
                 # Assume a pulseio.PWMOut or compatible interface and set duty cycle:
                 pin.duty_cycle = int(_map(color[number], 0, 100, 65535, 0))
-            elif hasattr(pin, 'value'):
+            elif hasattr(pin, "value"):
                 # If we don't have a PWM interface, all we can do is turn each color
                 # on / off.  Assume a DigitalInOut (or compatible interface) and write
                 # 0 (on) to pin for any value greater than 0, or 1 (off) for 0:

adafruit_character_lcd/character_lcd_i2c.py

@@ -43,6 +43,7 @@
 
 """
 
+from adafruit_mcp230xx.mcp23008 import MCP23008
 from adafruit_character_lcd.character_lcd import Character_LCD_Mono
 
 __version__ = "0.0.0-auto.0"
@@ -66,22 +67,26 @@ class Character_LCD_I2C(Character_LCD_Mono):
         i2c = busio.I2C(board.SCL, board.SDA)
         lcd = Character_LCD_I2C(i2c, 16, 2)
     """
+
     def __init__(self, i2c, columns, lines, address=None, backlight_inverted=False):
         """Initialize character LCD connected to backpack using I2C connection
         on the specified I2C bus with the specified number of columns and
         lines on the display. Optionally specify if backlight is inverted.
         """
-        from adafruit_mcp230xx.mcp23008 import MCP23008
+
         if address:
             mcp = MCP23008(i2c, address=address)
         else:
             mcp = MCP23008(i2c)
-        super().__init__(mcp.get_pin(1),
-                         mcp.get_pin(2),
-                         mcp.get_pin(3),
-                         mcp.get_pin(4),
-                         mcp.get_pin(5),
-                         mcp.get_pin(6),
-                         columns, lines,
-                         backlight_pin=mcp.get_pin(7),
-                         backlight_inverted=backlight_inverted)
+        super().__init__(
+            mcp.get_pin(1),
+            mcp.get_pin(2),
+            mcp.get_pin(3),
+            mcp.get_pin(4),
+            mcp.get_pin(5),
+            mcp.get_pin(6),
+            columns,
+            lines,
+            backlight_pin=mcp.get_pin(7),
+            backlight_inverted=backlight_inverted,
+        )

adafruit_character_lcd/character_lcd_rgb_i2c.py

@@ -54,6 +54,7 @@
 """
 
 import digitalio
+from adafruit_mcp230xx.mcp23017 import MCP23017
 from adafruit_character_lcd.character_lcd import Character_LCD_RGB
 
 __version__ = "0.0.0-auto.0"
@@ -77,13 +78,14 @@ class Character_LCD_RGB_I2C(Character_LCD_RGB):
         lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
 
     """
+
     def __init__(self, i2c, columns, lines, address=None):
         # pylint: disable=too-many-locals
         """Initialize RGB character LCD connected to shield using I2C connection
         on the specified I2C bus with the specified number of columns and lines
         on the display.
         """
-        from adafruit_mcp230xx.mcp23017 import MCP23017
+
         if address:
             mcp = MCP23017(i2c, address=address)
         else:
@@ -95,25 +97,31 @@ def __init__(self, i2c, columns, lines, address=None):
         self._right_button = mcp.get_pin(1)
         self._select_button = mcp.get_pin(0)
 
-        self._buttons = [self._left_button, self._up_button, self._down_button, self._right_button,
-                         self._select_button]
+        self._buttons = [
+            self._left_button,
+            self._up_button,
+            self._down_button,
+            self._right_button,
+            self._select_button,
+        ]
 
         for pin in self._buttons:
             pin.switch_to_input(pull=digitalio.Pull.UP)
 
-        super().__init__(mcp.get_pin(15),
-                         mcp.get_pin(13),
-                         mcp.get_pin(12),
-                         mcp.get_pin(11),
-                         mcp.get_pin(10),
-                         mcp.get_pin(9),
-                         columns,
-                         lines,
-                         mcp.get_pin(6),
-                         mcp.get_pin(7),
-                         mcp.get_pin(8),
-                         mcp.get_pin(14))
-
+        super().__init__(
+            mcp.get_pin(15),
+            mcp.get_pin(13),
+            mcp.get_pin(12),
+            mcp.get_pin(11),
+            mcp.get_pin(10),
+            mcp.get_pin(9),
+            columns,
+            lines,
+            mcp.get_pin(6),
+            mcp.get_pin(7),
+            mcp.get_pin(8),
+            mcp.get_pin(14),
+        )
 
     @property
     def left_button(self):