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_requests.py b/adafruit_requests.py index aa1818f..0888937 100755 --- a/adafruit_requests.py +++ b/adafruit_requests.py @@ -67,10 +67,11 @@ def set_socket(sock, iface=None): global _the_sock # pylint: disable=invalid-name, global-statement _the_sock = sock if iface: - global _the_interface # pylint: disable=invalid-name, global-statement + global _the_interface # pylint: disable=invalid-name, global-statement _the_interface = iface _the_sock.set_interface(iface) + class Response: """The response from a request, contains all the headers/content""" @@ -125,6 +126,7 @@ def text(self): def json(self): """The HTTP content, parsed into a json dictionary""" + # pylint: disable=import-outside-toplevel try: import json as json_module except ImportError: @@ -192,7 +194,9 @@ def request(method, url, data=None, json=None, headers=None, stream=False, timeo else: conntype = _the_interface.TCP_MODE sock.connect(addr_info[-1], conntype) - sock.send(b"%s /%s HTTP/1.0\r\n" % (bytes(method, "utf-8"), bytes(path, "utf-8"))) + sock.send( + b"%s /%s HTTP/1.0\r\n" % (bytes(method, "utf-8"), bytes(path, "utf-8")) + ) if "Host" not in headers: sock.send(b"Host: %s\r\n" % bytes(host, "utf-8")) if "User-Agent" not in headers: @@ -205,10 +209,12 @@ def request(method, url, data=None, json=None, headers=None, stream=False, timeo sock.send(b"\r\n") if json is not None: assert data is None + # pylint: disable=import-outside-toplevel try: import json as json_module except ImportError: import ujson as json_module + # pylint: enable=import-outside-toplevel data = json_module.dumps(json) sock.send(b"Content-Type: application/json\r\n") if data: @@ -248,6 +254,7 @@ def request(method, url, data=None, json=None, headers=None, stream=False, timeo resp.reason = reason return resp + def parse_headers(sock): """ Parses the header portion of an HTTP request/response from the socket. @@ -261,18 +268,19 @@ def parse_headers(sock): if not line or line == b"\r\n": break - #print("**line: ", line) - splits = line.split(b': ', 1) + # print("**line: ", line) + splits = line.split(b": ", 1) title = splits[0] - content = '' + content = "" if len(splits) > 1: content = splits[1] if title and content: - title = str(title.lower(), 'utf-8') - content = str(content, 'utf-8') + title = str(title.lower(), "utf-8") + content = str(content, "utf-8") headers[title] = content return headers + def head(url, **kw): """Send HTTP HEAD request""" return request("HEAD", url, **kw) diff --git a/docs/conf.py b/docs/conf.py index 3277766..6814df8 100755 --- 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 Requests Library' -copyright = u'2019 ladyada' -author = u'ladyada' +project = u"Adafruit Requests 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,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 = 'AdafruitRequestsLibrarydoc' +htmlhelp_basename = "AdafruitRequestsLibrarydoc" # -- 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, 'AdafruitRequestsLibrary.tex', u'AdafruitRequests Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitRequestsLibrary.tex", + u"AdafruitRequests 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, 'AdafruitRequestslibrary', u'Adafruit Requests Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitRequestslibrary", + u"Adafruit Requests 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, 'AdafruitRequestsLibrary', u'Adafruit Requests Library Documentation', - author, 'AdafruitRequestsLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitRequestsLibrary", + u"Adafruit Requests Library Documentation", + author, + "AdafruitRequestsLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/requests_advanced.py b/examples/requests_advanced.py index 11401ba..d74f9af 100644 --- a/examples/requests_advanced.py +++ b/examples/requests_advanced.py @@ -21,11 +21,11 @@ print("Connecting to AP...") while not esp.is_connected: try: - esp.connect_AP(b'MY_SSID_NAME', b'MY_SSID_PASSWORD') + esp.connect_AP(b"MY_SSID_NAME", b"MY_SSID_PASSWORD") except RuntimeError as e: - print("could not connect to AP, retrying: ",e) + print("could not connect to AP, retrying: ", e) continue -print("Connected to", str(esp.ssid, 'utf-8'), "\tRSSI:", esp.rssi) +print("Connected to", str(esp.ssid, "utf-8"), "\tRSSI:", esp.rssi) # Initialize a requests object with a socket and esp32spi interface requests.set_socket(socket, esp) @@ -33,20 +33,20 @@ JSON_GET_URL = "http://httpbin.org/get" # Define a custom header as a dict. -headers = {"user-agent" : "blinka/1.0.0"} +headers = {"user-agent": "blinka/1.0.0"} -print("Fetching JSON data from %s..."%JSON_GET_URL) +print("Fetching JSON data from %s..." % JSON_GET_URL) response = requests.get(JSON_GET_URL, headers=headers) -print('-'*60) +print("-" * 60) json_data = response.json() -headers = json_data['headers'] -print("Response's Custom User-Agent Header: {0}".format(headers['User-Agent'])) -print('-'*60) +headers = json_data["headers"] +print("Response's Custom User-Agent Header: {0}".format(headers["User-Agent"])) +print("-" * 60) # Read Response's HTTP status code print("Response HTTP Status Code: ", response.status_code) -print('-'*60) +print("-" * 60) # Read Response, as raw bytes instead of pretty text print("Raw Response: ", response.content) diff --git a/examples/requests_advanced_ethernet.py b/examples/requests_advanced_ethernet.py index cb1d8b1..8eedb50 100644 --- a/examples/requests_advanced_ethernet.py +++ b/examples/requests_advanced_ethernet.py @@ -16,14 +16,14 @@ JSON_GET_URL = "http://httpbin.org/get" -attempts = 3 # Number of attempts to retry each request +attempts = 3 # Number of attempts to retry each request failure_count = 0 response = None # Define a custom header as a dict. -headers = {"user-agent" : "blinka/1.0.0"} +headers = {"user-agent": "blinka/1.0.0"} -print("Fetching JSON data from %s..."%JSON_GET_URL) +print("Fetching JSON data from %s..." % JSON_GET_URL) while not response: try: response = requests.get(JSON_GET_URL, headers=headers) @@ -32,19 +32,21 @@ print("Request failed, retrying...\n", error) failure_count += 1 if failure_count >= attempts: - raise AssertionError("Failed to resolve hostname, \ - please check your router's DNS configuration.") + raise AssertionError( + "Failed to resolve hostname, \ + please check your router's DNS configuration." + ) continue -print('-'*60) +print("-" * 60) json_data = response.json() -headers = json_data['headers'] -print("Response's Custom User-Agent Header: {0}".format(headers['User-Agent'])) -print('-'*60) +headers = json_data["headers"] +print("Response's Custom User-Agent Header: {0}".format(headers["User-Agent"])) +print("-" * 60) # Read Response's HTTP status code print("Response HTTP Status Code: ", response.status_code) -print('-'*60) +print("-" * 60) # Read Response, as raw bytes instead of pretty text print("Raw Response: ", response.content) diff --git a/examples/requests_simpletest.py b/examples/requests_simpletest.py index 36d2b28..444648b 100755 --- a/examples/requests_simpletest.py +++ b/examples/requests_simpletest.py @@ -22,11 +22,11 @@ print("Connecting to AP...") while not esp.is_connected: try: - esp.connect_AP(b'MY_SSID_NAME', b'MY_SSID_PASSWORD') + esp.connect_AP(b"MY_SSID_NAME", b"MY_SSID_PASSWORD") except RuntimeError as e: - print("could not connect to AP, retrying: ",e) + print("could not connect to AP, retrying: ", e) continue -print("Connected to", str(esp.ssid, 'utf-8'), "\tRSSI:", esp.rssi) +print("Connected to", str(esp.ssid, "utf-8"), "\tRSSI:", esp.rssi) # Initialize a requests object with a socket and esp32spi interface requests.set_socket(socket, esp) @@ -35,40 +35,40 @@ JSON_GET_URL = "http://httpbin.org/get" JSON_POST_URL = "http://httpbin.org/post" -print("Fetching text from %s"%TEXT_URL) +print("Fetching text from %s" % TEXT_URL) response = requests.get(TEXT_URL) -print('-'*40) +print("-" * 40) print("Text Response: ", response.text) -print('-'*40) +print("-" * 40) response.close() -print("Fetching JSON data from %s"%JSON_GET_URL) +print("Fetching JSON data from %s" % JSON_GET_URL) response = requests.get(JSON_GET_URL) -print('-'*40) +print("-" * 40) print("JSON Response: ", response.json()) -print('-'*40) +print("-" * 40) response.close() -data = '31F' +data = "31F" print("POSTing data to {0}: {1}".format(JSON_POST_URL, data)) response = requests.post(JSON_POST_URL, data=data) -print('-'*40) +print("-" * 40) json_resp = response.json() # Parse out the 'data' key from json_resp dict. -print("Data received from server:", json_resp['data']) -print('-'*40) +print("Data received from server:", json_resp["data"]) +print("-" * 40) response.close() -json_data = {"Date" : "July 25, 2019"} +json_data = {"Date": "July 25, 2019"} print("POSTing data to {0}: {1}".format(JSON_POST_URL, json_data)) response = requests.post(JSON_POST_URL, json=json_data) -print('-'*40) +print("-" * 40) json_resp = response.json() # Parse out the 'json' key from json_resp dict. -print("JSON Data received from server:", json_resp['json']) -print('-'*40) +print("JSON Data received from server:", json_resp["json"]) +print("-" * 40) response.close() diff --git a/examples/requests_simpletest_ethernet.py b/examples/requests_simpletest_ethernet.py index 7856355..432bc42 100644 --- a/examples/requests_simpletest_ethernet.py +++ b/examples/requests_simpletest_ethernet.py @@ -18,11 +18,11 @@ JSON_GET_URL = "http://httpbin.org/get" JSON_POST_URL = "http://httpbin.org/post" -attempts = 3 # Number of attempts to retry each request +attempts = 3 # Number of attempts to retry each request failure_count = 0 response = None -print("Fetching text from %s"%TEXT_URL) +print("Fetching text from %s" % TEXT_URL) while not response: try: response = requests.get(TEXT_URL) @@ -31,17 +31,19 @@ print("Request failed, retrying...\n", error) failure_count += 1 if failure_count >= attempts: - raise AssertionError("Failed to resolve hostname, \ - please check your router's DNS configuration.") + raise AssertionError( + "Failed to resolve hostname, \ + please check your router's DNS configuration." + ) continue -print('-'*40) +print("-" * 40) print("Text Response: ", response.text) -print('-'*40) +print("-" * 40) response.close() response = None -print("Fetching JSON data from %s"%JSON_GET_URL) +print("Fetching JSON data from %s" % JSON_GET_URL) while not response: try: response = requests.get(JSON_GET_URL) @@ -50,17 +52,19 @@ print("Request failed, retrying...\n", error) failure_count += 1 if failure_count >= attempts: - raise AssertionError("Failed to resolve hostname, \ - please check your router's DNS configuration.") + raise AssertionError( + "Failed to resolve hostname, \ + please check your router's DNS configuration." + ) continue -print('-'*40) +print("-" * 40) print("JSON Response: ", response.json()) -print('-'*40) +print("-" * 40) response.close() response = None -data = '31F' +data = "31F" print("POSTing data to {0}: {1}".format(JSON_POST_URL, data)) while not response: try: @@ -70,19 +74,21 @@ print("Request failed, retrying...\n", error) failure_count += 1 if failure_count >= attempts: - raise AssertionError("Failed to resolve hostname, \ - please check your router's DNS configuration.") + raise AssertionError( + "Failed to resolve hostname, \ + please check your router's DNS configuration." + ) continue -print('-'*40) +print("-" * 40) json_resp = response.json() # Parse out the 'data' key from json_resp dict. -print("Data received from server:", json_resp['data']) -print('-'*40) +print("Data received from server:", json_resp["data"]) +print("-" * 40) response.close() response = None -json_data = {"Date" : "July 25, 2019"} +json_data = {"Date": "July 25, 2019"} print("POSTing data to {0}: {1}".format(JSON_POST_URL, json_data)) while not response: try: @@ -92,13 +98,15 @@ print("Request failed, retrying...\n", error) failure_count += 1 if failure_count >= attempts: - raise AssertionError("Failed to resolve hostname, \ - please check your router's DNS configuration.") + raise AssertionError( + "Failed to resolve hostname, \ + please check your router's DNS configuration." + ) continue -print('-'*40) +print("-" * 40) json_resp = response.json() # Parse out the 'json' key from json_resp dict. -print("JSON Data received from server:", json_resp['json']) -print('-'*40) +print("JSON Data received from server:", json_resp["json"]) +print("-" * 40) response.close() diff --git a/setup.py b/setup.py index 8a9a050..cff2828 100755 --- 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,51 +14,40 @@ 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-requests', - + name="adafruit-circuitpython-requests", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='A requests-like library for web interfacing', + setup_requires=["setuptools_scm"], + description="A requests-like library for web interfacing", 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_Requests', - + url="https://github.com/adafruit/Adafruit_CircuitPython_Requests", # 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 requests requests, networking', - + keywords="adafruit blinka circuitpython micropython requests requests, networking", # 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_requests'], + py_modules=["adafruit_requests"], )