Linting and formatting

Author: Jim Bennett

circuitpython_customvision/prediction/__init__.py

@@ -9,6 +9,10 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
+"""
+CircuitPython Azure Custom Vision prediction library
+"""
+
 from .custom_vision_prediction_client import CustomVisionPredictionClient
 from .version import VERSION
 

circuitpython_customvision/prediction/custom_vision_prediction_client.py

@@ -1,3 +1,7 @@
+"""
+Prediction client for the Azure Custom Vision service
+"""
+
 import json
 import time
 from typing import Optional
@@ -6,7 +10,7 @@
 from . import models
 
 
-def run_request(url, body, headers):
+def __run_request(url, body, headers):
     retry = 0
     r = None
 
@@ -74,7 +78,7 @@ def __process_image_url(self, route: str, project_id: str, published_name: str,
         headers = {"Content-Type": "application/json", "Prediction-Key": self.__api_key}
 
         body = json.dumps({"url": url})
-        result = run_request(endpoint, body, headers)
+        result = __run_request(endpoint, body, headers)
         result_text = result.text
 
         return models.ImagePrediction(result_text)
@@ -86,7 +90,7 @@ def __process_image(
 
         headers = {"Content-Type": "application/octet-stream", "Prediction-Key": self.__api_key}
 
-        result = run_request(endpoint, image_data, headers)
+        result = __run_request(endpoint, image_data, headers)
         result_text = result.text
 
         return models.ImagePrediction(result_text)

circuitpython_customvision/prediction/models/__init__.py

@@ -9,6 +9,10 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
+"""
+Models for the predictions made by the Azure Custom Vision service
+"""
+
 from .bounding_box import BoundingBox
 from .prediction import Prediction
 from .image_prediction import ImagePrediction

circuitpython_customvision/prediction/models/bounding_box.py

@@ -1,3 +1,7 @@
+"""Bounding box that defines a region of an image.
+"""
+
+
 class BoundingBox:
     """Bounding box that defines a region of an image.
 

circuitpython_customvision/prediction/models/customvision_error.py

@@ -1,3 +1,8 @@
+"""
+An error from the custom vision service
+"""
+
+
 class CustomVisionError(Exception):
     """
     An error from the custom vision service

circuitpython_customvision/prediction/models/image_prediction.py

@@ -1,3 +1,6 @@
+"""Result of an image prediction request.
+"""
+
 import json
 from .prediction import Prediction
 from .bounding_box import BoundingBox

circuitpython_customvision/prediction/models/prediction.py

@@ -1,3 +1,6 @@
+"""Prediction result.
+"""
+
 from .bounding_box import BoundingBox
 
 

circuitpython_customvision/prediction/version.py

@@ -9,4 +9,8 @@
 # regenerated.
 # --------------------------------------------------------------------------
 
+"""
+The version of the Custom Vision API to use
+"""
+
 VERSION = "3.0"