Black

Author: Jim Bennett

.github/workflows/build.yml

@@ -49,7 +49,7 @@ jobs:
         ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" ))
     - name: Check formatting
       run: |
-        black --check --target-version=py35 .
+        black --check --target-version=py35 --line-length 140 .
     - name: Build assets
       run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
     - name: Build docs

circuitpython_customvision/prediction/__init__.py

@@ -12,6 +12,6 @@
 from .custom_vision_prediction_client import CustomVisionPredictionClient
 from .version import VERSION
 
-__all__ = ['CustomVisionPredictionClient']
+__all__ = ["CustomVisionPredictionClient"]
 
 __version__ = VERSION

circuitpython_customvision/prediction/custom_vision_prediction_client.py

@@ -5,6 +5,7 @@
 from .version import VERSION
 from . import models
 
+
 def run_request(url, body, headers):
     retry = 0
     r = None
@@ -29,7 +30,8 @@ def run_request(url, body, headers):
 
     return r
 
-class CustomVisionPredictionClient():
+
+class CustomVisionPredictionClient:
     """CustomVisionPredictionClient
 
     :param api_key: API key.
@@ -38,56 +40,51 @@ class CustomVisionPredictionClient():
     :type endpoint: str
     """
 
-    __classify_image_url_route = 'customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/url'
-    __classify_image_route = 'customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/image'
-    __detect_image_url_route = 'customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/url'
-    __detect_image_route = 'customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/image'
+    __classify_image_url_route = "customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/url"
+    __classify_image_route = "customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/image"
+    __detect_image_url_route = "customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/url"
+    __detect_image_route = "customvision/v3.0/Prediction/{projectId}/classify/iterations/{publishedName}/image"
 
-    def __init__(
-            self, api_key, endpoint):
+    def __init__(self, api_key, endpoint):
 
         self.__api_key = api_key
 
         # build the root endpoint
-        if not endpoint.lower().startswith('https://'):
-            endpoint = 'https://' + endpoint
-        if not endpoint.endswith('/'):
-            endpoint = endpoint + '/'
+        if not endpoint.lower().startswith("https://"):
+            endpoint = "https://" + endpoint
+        if not endpoint.endswith("/"):
+            endpoint = endpoint + "/"
 
         self.__base_endpoint = endpoint
         self.api_version = VERSION
 
     def __format_endpoint(self, url_format: str, project_id: str, published_name: str, store: bool, application: Optional[str]):
         endpoint = self.__base_endpoint + url_format.format(projectId=project_id, publishedName=published_name)
         if not store:
-            endpoint = endpoint + '/nostore'
+            endpoint = endpoint + "/nostore"
         if application is not None:
-            application = '?' + application
+            application = "?" + application
             endpoint = endpoint + application
 
         return endpoint
 
     def __process_image_url(self, route: str, project_id: str, published_name: str, url: str, store: bool, application: Optional[str]):
         endpoint = self.__format_endpoint(route, project_id, published_name, store, application)
 
-        headers = {
-            'Content-Type': 'application/json',
-            'Prediction-Key': self.__api_key
-        }
+        headers = {"Content-Type": "application/json", "Prediction-Key": self.__api_key}
 
-        body = json.dumps({'url' : url})
+        body = json.dumps({"url": url})
         result = run_request(endpoint, body, headers)
         result_text = result.text
 
         return models.ImagePrediction(result_text)
 
-    def __process_image(self, route: str, project_id: str, published_name: str, image_data: bytearray, store: bool, application: Optional[str]):
+    def __process_image(
+        self, route: str, project_id: str, published_name: str, image_data: bytearray, store: bool, application: Optional[str]
+    ):
         endpoint = self.__format_endpoint(route, project_id, published_name, store, application)
 
-        headers = {
-            'Content-Type': 'application/octet-stream',
-            'Prediction-Key': self.__api_key
-        }
+        headers = {"Content-Type": "application/octet-stream", "Prediction-Key": self.__api_key}
 
         result = run_request(endpoint, image_data, headers)
         result_text = result.text

