Merge pull request #10 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_touchscreen.py

@@ -46,25 +46,37 @@
 from digitalio import DigitalInOut
 from analogio import AnalogIn
 
+
 def map_range(x, in_min, in_max, out_min, out_max):
     """
     Maps a number from one range to another.
     Note: This implementation handles values < in_min differently than arduino's map function does.
     :return: Returns value mapped to new range
     :rtype: float
     """
-    mapped = (x-in_min) * (out_max - out_min) / (in_max-in_min) + out_min
+    mapped = (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min
     if out_min <= out_max:
         return max(min(mapped, out_max), out_min)
     return min(max(mapped, out_max), out_min)
 
+
 class Touchscreen:
     """A driver for common and inexpensive resistive touchscreens. Analog input
     capable pins are required to read the intrinsic potentiometers"""
 
-    def __init__(self, x1_pin, x2_pin, y1_pin, y2_pin, *,
-                 x_resistance=None, samples=4, z_threshhold=10000,
-                 calibration=None, size=None):
+    def __init__(
+        self,
+        x1_pin,
+        x2_pin,
+        y1_pin,
+        y2_pin,
+        *,
+        x_resistance=None,
+        samples=4,
+        z_threshhold=10000,
+        calibration=None,
+        size=None
+    ):
         """Create the Touchscreen object. At a minimum you need the 4 pins
         that will connect to the 4 contacts on a screen. X and Y are just our
         names, you can rotate and flip the data if you like. All pins must be
@@ -98,7 +110,7 @@ def __init__(self, x1_pin, x2_pin, y1_pin, y2_pin, *,
         self._zthresh = z_threshhold
 
     @property
-    def touch_point(self): # pylint: disable=too-many-locals
+    def touch_point(self):  # pylint: disable=too-many-locals
         """A tuple that represents the x, y and z (touch pressure) coordinates
         of a touch. Or, None if no touch is detected"""
         with DigitalInOut(self._yp_pin) as y_p:
@@ -136,8 +148,8 @@ def touch_point(self): # pylint: disable=too-many-locals
                     z_1 = x_m.value
                 with AnalogIn(self._yp_pin) as y_p:
                     z_2 = y_p.value
-        #print(z_1, z_2)
-        z = 65535 - (z_2-z_1)
+        # print(z_1, z_2)
+        z = 65535 - (z_2 - z_1)
         if z > self._zthresh:
             return (x, y, z)
         return None

docs/conf.py

@@ -2,18 +2,19 @@
 
 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.napoleon',
-    'sphinx.ext.todo',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
 ]
 
 # TODO: Please Read!
@@ -23,29 +24,32 @@
 autodoc_mock_imports = ["analogio"]
 
 
-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 Touchscreen Library'
-copyright = u'2019 ladyada'
-author = u'ladyada'
+project = u"Adafruit Touchscreen Library"
+copyright = u"2019 ladyada"
+author = u"ladyada"
 
 # 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.
@@ -57,7 +61,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.
@@ -69,7 +73,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
@@ -84,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 = 'AdafruitTouchscreenLibrarydoc'
+htmlhelp_basename = "AdafruitTouchscreenLibrarydoc"
 
 # -- 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, 'AdafruitTouchscreenLibrary.tex', u'AdafruitTouchscreen Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitTouchscreenLibrary.tex",
+        u"AdafruitTouchscreen 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, 'AdafruitTouchscreenlibrary', u'Adafruit Touchscreen Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitTouchscreenlibrary",
+        u"Adafruit Touchscreen Library Documentation",
+        [author],
+        1,
+    )
 ]
 
 # -- Options for Texinfo output -------------------------------------------
@@ -154,7 +166,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'AdafruitTouchscreenLibrary', u'Adafruit Touchscreen Library Documentation',
-     author, 'AdafruitTouchscreenLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitTouchscreenLibrary",
+        u"Adafruit Touchscreen Library Documentation",
+        author,
+        "AdafruitTouchscreenLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]

examples/touchscreen_orientation.py

@@ -8,31 +8,47 @@
 
 if rotation == 0:
     # -------Rotate 0:
-    ts = adafruit_touchscreen.Touchscreen(board.TOUCH_XL, board.TOUCH_XR,
-                                          board.TOUCH_YD, board.TOUCH_YU,
-                                          calibration=((5200, 59000), (5800, 57000)),
-                                          size=(320, 240))
+    ts = adafruit_touchscreen.Touchscreen(
+        board.TOUCH_XL,
+        board.TOUCH_XR,
+        board.TOUCH_YD,
+        board.TOUCH_YU,
+        calibration=((5200, 59000), (5800, 57000)),
+        size=(320, 240),
+    )
 
 if rotation == 90:
     # -------Rotate 90:
-    ts = adafruit_touchscreen.Touchscreen(board.TOUCH_YU, board.TOUCH_YD,
-                                          board.TOUCH_XL, board.TOUCH_XR,
-                                          calibration=((5200, 59000), (5800, 57000)),
-                                          size=(240, 320))
+    ts = adafruit_touchscreen.Touchscreen(
+        board.TOUCH_YU,
+        board.TOUCH_YD,
+        board.TOUCH_XL,
+        board.TOUCH_XR,
+        calibration=((5200, 59000), (5800, 57000)),
+        size=(240, 320),
+    )
 
 if rotation == 180:
     # ------Rotate 180:
-    ts = adafruit_touchscreen.Touchscreen(board.TOUCH_XR, board.TOUCH_XL,
-                                          board.TOUCH_YU, board.TOUCH_YD,
-                                          calibration=((5200, 59000), (5800, 57000)),
-                                          size=(320, 240))
+    ts = adafruit_touchscreen.Touchscreen(
+        board.TOUCH_XR,
+        board.TOUCH_XL,
+        board.TOUCH_YU,
+        board.TOUCH_YD,
+        calibration=((5200, 59000), (5800, 57000)),
+        size=(320, 240),
+    )
 
 if rotation == 270:
     # ------Rotate 270:
-    ts = adafruit_touchscreen.Touchscreen(board.TOUCH_YD, board.TOUCH_YU,
-                                          board.TOUCH_XR, board.TOUCH_XL,
-                                          calibration=((5200, 59000), (5800, 57000)),
-                                          size=(240, 320))
+    ts = adafruit_touchscreen.Touchscreen(
+        board.TOUCH_YD,
+        board.TOUCH_YU,
+        board.TOUCH_XR,
+        board.TOUCH_XL,
+        calibration=((5200, 59000), (5800, 57000)),
+        size=(240, 320),
+    )
 
 while True:
     p = ts.touch_point

examples/touchscreen_simpletest.py

@@ -3,10 +3,14 @@
 
 # These pins are used as both analog and digital! XL, XR and YU must be analog
 # and digital capable. YD just need to be digital
-ts = adafruit_touchscreen.Touchscreen(board.TOUCH_XL, board.TOUCH_XR,
-                                      board.TOUCH_YD, board.TOUCH_YU,
-                                      calibration=((5200, 59000), (5800, 57000)),
-                                      size=(320, 240))
+ts = adafruit_touchscreen.Touchscreen(
+    board.TOUCH_XL,
+    board.TOUCH_XR,
+    board.TOUCH_YD,
+    board.TOUCH_YU,
+    calibration=((5200, 59000), (5800, 57000)),
+    size=(320, 240),
+)
 
 while True:
     p = ts.touch_point