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,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_fxos8700.py

@@ -58,37 +58,37 @@
 
 # Register addresses and other constants:
 # pylint: disable=bad-whitespace
-_FXOS8700_ADDRESS               = const(0x1F)   # 0011111
-_FXOS8700_ID                    = const(0xC7)   # 1100 0111
-_FXOS8700_REGISTER_STATUS       = const(0x00)
-_FXOS8700_REGISTER_OUT_X_MSB    = const(0x01)
-_FXOS8700_REGISTER_OUT_X_LSB    = const(0x02)
-_FXOS8700_REGISTER_OUT_Y_MSB    = const(0x03)
-_FXOS8700_REGISTER_OUT_Y_LSB    = const(0x04)
-_FXOS8700_REGISTER_OUT_Z_MSB    = const(0x05)
-_FXOS8700_REGISTER_OUT_Z_LSB    = const(0x06)
-_FXOS8700_REGISTER_WHO_AM_I     = const(0x0D)   # 11000111   r
+_FXOS8700_ADDRESS = const(0x1F)  # 0011111
+_FXOS8700_ID = const(0xC7)  # 1100 0111
+_FXOS8700_REGISTER_STATUS = const(0x00)
+_FXOS8700_REGISTER_OUT_X_MSB = const(0x01)
+_FXOS8700_REGISTER_OUT_X_LSB = const(0x02)
+_FXOS8700_REGISTER_OUT_Y_MSB = const(0x03)
+_FXOS8700_REGISTER_OUT_Y_LSB = const(0x04)
+_FXOS8700_REGISTER_OUT_Z_MSB = const(0x05)
+_FXOS8700_REGISTER_OUT_Z_LSB = const(0x06)
+_FXOS8700_REGISTER_WHO_AM_I = const(0x0D)  # 11000111   r
 _FXOS8700_REGISTER_XYZ_DATA_CFG = const(0x0E)
-_FXOS8700_REGISTER_CTRL_REG1    = const(0x2A)   # 00000000   r/w
-_FXOS8700_REGISTER_CTRL_REG2    = const(0x2B)   # 00000000   r/w
-_FXOS8700_REGISTER_CTRL_REG3    = const(0x2C)   # 00000000   r/w
-_FXOS8700_REGISTER_CTRL_REG4    = const(0x2D)   # 00000000   r/w
-_FXOS8700_REGISTER_CTRL_REG5    = const(0x2E)   # 00000000   r/w
-_FXOS8700_REGISTER_MSTATUS      = const(0x32)
-_FXOS8700_REGISTER_MOUT_X_MSB   = const(0x33)
-_FXOS8700_REGISTER_MOUT_X_LSB   = const(0x34)
-_FXOS8700_REGISTER_MOUT_Y_MSB   = const(0x35)
-_FXOS8700_REGISTER_MOUT_Y_LSB   = const(0x36)
-_FXOS8700_REGISTER_MOUT_Z_MSB   = const(0x37)
-_FXOS8700_REGISTER_MOUT_Z_LSB   = const(0x38)
-_FXOS8700_REGISTER_MCTRL_REG1   = const(0x5B)   # 00000000   r/w
-_FXOS8700_REGISTER_MCTRL_REG2   = const(0x5C)   # 00000000   r/w
-_FXOS8700_REGISTER_MCTRL_REG3   = const(0x5D)   # 00000000   r/w
-_ACCEL_MG_LSB_2G                = 0.000244
-_ACCEL_MG_LSB_4G                = 0.000488
-_ACCEL_MG_LSB_8G                = 0.000976
-_MAG_UT_LSB                     = 0.1
-_SENSORS_GRAVITY_STANDARD       = 9.80665
+_FXOS8700_REGISTER_CTRL_REG1 = const(0x2A)  # 00000000   r/w
+_FXOS8700_REGISTER_CTRL_REG2 = const(0x2B)  # 00000000   r/w
+_FXOS8700_REGISTER_CTRL_REG3 = const(0x2C)  # 00000000   r/w
+_FXOS8700_REGISTER_CTRL_REG4 = const(0x2D)  # 00000000   r/w
+_FXOS8700_REGISTER_CTRL_REG5 = const(0x2E)  # 00000000   r/w
+_FXOS8700_REGISTER_MSTATUS = const(0x32)
+_FXOS8700_REGISTER_MOUT_X_MSB = const(0x33)
+_FXOS8700_REGISTER_MOUT_X_LSB = const(0x34)
+_FXOS8700_REGISTER_MOUT_Y_MSB = const(0x35)
+_FXOS8700_REGISTER_MOUT_Y_LSB = const(0x36)
+_FXOS8700_REGISTER_MOUT_Z_MSB = const(0x37)
+_FXOS8700_REGISTER_MOUT_Z_LSB = const(0x38)
+_FXOS8700_REGISTER_MCTRL_REG1 = const(0x5B)  # 00000000   r/w
+_FXOS8700_REGISTER_MCTRL_REG2 = const(0x5C)  # 00000000   r/w
+_FXOS8700_REGISTER_MCTRL_REG3 = const(0x5D)  # 00000000   r/w
+_ACCEL_MG_LSB_2G = 0.000244
+_ACCEL_MG_LSB_4G = 0.000488
+_ACCEL_MG_LSB_8G = 0.000976
+_MAG_UT_LSB = 0.1
+_SENSORS_GRAVITY_STANDARD = 9.80665
 # pylint: enable=bad-whitespace
 
 # User-facing constants/module-level globals:
