Merge pull request #9 from adafruit/patch

Pylint and RTD update patch, and other fixes

.github/workflows/build.yml

@@ -42,9 +42,9 @@ jobs:
       # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
       run: |
         source actions-ci/install.sh
-    - name: Pip install pylint, Sphinx, pre-commit
+    - name: Pip install Sphinx, pre-commit
       run: |
-        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
+        pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit
     - name: Library version
       run: git describe --dirty --always --tags
     - name: Setup problem matchers

.pre-commit-config.yaml

@@ -18,23 +18,25 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/pycqa/pylint
-    rev: pylint-2.7.1
+    rev: v2.11.1
     hooks:
     -   id: pylint
         name: pylint (library code)
         types: [python]
+        args:
+          - --disable=consider-using-f-string
         exclude: "^(docs/|examples/|tests/|setup.py$)"
--   repo: local
-    hooks:
-    -   id: pylint_examples
-        name: pylint (examples code)
+    -   id: pylint
+        name: pylint (example code)
         description: Run pylint rules on "examples/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)']
-        language: system
-    -   id: pylint_tests
-        name: pylint (tests code)
+        types: [python]
+        files: "^examples/"
+        args:
+        - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
+    -   id: pylint
+        name: pylint (test code)
         description: Run pylint rules on "tests/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "tests" ]] || for test in $(find . -path "./tests/*.py"); do pylint --disable=missing-docstring $test; done)']
-        language: system
+        types: [python]
+        files: "^tests/"
+        args:
+        - --disable=missing-docstring,consider-using-f-string,duplicate-code

.pylintrc

@@ -55,7 +55,7 @@ confidence=
 # no Warning level messages displayed, use"--disable=all --enable=classes
 # --disable=W"
 # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,pointless-string-statement
+disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,pointless-string-statement,unspecified-encoding
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
@@ -252,7 +252,7 @@ ignore-docstrings=yes
 ignore-imports=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=12
+min-similarity-lines=4
 
 
 [BASIC]

docs/requirements.txt

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx>=4.0.0

examples/ov5640_directio_kaluga1_3_ili9341.py

@@ -22,8 +22,8 @@
 import busio
 import digitalio
 import displayio
+from adafruit_ticks import ticks_ms, ticks_less
 import adafruit_ov5640
-from adafruit_ticks import ticks_ms, ticks_add, ticks_less
 
 # Set to True to enable the various effects & exposure modes to be tested
 test_effects = False
@@ -93,8 +93,8 @@
 display.auto_refresh = False
 
 
-def special_modes(cam):
-    def effect_modes(cam):
+def special_modes(cam_obj):
+    def effect_modes(cam_obj):
         for i in [
             "NONE",
             "NEGATIVE",
@@ -105,72 +105,74 @@ def effect_modes(cam):
             "SEPIA",
         ]:
             print(f"Effect {i}")
-            cam.effect = getattr(adafruit_ov5640, f"OV5640_SPECIAL_EFFECT_{i}")
+            cam_obj.effect = getattr(adafruit_ov5640, f"OV5640_SPECIAL_EFFECT_{i}")
             yield
-        cam.effect = adafruit_ov5640.OV5640_SPECIAL_EFFECT_NONE
+        cam_obj.effect = adafruit_ov5640.OV5640_SPECIAL_EFFECT_NONE
 
-    def saturation_modes(cam):
+    def saturation_modes(cam_obj):
         for i in range(-4, 5):
             print(f"Saturation {i}")
-            cam.saturation = i
+            cam_obj.saturation = i
             yield
-        cam.saturation = 0
+        cam_obj.saturation = 0
 
-    def brightness_modes(cam):
+    def brightness_modes(cam_obj):
         for i in range(-4, 5):
             print(f"Brightness {i}")
-            cam.brightness = i
+            cam_obj.brightness = i
             yield
-        cam.brightness = 0
+        cam_obj.brightness = 0
 
-    def contrast_modes(cam):
+    def contrast_modes(cam_obj):
         for i in range(-3, 4):
             print(f"Contrast {i}")
-            cam.contrast = i
+            cam_obj.contrast = i
             yield
-        cam.contrast = 0
+        cam_obj.contrast = 0
 
-    def white_balance_modes(cam):
+    def white_balance_modes(cam_obj):  # pylint: disable=unused-variable
         for i in ["AUTO", "SUNNY", "FLUORESCENT", "CLOUDY", "INCANDESCENT"]:
             print(f"White Balance {i}")
-            cam.white_balance = getattr(adafruit_ov5640, f"OV5640_WHITE_BALANCE_{i}")
+            cam_obj.white_balance = getattr(
+                adafruit_ov5640, f"OV5640_WHITE_BALANCE_{i}"
+            )
             yield
-        cam.white_balance = adafruit_ov5640.OV5640_WHITE_BALANCE_AUTO
+        cam_obj.white_balance = adafruit_ov5640.OV5640_WHITE_BALANCE_AUTO
 
-    def exposure_value_modes(cam):
+    def exposure_value_modes(cam_obj):  # pylint: disable=unused-variable
         for i in range(-3, 4):
             print(f"EV {i}")
-            cam.exposure_value = i
+            cam_obj.exposure_value = i
             yield
-        cam.exposure_value = 0
+        cam_obj.exposure_value = 0
 
-    def nite_modes(cam):
-        print(f"Night Mode On")
-        cam.night_mode = True
-        print(cam.night_mode)
+    def nite_modes(cam_obj):  # pylint: disable=unused-variable
+        print("Night Mode On")
+        cam_obj.night_mode = True
+        print(cam_obj.night_mode)
         yield
-        print(f"Night Mode Off")
-        cam.night_mode = False
-        print(cam.night_mode)
+        print("Night Mode Off")
+        cam_obj.night_mode = False
+        print(cam_obj.night_mode)
         yield
 
-    def test_modes(cam):
+    def test_modes(cam_obj):
         print("Test pattern On")
-        cam.test_pattern = True
+        cam_obj.test_pattern = True
         yield
         print("Test pattern Off")
-        cam.test_pattern = False
+        cam_obj.test_pattern = False
         yield
 
     while True:
-        yield from test_modes(cam)
-        yield from contrast_modes(cam)
-        yield from effect_modes(cam)
-        yield from saturation_modes(cam)
-        yield from brightness_modes(cam)
+        yield from test_modes(cam_obj)
+        yield from contrast_modes(cam_obj)
+        yield from effect_modes(cam_obj)
+        yield from saturation_modes(cam_obj)
+        yield from brightness_modes(cam_obj)
         # These don't work right (yet)
-        # yield from exposure_value_modes(cam)  # Issue #8
-        # yield from nite_modes(cam) # Issue #6
+        # yield from exposure_value_modes(cam_obj)  # Issue #8
+        # yield from nite_modes(cam_obj) # Issue #6
 
 
 def main():