From 6709a932f91d099da813dd01ecb26d8c3f0d50a8 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 16 Mar 2020 15:35:17 -0400 Subject: [PATCH] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_motorkit.py | 67 +++++++++----- docs/conf.py | 120 +++++++++++++++---------- examples/motorkit_dual_stepper_test.py | 38 +++++--- examples/motorkit_robot.py | 19 ++-- examples/motorkit_robot_test.py | 2 +- setup.py | 64 +++++++------ 7 files changed, 186 insertions(+), 126 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_motorkit.py b/adafruit_motorkit.py index 114f542..3f7b784 100644 --- a/adafruit_motorkit.py +++ b/adafruit_motorkit.py @@ -63,6 +63,7 @@ class MotorKit: """Class representing an Adafruit DC & Stepper Motor FeatherWing, Shield or Pi Hat kit. Automatically uses the I2C bus on a Feather, Metro or Raspberry Pi.""" + def __init__(self, address=0x60, i2c=None, steppers_microsteps=16): self._motor1 = None self._motor2 = None @@ -80,17 +81,25 @@ def __init__(self, address=0x60, i2c=None, steppers_microsteps=16): # each motor. This saves both code size and the number of raw strings (the error message) # stored. The same technique is a net loss for stepper because there is less duplication. def _motor(self, motor_name, channels, stepper_name): - from adafruit_motor import motor + from adafruit_motor import motor # pylint: disable=import-outside-toplevel + motor_name = "_motor" + str(motor_name) stepper_name = "_stepper" + str(stepper_name) if not getattr(self, motor_name): if getattr(self, stepper_name): raise RuntimeError( - "Cannot use {} at the same time as {}.".format(motor_name[1:], - stepper_name[1:])) - self._pca.channels[channels[0]].duty_cycle = 0xffff - setattr(self, motor_name, motor.DCMotor(self._pca.channels[channels[1]], - self._pca.channels[channels[2]])) + "Cannot use {} at the same time as {}.".format( + motor_name[1:], stepper_name[1:] + ) + ) + self._pca.channels[channels[0]].duty_cycle = 0xFFFF + setattr( + self, + motor_name, + motor.DCMotor( + self._pca.channels[channels[1]], self._pca.channels[channels[2]] + ), + ) return getattr(self, motor_name) @property @@ -222,14 +231,23 @@ def stepper1(self): kit.stepper1.onestep() """ if not self._stepper1: - from adafruit_motor import stepper + from adafruit_motor import ( # pylint: disable=import-outside-toplevel + stepper, + ) + if self._motor1 or self._motor2: - raise RuntimeError("Cannot use stepper1 at the same time as motor1 or motor2.") - self._pca.channels[8].duty_cycle = 0xffff - self._pca.channels[13].duty_cycle = 0xffff - self._stepper1 = stepper.StepperMotor(self._pca.channels[10], self._pca.channels[9], - self._pca.channels[11], self._pca.channels[12], - microsteps=self._steppers_microsteps) + raise RuntimeError( + "Cannot use stepper1 at the same time as motor1 or motor2." + ) + self._pca.channels[8].duty_cycle = 0xFFFF + self._pca.channels[13].duty_cycle = 0xFFFF + self._stepper1 = stepper.StepperMotor( + self._pca.channels[10], + self._pca.channels[9], + self._pca.channels[11], + self._pca.channels[12], + microsteps=self._steppers_microsteps, + ) return self._stepper1 @property @@ -257,12 +275,21 @@ def stepper2(self): kit.stepper2.onestep() """ if not self._stepper2: - from adafruit_motor import stepper + from adafruit_motor import ( # pylint: disable=import-outside-toplevel + stepper, + ) + if self._motor3 or self._motor4: - raise RuntimeError("Cannot use stepper2 at the same time as motor3 or motor4.") - self._pca.channels[7].duty_cycle = 0xffff - self._pca.channels[2].duty_cycle = 0xffff - self._stepper2 = stepper.StepperMotor(self._pca.channels[4], self._pca.channels[3], - self._pca.channels[5], self._pca.channels[6], - microsteps=self._steppers_microsteps) + raise RuntimeError( + "Cannot use stepper2 at the same time as motor3 or motor4." + ) + self._pca.channels[7].duty_cycle = 0xFFFF + self._pca.channels[2].duty_cycle = 0xFFFF + self._stepper2 = stepper.StepperMotor( + self._pca.channels[4], + self._pca.channels[3], + self._pca.channels[5], + self._pca.channels[6], + microsteps=self._steppers_microsteps, + ) return self._stepper2 diff --git a/docs/conf.py b/docs/conf.py index 0cb78d0..c707684 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,10 +11,10 @@ # 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,40 @@ # autodoc_mock_imports = ["digitalio", "busio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/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, + ), + "Register": ( + "https://circuitpython.readthedocs.io/projects/register/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 MotorKit Library' -copyright = u'2018 Kattni Rembor' -author = u'Kattni Rembor' +project = u"Adafruit MotorKit Library" +copyright = u"2018 Kattni Rembor" +author = u"Kattni Rembor" # 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 +69,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 +81,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,59 +96,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 = 'AdafruitMotorkitLibrarydoc' +htmlhelp_basename = "AdafruitMotorkitLibrarydoc" # -- 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, 'AdafruitMotorKitLibrary.tex', u'AdafruitMotorKit Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitMotorKitLibrary.tex", + u"AdafruitMotorKit Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +159,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitMotorKitlibrary', u'Adafruit MotorKit Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitMotorKitlibrary", + u"Adafruit MotorKit Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +174,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitMotorKitLibrary', u'Adafruit MotorKit Library Documentation', - author, 'AdafruitMotorKitLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitMotorKitLibrary", + u"Adafruit MotorKit Library Documentation", + author, + "AdafruitMotorKitLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/motorkit_dual_stepper_test.py b/examples/motorkit_dual_stepper_test.py index 7eb0c92..2faf71b 100644 --- a/examples/motorkit_dual_stepper_test.py +++ b/examples/motorkit_dual_stepper_test.py @@ -13,8 +13,8 @@ kit = MotorKit() # create empty threads (these will hold the stepper 1 and 2 threads) -st1 = threading.Thread() -st2 = threading.Thread() +st1 = threading.Thread() # pylint: disable=bad-thread-instantiation +st2 = threading.Thread() # pylint: disable=bad-thread-instantiation # recommended for auto-disabling motors on shutdown! @@ -29,10 +29,10 @@ def turnOffMotors(): def stepper_worker(stepper, numsteps, direction, style): - #print("Steppin!") + # print("Steppin!") for _ in range(numsteps): stepper.onestep(direction=direction, style=style) - #print("Done") + # print("Done") while True: @@ -47,10 +47,15 @@ def stepper_worker(stepper, numsteps, direction, style): print("backward") randomsteps = random.randint(10, 50) print("%d steps" % randomsteps) - st1 = threading.Thread(target=stepper_worker, args=(kit.stepper1, - randomsteps, - move_dir, - stepstyles[random.randint(0, 3)],)) + st1 = threading.Thread( + target=stepper_worker, + args=( + kit.stepper1, + randomsteps, + move_dir, + stepstyles[random.randint(0, 3)], + ), + ) st1.start() if not st2.isAlive(): @@ -64,11 +69,16 @@ def stepper_worker(stepper, numsteps, direction, style): print("backward") randomsteps = random.randint(10, 50) print("%d steps" % randomsteps) - st2 = threading.Thread(target=stepper_worker, args=(kit.stepper2, - randomsteps, - move_dir, - stepstyles[random.randint(0, 3)],)) + st2 = threading.Thread( + target=stepper_worker, + args=( + kit.stepper2, + randomsteps, + move_dir, + stepstyles[random.randint(0, 3)], + ), + ) st2.start() - time.sleep(0.1) # Small delay to stop from constantly polling threads - # see: https://forums.adafruit.com/viewtopic.php?f=50&t=104354&p=562733#p562733 + time.sleep(0.1) # Small delay to stop from constantly polling threads + # see: https://forums.adafruit.com/viewtopic.php?f=50&t=104354&p=562733#p562733 diff --git a/examples/motorkit_robot.py b/examples/motorkit_robot.py index b8371e1..7bed7d1 100644 --- a/examples/motorkit_robot.py +++ b/examples/motorkit_robot.py @@ -12,7 +12,6 @@ # This assumes the Left motor is on Motor 1 and the Right motor is on Motor 2 - import time import atexit from adafruit_motorkit import MotorKit @@ -41,7 +40,7 @@ def __init__(self, left_trim=0, right_trim=0, stop_at_exit=True): def _left_speed(self, speed): """Set the speed of the left motor, taking into account its trim offset. """ - assert -1 <= speed <= 1, 'Speed must be a value between -1 to 1 inclusive!' + assert -1 <= speed <= 1, "Speed must be a value between -1 to 1 inclusive!" speed += self._left_trim speed = max(-1, min(1, speed)) # Constrain speed to 0-255 after trimming. kit.motor1.throttle = speed @@ -49,7 +48,7 @@ def _left_speed(self, speed): def _right_speed(self, speed): """Set the speed of the right motor, taking into account its trim offset. """ - assert -1 <= speed <= 1, 'Speed must be a value between -1 to 1 inclusive!' + assert -1 <= speed <= 1, "Speed must be a value between -1 to 1 inclusive!" speed += self._right_trim speed = max(-1, min(1, speed)) # Constrain speed to 0-255 after trimming. kit.motor2.throttle = speed @@ -76,10 +75,12 @@ def forward(self, speed, seconds=None): def steer(self, speed, direction): # Move forward at the specified speed (0- 1). Direction is +- 1. # Full left is -1, Full right is +1 - if (speed + direction/2) > 1: - speed = speed - direction/2 # calibrate so total motor output never goes above 1 - left = speed + direction/2 - right = speed - direction/2 + if (speed + direction / 2) > 1: + speed = ( + speed - direction / 2 + ) # calibrate so total motor output never goes above 1 + left = speed + direction / 2 + right = speed - direction / 2 self._left_speed(left) self._right_speed(right) @@ -89,8 +90,8 @@ def backward(self, speed, seconds=None): case the robot will move backward for that amount of time and then stop. """ # Set motor speed and move both backward. - self._left_speed(-1*speed) - self._right_speed(-1*speed) + self._left_speed(-1 * speed) + self._right_speed(-1 * speed) # If an amount of time is specified, move for that time and then stop. if seconds is not None: time.sleep(seconds) diff --git a/examples/motorkit_robot_test.py b/examples/motorkit_robot_test.py index 69d5727..45b297a 100644 --- a/examples/motorkit_robot_test.py +++ b/examples/motorkit_robot_test.py @@ -40,7 +40,7 @@ robot.right(0.5, 1) robot.steer(0.5, 0.2) time.sleep(3) -robot.stop() # Stop the robot from moving. +robot.stop() # Stop the robot from moving. # That's it! Note that on exit the robot will automatically stop moving. diff --git a/setup.py b/setup.py index e1d9a78..ee94b47 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,51 +15,46 @@ 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-motorkit', - + name="adafruit-circuitpython-motorkit", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython helper library for DC & Stepper Motor FeatherWing, Shield, and ' - 'Pi Hat kits.', + setup_requires=["setuptools_scm"], + description="CircuitPython helper library for DC & Stepper Motor FeatherWing, Shield, and " + "Pi Hat kits.", 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_MotorKit', - + url="https://github.com/adafruit/Adafruit_CircuitPython_MotorKit", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', - 'adafruit-circuitpython-register', 'adafruit-circuitpython-pca9685', - 'adafruit-circuitpython-motor'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=[ + "Adafruit-Blinka", + "adafruit-circuitpython-busdevice", + "adafruit-circuitpython-register", + "adafruit-circuitpython-pca9685", + "adafruit-circuitpython-motor", + ], # 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 motor pca9685 featherwing pi shield motorkit kit i2c ' - 'hardware micropython circuitpython', - + keywords="adafruit motor pca9685 featherwing pi shield motorkit kit i2c " + "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_motorkit'], -) \ No newline at end of file + py_modules=["adafruit_motorkit"], +)