diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 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 pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_wsgi/request.py b/adafruit_wsgi/request.py index 5b13303..c6a22ff 100644 --- a/adafruit_wsgi/request.py +++ b/adafruit_wsgi/request.py @@ -29,11 +29,13 @@ """ import re -class Request(): + +class Request: """ An incoming HTTP request. A higher level abstraction of the raw WSGI Environ dictionary. """ + def __init__(self, environ): self._method = environ["REQUEST_METHOD"] self._path = environ["PATH_INFO"] @@ -107,7 +109,7 @@ def __parse_headers(environ): if "CONTENT_LENGTH" in environ: headers["content-length"] = environ["CONTENT_LENGTH"] - env_header_re = re.compile(r'HTTP_(.+)') + env_header_re = re.compile(r"HTTP_(.+)") for key, val in environ.items(): header = env_header_re.match(key) if header: diff --git a/adafruit_wsgi/wsgi_app.py b/adafruit_wsgi/wsgi_app.py index 5939a43..1747d73 100644 --- a/adafruit_wsgi/wsgi_app.py +++ b/adafruit_wsgi/wsgi_app.py @@ -50,6 +50,7 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_WSGI.git" + class WSGIApp: """ The base WSGI Application class. @@ -106,8 +107,10 @@ def on_request(self, methods, rule, request_handler): regex += r"([a-zA-Z0-9_-]+)\/" else: regex += part + r"\/" - regex += "?$" # make last slash optional and that we only allow full matches - self._routes.append((re.compile(regex), {"methods": methods, "func": request_handler})) + regex += "?$" # make last slash optional and that we only allow full matches + self._routes.append( + (re.compile(regex), {"methods": methods, "func": request_handler}) + ) def route(self, rule, methods=None): """ @@ -115,7 +118,7 @@ def route(self, rule, methods=None): if no methods are provided, default to GET """ if not methods: - methods = ['GET'] + methods = ["GET"] return lambda func: self.on_request(methods, rule, func) def _match_route(self, path, method): diff --git a/docs/conf.py b/docs/conf.py index 083c745..ed18c0f 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,32 @@ # 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 WSGI Library' -copyright = u'2019 Matthew Costi' -author = u'Matthew Costi' +project = "Adafruit WSGI Library" +copyright = "2019 Matthew Costi" +author = "Matthew Costi" # 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 = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "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,59 +88,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 = 'AdafruitWsgiLibrarydoc' +htmlhelp_basename = "AdafruitWsgiLibrarydoc" # -- 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, 'AdafruitWSGILibrary.tex', u'AdafruitWSGI Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitWSGILibrary.tex", + "AdafruitWSGI Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitWSGIlibrary', u'Adafruit WSGI Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitWSGIlibrary", + "Adafruit WSGI 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, 'AdafruitWSGILibrary', u'Adafruit WSGI Library Documentation', - author, 'AdafruitWSGILibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitWSGILibrary", + "Adafruit WSGI Library Documentation", + author, + "AdafruitWSGILibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/wsgi_simpletest.py b/examples/wsgi_simpletest.py index 5c12bed..45781e3 100644 --- a/examples/wsgi_simpletest.py +++ b/examples/wsgi_simpletest.py @@ -32,16 +32,20 @@ # esp32_reset = DigitalInOut(board.D5) spi = busio.SPI(board.SCK, board.MOSI, board.MISO) -esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset) # pylint: disable=line-too-long +esp = adafruit_esp32spi.ESP_SPIcontrol( + spi, esp32_cs, esp32_ready, esp32_reset +) # pylint: disable=line-too-long """Use below for Most Boards""" -status_light = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.2) # Uncomment for Most Boards +status_light = neopixel.NeoPixel( + board.NEOPIXEL, 1, brightness=0.2 +) # Uncomment for Most Boards """Uncomment below for ItsyBitsy M4""" # import adafruit_dotstar as dotstar # status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=1) ## If you want to connect to wifi with secrets: -wifi = wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light,debug=True) +wifi = wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light, debug=True) wifi.connect() ## If you want to create a WIFI hotspot to connect to with secrets: @@ -59,14 +63,16 @@ web_app = WSGIApp() -@web_app.route('/led_on///') -def led_on(request, r, g, b): # pylint: disable=unused-argument + +@web_app.route("/led_on///") +def led_on(request, r, g, b): # pylint: disable=unused-argument print("led on!") status_light.fill((int(r), int(g), int(b))) return ("200 OK", [], "led on!") -@web_app.route('/led_off') -def led_off(request): # pylint: disable=unused-argument + +@web_app.route("/led_off") +def led_off(request): # pylint: disable=unused-argument print("led off!") status_light.fill(0) return ("200 OK", [], "led off!") diff --git a/setup.py b/setup.py index 0356667..afed59e 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,52 +14,41 @@ 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-wsgi', - + name="adafruit-circuitpython-wsgi", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython framework for creating WSGI compatible web server applications.', + setup_requires=["setuptools_scm"], + description="CircuitPython framework for creating WSGI compatible web server applications.", 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_WSGI', - + url="https://github.com/adafruit/Adafruit_CircuitPython_WSGI", # 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 blinka circuitpython micropython wsgi web server webserver app webapp ' - 'framework http https flask', - + keywords="adafruit blinka circuitpython micropython wsgi web server webserver app webapp " + "framework http https flask", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['adafruit_wsgi'], + py_modules=["adafruit_wsgi"], )