Merge pull request #27 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

adafruit_pca9685.py

@@ -57,8 +57,10 @@
 from adafruit_register.i2c_struct_array import StructArray
 from adafruit_bus_device import i2c_device
 
+
 class PWMChannel:
     """A single PCA9685 channel that matches the :py:class:`~pulseio.PWMOut` API."""
+
     def __init__(self, pca, index):
         self._pca = pca
         self._index = index
@@ -80,23 +82,25 @@ def duty_cycle(self):
            always be high, 0 will always be low and 0x7fff will be half high and then half low."""
         pwm = self._pca.pwm_regs[self._index]
         if pwm[0] == 0x1000:
-            return 0xffff
+            return 0xFFFF
         return pwm[1] << 4
 
     @duty_cycle.setter
     def duty_cycle(self, value):
-        if not 0 <= value <= 0xffff:
+        if not 0 <= value <= 0xFFFF:
             raise ValueError("Out of range")
 
-        if value == 0xffff:
+        if value == 0xFFFF:
             self._pca.pwm_regs[self._index] = (0x1000, 0)
         else:
             # Shift our value by four because the PCA9685 is only 12 bits but our value is 16
             value = (value + 1) >> 4
             self._pca.pwm_regs[self._index] = (0, value)
 
-class PCAChannels: # pylint: disable=too-few-public-methods
+
+class PCAChannels:  # pylint: disable=too-few-public-methods
     """Lazily creates and caches channel objects as needed. Treat it like a sequence."""
+
     def __init__(self, pca):
         self._pca = pca
         self._channels = [None] * len(self)
@@ -109,6 +113,7 @@ def __getitem__(self, index):
             self._channels[index] = PWMChannel(self._pca, index)
         return self._channels[index]
 
+
 class PCA9685:
     """
     Initialise the PCA9685 chip at ``address`` on ``i2c_bus``.
@@ -122,10 +127,11 @@ class PCA9685:
     :param int address: The I2C address of the PCA9685.
     :param int reference_clock_speed: The frequency of the internal reference clock in Hertz.
     """
+
     # Registers:
-    mode1_reg = UnaryStruct(0x00, '<B')
-    prescale_reg = UnaryStruct(0xFE, '<B')
-    pwm_regs = StructArray(0x06, '<HH', 16)
+    mode1_reg = UnaryStruct(0x00, "<B")
+    prescale_reg = UnaryStruct(0xFE, "<B")
+    pwm_regs = StructArray(0x06, "<HH", 16)
 
     def __init__(self, i2c_bus, *, address=0x40, reference_clock_speed=25000000):
         self.i2c_device = i2c_device.I2CDevice(i2c_bus, address)
@@ -137,7 +143,7 @@ def __init__(self, i2c_bus, *, address=0x40, reference_clock_speed=25000000):
 
     def reset(self):
         """Reset the chip."""
-        self.mode1_reg = 0x00 # Mode1
+        self.mode1_reg = 0x00  # Mode1
 
     @property
     def frequency(self):
@@ -149,12 +155,12 @@ def frequency(self, freq):
         prescale = int(self.reference_clock_speed / 4096.0 / freq + 0.5)
         if prescale < 3:
             raise ValueError("PCA9685 cannot output at the given frequency")
-        old_mode = self.mode1_reg # Mode 1
-        self.mode1_reg = (old_mode & 0x7F) | 0x10 # Mode 1, sleep
-        self.prescale_reg = prescale # Prescale
-        self.mode1_reg = old_mode # Mode 1
+        old_mode = self.mode1_reg  # Mode 1
+        self.mode1_reg = (old_mode & 0x7F) | 0x10  # Mode 1, sleep
+        self.prescale_reg = prescale  # Prescale
+        self.mode1_reg = old_mode  # Mode 1
         time.sleep(0.005)
-        self.mode1_reg = old_mode | 0xa1 # Mode 1, autoincrement on
+        self.mode1_reg = old_mode | 0xA1  # Mode 1, autoincrement on
 
     def __enter__(self):
         return self

docs/conf.py

@@ -2,45 +2,53 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
 ]
 
-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        None,
+    ),
+    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+}
 
 # Libraries we depend on but don't need for generating docs.
 # autodoc_mock_imports = ['adafruit_bus_device', 'adafruit_register']
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'Adafruit PCA9685 Library'
-copyright = u'2016 Radomir Dopieralski, 2017 Scott Shawcroft'
-author = u'Radomir Dopieralski'
+project = u"Adafruit PCA9685 Library"
+copyright = u"2016 Radomir Dopieralski, 2017 Scott Shawcroft"
+author = u"Radomir Dopieralski"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'1.0'
+version = u"1.0"
 # The full version, including alpha/beta/rc tags.
-release = u'1.0'
+release = u"1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -52,7 +60,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -64,7 +72,7 @@
 add_function_parentheses = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
@@ -78,68 +86,76 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme
-        html_theme = 'sphinx_rtd_theme'
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
     except:
-        html_theme = 'default'
-        html_theme_path = ['.']
+        html_theme = "default"
+        html_theme_path = ["."]
 else:
-    html_theme_path = ['.']
+    html_theme_path = ["."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/favicon.ico"
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'AdafruitPCA9685Librarydoc'
+htmlhelp_basename = "AdafruitPCA9685Librarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'AdafruitPCA9685Library.tex', u'Adafruit PCA9685 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitPCA9685Library.tex",
+        u"Adafruit PCA9685 Library Documentation",
+        author,
+        "manual",
+    ),
 ]
 
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'adafruitPCA9685library', u'Adafruit PCA9685 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "adafruitPCA9685library",
+        u"Adafruit PCA9685 Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -148,7 +164,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitPCA9685Library', u'Adafruit PCA9685 Library Documentation',
-     author, 'AdafruitPCA9685Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitPCA9685Library",
+        u"Adafruit PCA9685 Library Documentation",
+        author,
+        "AdafruitPCA9685Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/pca9685_calibration.py

@@ -25,19 +25,21 @@
 # Set the PWM duty cycle for channel zero to 50%. duty_cycle is 16 bits to match other PWM objects
 # but the PCA9685 will only actually give 12 bits of resolution.
 print("Running with default calibration")
-pca.channels[0].duty_cycle = 0x7fff
+pca.channels[0].duty_cycle = 0x7FFF
 time.sleep(1)
 pca.channels[0].duty_cycle = 0
 
 measured_frequency = float(input("Frequency measured: "))
 print()
 
-pca.reference_clock_speed = pca.reference_clock_speed * (measured_frequency / pca.frequency)
+pca.reference_clock_speed = pca.reference_clock_speed * (
+    measured_frequency / pca.frequency
+)
 # Set frequency again so we can get closer. Reading it back will produce the real value.
 pca.frequency = 100
 
 input("Press enter when ready to measure coarse calibration frequency.")
-pca.channels[0].duty_cycle = 0x7fff
+pca.channels[0].duty_cycle = 0x7FFF
 time.sleep(1)
 pca.channels[0].duty_cycle = 0
 measured_after_calibration = float(input("Frequency measured: "))

examples/pca9685_simpletest.py

@@ -18,4 +18,4 @@
 
 # Set the PWM duty cycle for channel zero to 50%. duty_cycle is 16 bits to match other PWM objects
 # but the PCA9685 will only actually give 12 bits of resolution.
-pca.channels[0].duty_cycle = 0x7fff
+pca.channels[0].duty_cycle = 0x7FFF