Merge pull request #13 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_mcp4725.py

@@ -63,7 +63,6 @@ class MCP4725:
     :param int address: The address of the device if set differently from the default.
     """
 
-
     # Global buffer to prevent allocations and heap fragmentation.
     # Note this is not thread-safe or re-entrant by design!
     _BUFFER = bytearray(3)
@@ -92,7 +91,7 @@ def _read(self):
         # Read 3 bytes from device.
         with self._i2c as i2c:
             i2c.readinto(self._BUFFER)
-         # Grab the DAC value from last two bytes.
+        # Grab the DAC value from last two bytes.
         dac_high = self._BUFFER[1]
         dac_low = self._BUFFER[2] >> 4
         # Reconstruct 12-bit value and return it.
@@ -134,7 +133,7 @@ def raw_value(self, val):
     def normalized_value(self):
         """The DAC value as a floating point number in the range 0.0 to 1.0.
         """
-        return self._read()/4095.0
+        return self._read() / 4095.0
 
     @normalized_value.setter
     def normalized_value(self, val):

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 = ["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 MCP4725 Library'
-copyright = u'2017 Tony DiCola'
-author = u'Tony DiCola'
+project = u"Adafruit MCP4725 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 = 'AdafruitMcp4725Librarydoc'
+htmlhelp_basename = "AdafruitMcp4725Librarydoc"
 
 # -- 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, 'AdafruitMCP4725Library.tex', u'AdafruitMCP4725 Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitMCP4725Library.tex",
+        u"AdafruitMCP4725 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, 'AdafruitMCP4725library', u'Adafruit MCP4725 Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitMCP4725library",
+        u"Adafruit MCP4725 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, 'AdafruitMCP4725Library', u'Adafruit MCP4725 Library Documentation',
-     author, 'AdafruitMCP4725Library', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitMCP4725Library",
+        u"Adafruit MCP4725 Library Documentation",
+        author,
+        "AdafruitMCP4725Library",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/mcp4725_simpletest.py

@@ -13,30 +13,30 @@
 # Initialize MCP4725.
 dac = adafruit_mcp4725.MCP4725(i2c)
 # Optionally you can specify a different addres if you override the A0 pin.
-#amp = adafruit_max9744.MAX9744(i2c, address=0x63)
+# amp = adafruit_max9744.MAX9744(i2c, address=0x63)
 
 # There are a three ways to set the DAC output, you can use any of these:
 dac.value = 65535  # Use the value property with a 16-bit number just like
-                   # the AnalogOut class.  Note the MCP4725 is only a 12-bit
-                   # DAC so quantization errors will occur.  The range of
-                   # values is 0 (minimum/ground) to 65535 (maximum/Vout).
+# the AnalogOut class.  Note the MCP4725 is only a 12-bit
+# DAC so quantization errors will occur.  The range of
+# values is 0 (minimum/ground) to 65535 (maximum/Vout).
 
 dac.raw_value = 4095  # Use the raw_value property to directly read and write
-                      # the 12-bit DAC value.  The range of values is
-                      # 0 (minimum/ground) to 4095 (maximum/Vout).
+# the 12-bit DAC value.  The range of values is
+# 0 (minimum/ground) to 4095 (maximum/Vout).
 
 dac.normalized_value = 1.0  # Use the normalized_value property to set the
-                            # output with a floating point value in the range
-                            # 0 to 1.0 where 0 is minimum/ground and 1.0 is
-                            # maximum/Vout.
+# output with a floating point value in the range
+# 0 to 1.0 where 0 is minimum/ground and 1.0 is
+# maximum/Vout.
 
 # Main loop will go up and down through the range of DAC values forever.
 while True:
     # Go up the 12-bit raw range.
-    print('Going up 0-3.3V...')
+    print("Going up 0-3.3V...")
     for i in range(4095):
         dac.raw_value = i
     # Go back down the 12-bit raw range.
-    print('Going down 3.3-0V...')
+    print("Going down 3.3-0V...")
     for i in range(4095, -1, -1):
         dac.raw_value = i

setup.py

@@ -7,54 +7,46 @@
 
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
+
 # To use a consistent encoding
 from codecs import open
 from os import path
 
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, "README.rst"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-mcp4725',
-
+    name="adafruit-circuitpython-mcp4725",
     use_scm_version=True,
-    setup_requires=['setuptools_scm'],
-
-    description='CircuitPython library for MCP4725 digital to analog converter.',
+    setup_requires=["setuptools_scm"],
+    description="CircuitPython library for MCP4725 digital to analog converter.",
     long_description=long_description,
-    long_description_content_type='text/x-rst',
-
+    long_description_content_type="text/x-rst",
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_MCP4725',
-
+    url="https://github.com/adafruit/Adafruit_CircuitPython_MCP4725",
     # Author details
-    author='Adafruit Industries',
-    author_email='[email protected]',
-
-    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
-
+    author="Adafruit Industries",
+    author_email="[email protected]",
+    install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"],
     # Choose your license
-    license='MIT',
-
+    license="MIT",
     # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Topic :: Software Development :: Libraries',
-        'Topic :: System :: Hardware',
-        'License :: OSI Approved :: MIT License',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Topic :: Software Development :: Libraries",
+        "Topic :: System :: Hardware",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
     ],
-
     # What does your project relate to?
-    keywords='adafruit mcp4725 digital analog converter dac hardware micropython circuitpython',
-
+    keywords="adafruit mcp4725 digital analog converter dac hardware micropython circuitpython",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    py_modules=['adafruit_mcp4725'],
+    py_modules=["adafruit_mcp4725"],
 )