@@ -107,19 +107,19 @@ def _twos_comp(val, bits):
 
 class FXOS8700:
     """Driver for the NXP FXOS8700 accelerometer and magnetometer."""
+
     # Class-level buffer for reading and writing data with the sensor.
     # This reduces memory allocations but means the code is not re-entrant or
     # thread safe!
     _BUFFER = bytearray(13)
 
-    def __init__(self, i2c, address=_FXOS8700_ADDRESS,
-                 accel_range=ACCEL_RANGE_2G):
+    def __init__(self, i2c, address=_FXOS8700_ADDRESS, accel_range=ACCEL_RANGE_2G):
         assert accel_range in (ACCEL_RANGE_2G, ACCEL_RANGE_4G, ACCEL_RANGE_8G)
         self._accel_range = accel_range
         self._device = i2c_dev.I2CDevice(i2c, address)
         # Check for chip ID value.
         if self._read_u8(_FXOS8700_REGISTER_WHO_AM_I) != _FXOS8700_ID:
-            raise RuntimeError('Failed to find FXOS8700, check wiring!')
+            raise RuntimeError("Failed to find FXOS8700, check wiring!")
         # Set to standby mode (required to make changes to this register)
         self._write_u8(_FXOS8700_REGISTER_CTRL_REG1, 0)
         if accel_range == ACCEL_RANGE_2G:
@@ -142,8 +142,7 @@ def _read_u8(self, address):
         # Read an 8-bit unsigned value from the specified 8-bit address.
         with self._device as i2c:
             self._BUFFER[0] = address & 0xFF
-            i2c.write_then_readinto(self._BUFFER, self._BUFFER,
-                                    out_end=1, in_end=1)
+            i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=1)
         return self._BUFFER[0]
 
     def _write_u8(self, address, val):
@@ -166,11 +165,10 @@ def read_raw_accel_mag(self):
         # Read accelerometer data from sensor.
         with self._device as i2c:
             self._BUFFER[0] = _FXOS8700_REGISTER_OUT_X_MSB
-            i2c.write_then_readinto(self._BUFFER, self._BUFFER,
-                                    out_end=1, in_end=6)
-        accel_raw_x = struct.unpack_from('>H', self._BUFFER[0:2])[0]
-        accel_raw_y = struct.unpack_from('>H', self._BUFFER[2:4])[0]
-        accel_raw_z = struct.unpack_from('>H', self._BUFFER[4:6])[0]
+            i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=6)
+        accel_raw_x = struct.unpack_from(">H", self._BUFFER[0:2])[0]
+        accel_raw_y = struct.unpack_from(">H", self._BUFFER[2:4])[0]
+        accel_raw_z = struct.unpack_from(">H", self._BUFFER[4:6])[0]
         # Convert accelerometer data to signed 14-bit value from 16-bit
         # left aligned 2's compliment value.
         accel_raw_x = _twos_comp(accel_raw_x >> 2, 14)
@@ -180,13 +178,14 @@ def read_raw_accel_mag(self):
         # 16-bit signed data so struct parsing can handle it directly.
         with self._device as i2c:
             self._BUFFER[0] = _FXOS8700_REGISTER_MOUT_X_MSB
-            i2c.write_then_readinto(self._BUFFER, self._BUFFER,
-                                    out_end=1, in_end=6)
-        mag_raw_x = struct.unpack_from('>h', self._BUFFER[0:2])[0]
-        mag_raw_y = struct.unpack_from('>h', self._BUFFER[2:4])[0]
-        mag_raw_z = struct.unpack_from('>h', self._BUFFER[4:6])[0]
-        return ((accel_raw_x, accel_raw_y, accel_raw_z),
-                (mag_raw_x, mag_raw_y, mag_raw_z))
+            i2c.write_then_readinto(self._BUFFER, self._BUFFER, out_end=1, in_end=6)
+        mag_raw_x = struct.unpack_from(">h", self._BUFFER[0:2])[0]
+        mag_raw_y = struct.unpack_from(">h", self._BUFFER[2:4])[0]
+        mag_raw_z = struct.unpack_from(">h", self._BUFFER[4:6])[0]
+        return (
+            (accel_raw_x, accel_raw_y, accel_raw_z),
+            (mag_raw_x, mag_raw_y, mag_raw_z),
+        )
 
     @property
     def accelerometer(self):

docs/conf.py

@@ -2,47 +2,55 @@
 
 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",
 ]
 
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
 # autodoc_mock_imports = ["adafruit_bus_device", "micropython"]
 
-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),
+}
 
 # 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 FXOS8700 Library'
-copyright = u'2017 Tony DiCola'
-author = u'Tony DiCola'
+project = u"Adafruit FXOS8700 Library"
+copyright = u"2017 Tony DiCola"
+author = u"Tony DiCola"
 
 # 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.
@@ -54,7 +62,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.
@@ -66,7 +74,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
@@ -80,68 +88,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 = 'AdafruitFXOS8700Librarydoc'
+htmlhelp_basename = "AdafruitFXOS8700Librarydoc"
 
 # -- 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, 'AdafruitFXOS8700Library.tex', u'Adafruit FXOS8700 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitFXOS8700Library.tex",
+        u"Adafruit FXOS8700 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, 'adafruitFXOS8700library', u'Adafruit FXOS8700 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "adafruitFXOS8700library",
+        u"Adafruit FXOS8700 Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -150,7 +166,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitFXOS8700Library', u'Adafruit FXOS8700 Library Documentation',
-     author, 'AdafruitFXOS8700Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitFXOS8700Library",
+        u"Adafruit FXOS8700 Library Documentation",
+        author,
+        "AdafruitFXOS8700Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]