From c77feb9ffcb53822caaebb45f765792adf7c4375 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 16 Mar 2020 16:28:27 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- .pylintrc | 3 +- docs/conf.py | 110 ++++++++++++++++------------ examples/neopixel_pixel.py | 10 +-- examples/neopixel_rpi_simpletest.py | 19 ++--- examples/neopixel_simpletest.py | 21 +++--- neopixel.py | 27 ++++--- setup.py | 52 ++++++------- 8 files changed, 133 insertions(+), 111 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 64e267a..bd0d5ea 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/.pylintrc b/.pylintrc index cd65e95..d8f0ee8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -119,7 +119,8 @@ 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 [TYPECHECK] diff --git a/docs/conf.py b/docs/conf.py index 0f0fa60..dfc6cc6 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,36 +11,39 @@ # 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", ] autodoc_mock_imports = ["neopixel_write"] -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 CircuitPython NeoPixel Library' -copyright = u'2017 Scott Shawcroft & Damien P. George' -author = u'Scott Shawcroft & Damien P. George' +project = u"Adafruit CircuitPython NeoPixel Library" +copyright = u"2017 Scott Shawcroft & Damien P. George" +author = u"Scott Shawcroft & Damien P. George" # 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. @@ -51,7 +55,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. @@ -63,7 +67,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 @@ -76,59 +80,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 = 'AdafruitNEOPIXEL2Librarydoc' +htmlhelp_basename = "AdafruitNEOPIXEL2Librarydoc" # -- 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, 'AdafruitNeoPixelLibrary.tex', u'Adafruit NeoPixel Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitNeoPixelLibrary.tex", + u"Adafruit NeoPixel Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -136,8 +143,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'adafruitneoPixellibrary', u'Adafruit NeoPixel Library Documentation', - [author], 1) + ( + master_doc, + "adafruitneoPixellibrary", + u"Adafruit NeoPixel Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -146,7 +158,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitNeoPixelLibrary', u'Adafruit NeoPixel Library Documentation', - author, 'AdafruitNeoPixelLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitNeoPixelLibrary", + u"Adafruit NeoPixel Library Documentation", + author, + "AdafruitNeoPixelLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/neopixel_pixel.py b/examples/neopixel_pixel.py index f62813d..649da3d 100644 --- a/examples/neopixel_pixel.py +++ b/examples/neopixel_pixel.py @@ -7,11 +7,11 @@ import neopixel # Configure the setup -PIXEL_PIN = board.D1 # pin that the NeoPixel is connected to -ORDER = neopixel.RGB # pixel color channel order -COLOR = (100, 50, 150) # color to blink -CLEAR = (0, 0, 0) # clear (or second color) -DELAY = 0.25 # blink rate in seconds +PIXEL_PIN = board.D1 # pin that the NeoPixel is connected to +ORDER = neopixel.RGB # pixel color channel order +COLOR = (100, 50, 150) # color to blink +CLEAR = (0, 0, 0) # clear (or second color) +DELAY = 0.25 # blink rate in seconds # Create the NeoPixel object pixel = neopixel.NeoPixel(PIXEL_PIN, 1, pixel_order=ORDER) diff --git a/examples/neopixel_rpi_simpletest.py b/examples/neopixel_rpi_simpletest.py index 11711ef..5770917 100644 --- a/examples/neopixel_rpi_simpletest.py +++ b/examples/neopixel_rpi_simpletest.py @@ -15,8 +15,9 @@ # For RGBW NeoPixels, simply change the ORDER to RGBW or GRBW. ORDER = neopixel.GRB -pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.2, auto_write=False, - pixel_order=ORDER) +pixels = neopixel.NeoPixel( + pixel_pin, num_pixels, brightness=0.2, auto_write=False, pixel_order=ORDER +) def wheel(pos): @@ -26,19 +27,19 @@ def wheel(pos): r = g = b = 0 elif pos < 85: r = int(pos * 3) - g = int(255 - pos*3) + g = int(255 - pos * 3) b = 0 elif pos < 170: pos -= 85 - r = int(255 - pos*3) + r = int(255 - pos * 3) g = 0 - b = int(pos*3) + b = int(pos * 3) else: pos -= 170 r = 0 - g = int(pos*3) - b = int(255 - pos*3) - return (r, g, b) if ORDER == neopixel.RGB or ORDER == neopixel.GRB else (r, g, b, 0) + g = int(pos * 3) + b = int(255 - pos * 3) + return (r, g, b) if ORDER in (neopixel.RGB, neopixel.GRB) else (r, g, b, 0) def rainbow_cycle(wait): @@ -72,4 +73,4 @@ def rainbow_cycle(wait): pixels.show() time.sleep(1) - rainbow_cycle(0.001) # rainbow cycle with 1ms delay per step + rainbow_cycle(0.001) # rainbow cycle with 1ms delay per step diff --git a/examples/neopixel_simpletest.py b/examples/neopixel_simpletest.py index 3fe1039..e436355 100644 --- a/examples/neopixel_simpletest.py +++ b/examples/neopixel_simpletest.py @@ -8,7 +8,7 @@ pixel_pin = board.NEOPIXEL # On a Raspberry pi, use this instead, not all pins are supported -#pixel_pin = board.D18 +# pixel_pin = board.D18 # The number of NeoPixels num_pixels = 10 @@ -17,8 +17,9 @@ # For RGBW NeoPixels, simply change the ORDER to RGBW or GRBW. ORDER = neopixel.GRB -pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.2, auto_write=False, - pixel_order=ORDER) +pixels = neopixel.NeoPixel( + pixel_pin, num_pixels, brightness=0.2, auto_write=False, pixel_order=ORDER +) def wheel(pos): @@ -28,19 +29,19 @@ def wheel(pos): r = g = b = 0 elif pos < 85: r = int(pos * 3) - g = int(255 - pos*3) + g = int(255 - pos * 3) b = 0 elif pos < 170: pos -= 85 - r = int(255 - pos*3) + r = int(255 - pos * 3) g = 0 - b = int(pos*3) + b = int(pos * 3) else: pos -= 170 r = 0 - g = int(pos*3) - b = int(255 - pos*3) - return (r, g, b) if ORDER == neopixel.RGB or ORDER == neopixel.GRB else (r, g, b, 0) + g = int(pos * 3) + b = int(255 - pos * 3) + return (r, g, b) if ORDER in (neopixel.RGB, neopixel.GRB) else (r, g, b, 0) def rainbow_cycle(wait): @@ -74,4 +75,4 @@ def rainbow_cycle(wait): pixels.show() time.sleep(1) - rainbow_cycle(0.001) # rainbow cycle with 1ms delay per step + rainbow_cycle(0.001) # rainbow cycle with 1ms delay per step diff --git a/neopixel.py b/neopixel.py index 9840700..8999733 100644 --- a/neopixel.py +++ b/neopixel.py @@ -46,6 +46,7 @@ GRBW = (1, 0, 2, 3) """Green Red Blue White""" + class NeoPixel: """ A sequence of neopixels. @@ -87,7 +88,10 @@ class NeoPixel: pixels[::2] = [RED] * (len(pixels) // 2) time.sleep(2) """ - def __init__(self, pin, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None): + + def __init__( + self, pin, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None + ): self.pin = digitalio.DigitalInOut(pin) self.pin.direction = digitalio.Direction.OUTPUT self.n = n @@ -131,11 +135,11 @@ def _set_item(self, index, value): b = 0 w = 0 if isinstance(value, int): - if value>>24: + if value >> 24: raise ValueError("only bits 0->23 valid for integer input") r = value >> 16 - g = (value >> 8) & 0xff - b = value & 0xff + g = (value >> 8) & 0xFF + b = value & 0xFF w = 0 # If all components are the same and we have a white pixel then use it # instead of the individual components. @@ -178,16 +182,19 @@ def __getitem__(self, index): if isinstance(index, slice): out = [] for in_i in range(*index.indices(len(self.buf) // self.bpp)): - out.append(tuple(self.buf[in_i * self.bpp + self.order[i]] - for i in range(self.bpp))) + out.append( + tuple( + self.buf[in_i * self.bpp + self.order[i]] + for i in range(self.bpp) + ) + ) return out if index < 0: index += len(self) if index >= self.n or index < 0: raise IndexError offset = index * self.bpp - return tuple(self.buf[offset + self.order[i]] - for i in range(self.bpp)) + return tuple(self.buf[offset + self.order[i]] for i in range(self.bpp)) def __len__(self): return len(self.buf) // self.bpp @@ -229,4 +236,6 @@ def show(self): if self.brightness > 0.99: neopixel_write(self.pin, self.buf) else: - neopixel_write(self.pin, bytearray([int(i * self.brightness) for i in self.buf])) + neopixel_write( + self.pin, bytearray([int(i * self.brightness) for i in self.buf]) + ) diff --git a/setup.py b/setup.py index b2eb264..2803423 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-neopixel', - + name="adafruit-circuitpython-neopixel", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library for NeoPixel LEDs.', + setup_requires=["setuptools_scm"], + description="CircuitPython library for NeoPixel LEDs.", 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_NeoPixel', - + url="https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel", # Author details - author='Adafruit Industries & Damien P. George', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka'], - + author="Adafruit Industries & Damien P. George", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # 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 neopixel rgb rgbw led hardware micropython circuitpython', - + keywords="adafruit neopixel rgb rgbw led hardware micropython circuitpython", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['neopixel'], -) \ No newline at end of file + py_modules=["neopixel"], +)