circuitpython_customvision/prediction/models/__init__.py

@@ -14,9 +14,4 @@
 from .image_prediction import ImagePrediction
 from .customvision_error import CustomVisionError
 
-__all__ = [
-    'BoundingBox',
-    'Prediction',
-    'ImagePrediction',
-    'CustomVisionError'
-]
+__all__ = ["BoundingBox", "Prediction", "ImagePrediction", "CustomVisionError"]

circuitpython_customvision/prediction/models/bounding_box.py

@@ -1,4 +1,4 @@
-class BoundingBox():
+class BoundingBox:
     """Bounding box that defines a region of an image.
 
     All required parameters must be populated in order to send to Azure.

circuitpython_customvision/prediction/models/customvision_error.py

@@ -2,6 +2,7 @@ class CustomVisionError(Exception):
     """
     An error from the custom vision service
     """
+
     def __init__(self, message):
         super(CustomVisionError, self).__init__(message)
         self.message = message

circuitpython_customvision/prediction/models/image_prediction.py

@@ -2,7 +2,8 @@
 from .prediction import Prediction
 from .bounding_box import BoundingBox
 
-class ImagePrediction():
+
+class ImagePrediction:
     """Result of an image prediction request.
 
     Variables are only populated by the server, and will be ignored when
@@ -26,20 +27,16 @@ def __init__(self, response) -> None:
         if not isinstance(response, dict):
             response = json.loads(response)
 
-        self.id = response['id']
-        self.project = response['project']
-        self.iteration = response['iteration']
-        self.created = response['created']
+        self.prediction_id = response["id"]
+        self.project = response["project"]
+        self.iteration = response["iteration"]
+        self.created = response["created"]
         self.predictions = []
 
-        for pred in response['predictions']:
-            box = pred['boundingBox']
-            bounding_box = BoundingBox(left=box['left'],
-                                       top=box['top'],
-                                       width=box['width'],
-                                       height=box['height'])
-            prediction = Prediction(probability=pred['probability'],
-                                    tag_id=pred['tagId'],
-                                    tag_name=pred['tagName'],
-                                    bounding_box=bounding_box)
+        for pred in response["predictions"]:
+            box = pred["boundingBox"]
+            bounding_box = BoundingBox(left=box["left"], top=box["top"], width=box["width"], height=box["height"])
+            prediction = Prediction(
+                probability=pred["probability"], tag_id=pred["tagId"], tag_name=pred["tagName"], bounding_box=bounding_box
+            )
             self.predictions.append(prediction)

circuitpython_customvision/prediction/models/prediction.py

@@ -1,6 +1,7 @@
 from .bounding_box import BoundingBox
 
-class Prediction():
+
+class Prediction:
     """Prediction result.
 
     Variables are only populated by the server, and will be ignored when

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 = ["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'CircuitPython-CustomVision Library'
-copyright = u'2020 Jim Bennett'
-author = u'Jim Bennett'
+project = "CircuitPython-CustomVision Library"
+copyright = "2020 Jim Bennett"
+author = "Jim Bennett"
 
 # 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,77 +88,77 @@
 # 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 = 'Circuitpython-customvisionLibrarydoc'
+htmlhelp_basename = "Circuitpython-customvisionLibrarydoc"
 
 # -- 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, 'CircuitPython-CustomVisionLibrary.tex', u'CircuitPython-CustomVision Library Documentation',
-     author, 'manual'),
+    (master_doc, "CircuitPython-CustomVisionLibrary.tex", "CircuitPython-CustomVision 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, 'CircuitPython-CustomVisionlibrary', u'CircuitPython-CustomVision Library Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "CircuitPython-CustomVisionlibrary", "CircuitPython-CustomVision Library Documentation", [author], 1)]
 
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'CircuitPython-CustomVisionLibrary', u'CircuitPython-CustomVision Library Documentation',
-     author, 'CircuitPython-CustomVisionLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "CircuitPython-CustomVisionLibrary",
+        "CircuitPython-CustomVision Library Documentation",
+        author,
+        "CircuitPython-CustomVisionLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]