From 51e2d53d3bafa046068dfc153a9a443677b578e2 Mon Sep 17 00:00:00 2001 From: dherrada Date: Sun, 15 Mar 2020 14:49:07 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_tlc59711.py | 20 +++--- docs/conf.py | 110 +++++++++++++++++++------------- examples/tlc59711_simpletest.py | 8 +-- setup.py | 48 ++++++-------- 5 files changed, 99 insertions(+), 89 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..1dad804 100644 --- a/.github/workflows/build.yml +++ b/.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 diff --git a/adafruit_tlc59711.py b/adafruit_tlc59711.py index e056ab9..4693d5d 100644 --- a/adafruit_tlc59711.py +++ b/adafruit_tlc59711.py @@ -48,21 +48,21 @@ # Globally disable invalid-name check as this chip by design has short channel # and register names. It is confusing to rename these from what the datasheet # refers to them as. -#pylint: disable=invalid-name +# pylint: disable=invalid-name # Globally disable too many instance attributes check. Again this is a case # where pylint doesn't have the right context to make this call. The chip by # design has many channels which must be exposed. -#pylint: disable=too-many-instance-attributes +# pylint: disable=too-many-instance-attributes # Globally disable protected access. Once again pylint can't figure out the # context for using internal decorate classes below. In these cases protectected # access is by design for the internal class. -#pylint: disable=protected-access +# pylint: disable=protected-access # Yet another pylint issue, it fails to recognize a decorator class by # definition has no public methods. Disable the check. -#pylint: disable=too-few-public-methods +# pylint: disable=too-few-public-methods def _shift_in(target_byte, val): @@ -104,14 +104,15 @@ def __init__(self, byte_offset): def __get__(self, obj, obj_type): # Grab the 16-bit value at the offset for this channel. - return (obj._shift_reg[self._byte_offset] << 8) | \ - obj._shift_reg[self._byte_offset+1] + return (obj._shift_reg[self._byte_offset] << 8) | obj._shift_reg[ + self._byte_offset + 1 + ] def __set__(self, obj, val): # Set the 16-bit value at the offset for this channel. assert 0 <= val <= 65535 obj._shift_reg[self._byte_offset] = (val >> 8) & 0xFF - obj._shift_reg[self._byte_offset+1] = val & 0xFF + obj._shift_reg[self._byte_offset + 1] = val & 0xFF # Write out the new values if auto_show is enabled. if obj.auto_show: obj._write() @@ -138,7 +139,6 @@ def __set__(self, obj, val): g0 = _GS_Value(24) r0 = _GS_Value(26) - def __init__(self, spi, *, auto_show=True): self._spi = spi # This device is just a big 28 byte long shift register without any @@ -288,8 +288,8 @@ def __setitem__(self, key, val): 3-tuple of R, G, B values that are each 16-bit numbers (0-65535). """ assert 0 <= key <= 3 # Do this check here instead of later to - # prevent accidentally keeping auto_show - # turned off when a bad key is provided. + # prevent accidentally keeping auto_show + # turned off when a bad key is provided. assert len(val) == 3 assert 0 <= val[0] <= 65535 assert 0 <= val[1] <= 65535 diff --git a/docs/conf.py b/docs/conf.py index 758e419..ad5b147 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,9 +11,9 @@ # 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 @@ -20,29 +21,32 @@ # autodoc module docs will fail to generate with a warning. # autodoc_mock_imports = ["digitalio", "busio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", 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 TLC59711 Library' -copyright = u'2017 Tony DiCola' -author = u'Tony DiCola' +project = u"Adafruit TLC59711 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 +58,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 +70,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,59 +84,62 @@ # 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 = 'AdafruitTlc59711Librarydoc' +htmlhelp_basename = "AdafruitTlc59711Librarydoc" # -- 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, 'AdafruitTLC59711Library.tex', u'AdafruitTLC59711 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitTLC59711Library.tex", + u"AdafruitTLC59711 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -140,8 +147,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitTLC59711library', u'Adafruit TLC59711 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitTLC59711library", + u"Adafruit TLC59711 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -150,7 +162,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitTLC59711Library', u'Adafruit TLC59711 Library Documentation', - author, 'AdafruitTLC59711Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitTLC59711Library", + u"Adafruit TLC59711 Library Documentation", + author, + "AdafruitTLC59711Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/tlc59711_simpletest.py b/examples/tlc59711_simpletest.py index 0c9157a..8db3176 100644 --- a/examples/tlc59711_simpletest.py +++ b/examples/tlc59711_simpletest.py @@ -17,7 +17,7 @@ # as soon as any channel value is written. The default is True/on but you can # disable and explicitly call show to control when updates happen for better # animation or atomic RGB LED updates. -#leds = adafruit_tlc59711.TLC59711(spi, auto_show=False) +# leds = adafruit_tlc59711.TLC59711(spi, auto_show=False) # There are a couple ways to control the channels of the chip. # The first is using an interface like a strip of NeoPixels. Index into the @@ -27,7 +27,7 @@ # For example set channel 0 (R0, G0, B0) to half brightness: leds[0] = (32767, 32767, 32767) # Dont forget to call show if you disabled auto_show above. -#leds.show() +# leds.show() # Or to set channel 1 to full red only (green and blue off). leds[1] = (65535, 0, 0) @@ -37,7 +37,7 @@ # For example set channel 2 to full green (i.e. G2 to maximum): leds.g2 = 65535 # Again don't forget to call show if you disabled auto_show above. -#leds.show() +# leds.show() # The chip also supports global brightness channels to change the red, green, # blue colors of all 4 channels at once. These are 7-bit values that range @@ -47,4 +47,4 @@ # For example set the red channel to half brightness globally. leds.red_brightness = 63 # Don't forget to call show if you disabled auto_show above. -#leds.show() +# leds.show() diff --git a/setup.py b/setup.py index 4f9b4a5..6c810d4 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,7 @@ # Always prefer setuptools over distutils from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -14,47 +15,38 @@ 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-tlc59711', - + name="adafruit-circuitpython-tlc59711", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for TLC59711 16-bit 12 channel LED PWM driver.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for TLC59711 16-bit 12 channel LED PWM driver.", 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_TLC59711', - + url="https://github.com/adafruit/Adafruit_CircuitPython_TLC59711", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", install_requires=[], - # 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 tlc59711 16-bit 12-channel led pwm hardware micropython circuitpython', - + keywords="adafruit tlc59711 16-bit 12-channel led pwm 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_tlc59711'], + py_modules=["adafruit_tlc59711"], )