From fb45955e9ad5659be6ba5c83c9805e5794513af8 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 16 Mar 2020 16:30:57 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- .pylintrc | 3 +- docs/conf.py | 110 +++++++++++++--------- examples/simpleio_map_range_simpletest.py | 6 +- examples/simpleio_shift_in_out_demo.py | 4 +- setup.py | 50 +++++----- simpleio.py | 31 +++--- 7 files changed, 111 insertions(+), 95 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca1a0a7..856b828 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 13b496a..3cf6a31 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 = ["pulseio"] -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 SimpleIO Library' -copyright = u'2017 Scott Shawcroft' -author = u'Scott Shawcroft' +project = u"Adafruit CircuitPython SimpleIO Library" +copyright = u"2017 Scott Shawcroft" +author = u"Scott Shawcroft" # 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 @@ -77,59 +81,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 = 'AdafruitSimpleIOLibrarydoc' +htmlhelp_basename = "AdafruitSimpleIOLibrarydoc" # -- 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, 'AdafruitSimpleIOLibrary.tex', u'Adafruit SimpleIO Library Documentation', - u'Scott Shawcroft', 'manual'), + ( + master_doc, + "AdafruitSimpleIOLibrary.tex", + u"Adafruit SimpleIO Library Documentation", + u"Scott Shawcroft", + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -137,8 +144,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'adafruitSimpleIOlibrary', u'Adafruit SimpleIO Library Documentation', - [author], 1) + ( + master_doc, + "adafruitSimpleIOlibrary", + u"Adafruit SimpleIO Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -147,7 +159,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitSimpleIOLibrary', u'Adafruit SimpleIO Library Documentation', - author, 'AdafruitSimpleIOLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitSimpleIOLibrary", + u"Adafruit SimpleIO Library Documentation", + author, + "AdafruitSimpleIOLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/simpleio_map_range_simpletest.py b/examples/simpleio_map_range_simpletest.py index 0fcdef5..e19e3bd 100644 --- a/examples/simpleio_map_range_simpletest.py +++ b/examples/simpleio_map_range_simpletest.py @@ -11,12 +11,12 @@ sensor_value = 150 # Map the sensor's range from 0<=sensor_value<=255 to 0<=sensor_value<=1023 - print('original sensor value: ', sensor_value) + print("original sensor value: ", sensor_value) mapped_value = simpleio.map_range(sensor_value, 0, 255, 0, 1023) - print('mapped sensor value: ', mapped_value) + print("mapped sensor value: ", mapped_value) time.sleep(2) # Map the new sensor value back to the old range sensor_value = simpleio.map_range(mapped_value, 0, 1023, 0, 255) - print('original value returned: ', sensor_value) + print("original value returned: ", sensor_value) time.sleep(2) diff --git a/examples/simpleio_shift_in_out_demo.py b/examples/simpleio_shift_in_out_demo.py index 5b6d978..5542f9c 100644 --- a/examples/simpleio_shift_in_out_demo.py +++ b/examples/simpleio_shift_in_out_demo.py @@ -22,7 +22,7 @@ # shifting 256 bits out of data pin latch.value = False data.direction = digitalio.Direction.OUTPUT - print('shifting out...') + print("shifting out...") simpleio.shift_out(data, clk, data_to_send, msb_first=False) latch.value = True time.sleep(3) @@ -30,6 +30,6 @@ # shifting 256 bits into the data pin latch.value = False data.direction = digitalio.Direction.INPUT - print('shifting in...') + print("shifting in...") simpleio.shift_in(data, clk) time.sleep(3) diff --git a/setup.py b/setup.py index 7568091..df1e407 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-simpleio', - + name="adafruit-circuitpython-simpleio", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython helper library to simplify hardware interactions.', + setup_requires=["setuptools_scm"], + description="CircuitPython helper library to simplify hardware interactions.", 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_SimpleIO', - + url="https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka'], - + author="Adafruit Industries", + 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 simpleio servo map range bitwrite hardware micropython circuitpython', - + keywords="adafruit simpleio servo map range bitwrite hardware micropython circuitpython", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['simpleio'], + py_modules=["simpleio"], ) diff --git a/simpleio.py b/simpleio.py index 61d7c04..270f6e2 100644 --- a/simpleio.py +++ b/simpleio.py @@ -32,6 +32,7 @@ import array import digitalio import pulseio + try: # RawSample was moved in CircuitPython 5.x. if sys.implementation.version[0] >= 5: @@ -44,7 +45,7 @@ except ImportError: from audiopwmio import PWMAudioOut as AudioOut except ImportError: - pass # not always supported by every board! + pass # not always supported by every board! __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/CircuitPython_SimpleIO.git" @@ -63,11 +64,13 @@ def tone(pin, frequency, duration=1, length=100): length = 350000 // frequency try: # pin with PWM - #pylint: disable=no-member - with pulseio.PWMOut(pin, frequency=int(frequency), variable_frequency=False) as pwm: + # pylint: disable=no-member + with pulseio.PWMOut( + pin, frequency=int(frequency), variable_frequency=False + ) as pwm: pwm.duty_cycle = 0x8000 time.sleep(duration) - #pylint: enable=no-member + # pylint: enable=no-member except ValueError: # pin without PWM sample_length = length @@ -83,7 +86,7 @@ def tone(pin, frequency, duration=1, length=100): dac.stop() -def bitWrite(x, n, b): #pylint: disable-msg=invalid-name +def bitWrite(x, n, b): # pylint: disable-msg=invalid-name """ Based on the Arduino bitWrite function, changes a specific bit of a value to 0 or 1. The return value is the original value with the changed bit. @@ -94,7 +97,7 @@ def bitWrite(x, n, b): #pylint: disable-msg=invalid-name :param b: value to write (0 or 1) """ if b == 1: - x |= 1< 32: - raise ValueError('bitcount must be in range 0..32 inclusive') + raise ValueError("bitcount must be in range 0..32 inclusive") if msb_first: - bitsequence = lambda: range(bitcount-1, -1, -1) + bitsequence = lambda: range(bitcount - 1, -1, -1) else: bitsequence = lambda: range(0, bitcount) for i in bitsequence(): - tmpval = bool(value & (1<