fix object

Author: robmarkcole

deepstack/core.py

@@ -8,29 +8,39 @@
 ## Const
 DEFAULT_API_KEY = ""
 DEFAULT_TIMEOUT = 10  # seconds
+DEFAULT_IP = "localhost"
+DEFAULT_PORT = 80
 
 ## HTTP codes
 HTTP_OK = 200
 BAD_URL = 404
 
 ## API urls
-URL_CUSTOM = "http://{ip}:{port}/v1/vision/custom/{custom_model}"
-URL_OBJECT_DETECTION = "http://{ip}:{port}/v1/vision/detection"
-URL_FACE_DETECTION = "http://{ip}:{port}/v1/vision/face"
-URL_FACE_REGISTER = "http://{ip}:{port}/v1/vision/face/register"
-URL_FACE_RECOGNIZE = "http://{ip}:{port}/v1/vision/face/recognize"
-URL_SCENE_DETECTION = "http://{ip}:{port}/v1/vision/scene"
+URL_BASE_VISION = "http://{ip}:{port}/v1/vision"
+URL_CUSTOM = "/custom/{custom_model}"
+URL_OBJECT_DETECTION = "/detection"
+URL_FACE_DETECTION = "/face"
+URL_FACE_REGISTER = "/face/register"
+URL_FACE_RECOGNIZE = "/face/recognize"
+URL_SCENE_DETECTION = "/scene"
+
+
+class DeepstackException(Exception):
+    pass
 
 
 def format_confidence(confidence: Union[str, float]) -> float:
-    """Takes a confidence from the API like
+    """
+    Takes a confidence from the API like
     0.55623 and returns 55.6 (%).
     """
     DECIMALS = 1
     return round(float(confidence) * 100, DECIMALS)
 
 
-def get_confidences_above_threshold(confidences: List[float], confidence_threshold: float) -> List[float]:
+def get_confidences_above_threshold(
+    confidences: List[float], confidence_threshold: float
+) -> List[float]:
     """Takes a list of confidences and returns those above a confidence_threshold."""
     return [val for val in confidences if val >= confidence_threshold]
 
@@ -58,11 +68,15 @@ def get_objects(predictions: List[Dict]) -> List[str]:
     return sorted(list(set(labels)))
 
 
-def get_object_confidences(predictions: List[Dict], target_object: str):
+def get_object_confidences(predictions: List[Dict], target_object: str) -> List[float]:
     """
     Return the list of confidences of instances of target label.
     """
-    confidences = [pred["confidence"] for pred in predictions if pred["label"] == target_object]
+    confidences = [
+        float(pred["confidence"])
+        for pred in predictions
+        if pred["label"] == target_object
+    ]
     return confidences
 
 
@@ -71,56 +85,66 @@ def get_objects_summary(predictions: List[Dict]):
     Get a summary of the objects detected.
     """
     objects = get_objects(predictions)
-    return {target_object: len(get_object_confidences(predictions, target_object)) for target_object in objects}
+    return {
+        target_object: len(get_object_confidences(predictions, target_object))
+        for target_object in objects
+    }
 
 
-def post_image(url: str, image_bytes: bytes, api_key: str, timeout: int, data: dict = {}):
-    """Post an image to Deepstack."""
+def post_image(
+    url: str, image_bytes: bytes, api_key: str, timeout: int, data: dict = {}
+):
+    """Post an image to Deepstack. Only handles excpetions."""
     try:
         data["api_key"] = api_key  # Insert the api_key
-        response = requests.post(url, files={"image": image_bytes}, data=data, timeout=timeout)
-        if response.status_code == HTTP_OK:
-            return response
-        elif response.status_code == BAD_URL:
-            raise DeepstackException(f"Bad url supplied, url {url} raised error {BAD_URL}")
-        else:
-            raise DeepstackException(f"Error from Deepstack request, status code: {response.status_code}")
+        return requests.post(
+            url, files={"image": image_bytes}, data=data, timeout=timeout
+        )
     except requests.exceptions.Timeout:
-        raise DeepstackException(f"Timeout connecting to Deepstack, current timeout is {timeout} seconds")
+        raise DeepstackException(
+            f"Timeout connecting to Deepstack, current timeout is {timeout} seconds"
+        )
     except requests.exceptions.ConnectionError as exc:
         raise DeepstackException(f"Connection error: {exc}")
 
 
-class DeepstackException(Exception):
-    pass
+def process_image(url: str, image_bytes: bytes, api_key: str, timeout: int):
+    """Process image_bytes and detect. Handles common status codes"""
+    response = post_image(url, image_bytes, api_key, timeout)
+    if response.status_code == HTTP_OK:
+        return response.json()
+    elif response.status_code == BAD_URL:
+        raise DeepstackException(f"Bad url supplied, url {url} raised error {BAD_URL}")
+    else:
+        raise DeepstackException(
+            f"Error from Deepstack request, status code: {response.status_code}"
+        )
 
 
-class Deepstack(object):
-    """Base class for deepstack."""
+class DeepstackVision:
+    """Base class for Deepstack vision."""
 
     def __init__(
         self,
-        api_key: str = "",
+        ip: str = DEFAULT_IP,
+        port: int = DEFAULT_PORT,
+        api_key: str = DEFAULT_API_KEY,
         timeout: int = DEFAULT_TIMEOUT,
-        url_detect: str = None,
-        url_recognize: str = None,
-        url_register: str = None,
+        url_detect: str = "",
+        url_recognize: str = "",
+        url_register: str = "",
     ):
 
-        self._url_detect = url_detect
-        self._url_recognize = url_recognize
-        self._url_register = url_register
+        self._url_base = URL_BASE_VISION.format(ip=ip, port=port)
+        self._url_detect = self._url_base + url_detect
+        self._url_recognize = self._url_base + url_recognize
+        self._url_register = self._url_base + url_register
         self._api_key = api_key
         self._timeout = timeout
-        self._response = None
 
-    def detect(self, image_bytes: bytes):
+    def detect(self):
         """Process image_bytes and detect."""
-        self._response = None
-        self._response = post_image(self._url_detect, image_bytes, self._api_key, self._timeout).json()
-        if not self._response["success"]:
-            error = self._response["error"]
-            raise DeepstackException(f"Error from Deepstack: {error}")
+        raise NotImplementedError
 
     def recognize(self):
         """Process image_bytes and recognize."""
@@ -130,59 +154,68 @@ def register(self):
         """Perform a registration."""
         raise NotImplementedError
 
-    @property
-    def predictions(self):
-        """Return the predictions."""
-        raise NotImplementedError
 
-
-class DeepstackObject(Deepstack):
+class DeepstackObject(DeepstackVision):
     """Work with objects"""
 
     def __init__(
         self,
-        ip: str,
-        port: str,
+        ip: str = DEFAULT_IP,
+        port: int = DEFAULT_PORT,
         api_key: str = DEFAULT_API_KEY,
         timeout: int = DEFAULT_TIMEOUT,
         custom_model: str = None,
     ):
         if not custom_model:
             super().__init__(
-                api_key, timeout, url_detect=URL_OBJECT_DETECTION.format(ip=ip, port=port),
+                ip, port, api_key, timeout, url_detect=URL_OBJECT_DETECTION,
             )
         else:
             super().__init__(
-                api_key, timeout, url_detect=URL_CUSTOM.format(ip=ip, port=port, custom_model=custom_model),
+                ip,
+                port,
+                api_key,
+                timeout,
+                url_detect=URL_CUSTOM.format(custom_model=custom_model),
             )
 
-    @property
-    def predictions(self):
-        """Return the predictions."""
-        return self._response["predictions"]
+    def detect(self, image_bytes: bytes):
+        """Process image_bytes and detect."""
+        response_json = process_image(
+            self._url_detect, image_bytes, self._api_key, self._timeout
+        )
+        return response_json["predictions"]
 
 
-class DeepstackScene(Deepstack):
+class DeepstackScene(DeepstackVision):
     """Work with scenes"""
 
     def __init__(
-        self, ip: str, port: str, api_key: str = DEFAULT_API_KEY, timeout: int = DEFAULT_TIMEOUT,
+        self,
+        ip: str,
+        port: str,
+        api_key: str = DEFAULT_API_KEY,
+        timeout: int = DEFAULT_TIMEOUT,
     ):
         super().__init__(
-            api_key, timeout, url_detect=URL_SCENE_DETECTION.format(ip=self._ip, port=self._port),
+            api_key, timeout, url_detect=URL_SCENE_DETECTION,
         )
 
-    @property
-    def predictions(self):
-        """Return the predictions."""
-        return self._response
+    def detect(self, image_bytes: bytes):
+        """Process image_bytes and detect."""
+        response_json = process_image(self, image_bytes, self._api_key, self._timeout)
+        return response_json
 
 
-class DeepstackFace(Deepstack):
+class DeepstackFace(DeepstackVision):
     """Work with objects"""
 
     def __init__(
-        self, ip: str, port: str, api_key: str = DEFAULT_API_KEY, timeout: int = DEFAULT_TIMEOUT,
+        self,
+        ip: str,
+        port: str,
+        api_key: str = DEFAULT_API_KEY,
+        timeout: int = DEFAULT_TIMEOUT,
     ):
         super().__init__(
             api_key,
@@ -192,10 +225,10 @@ def __init__(
             url_recognize=URL_FACE_RECOGNIZE.format(ip=self._ip, port=self._port),
         )
 
-    @property
-    def predictions(self):
-        """Return the classifier attributes."""
-        return self._response["predictions"]
+    def detect(self, image_bytes: bytes):
+        """Process image_bytes and detect."""
+        response_json = process_image(self, image_bytes, self._api_key, self._timeout)
+        return response_json
 
     def register(self, name: str, image_bytes: bytes):
         """
@@ -220,7 +253,9 @@ def register(self, name: str, image_bytes: bytes):
     def recognize(self, image_bytes: bytes):
         """Process image_bytes, performing recognition."""
 
-        response = post_image(self._url_recognize, image_bytes, self._api_key, self._timeout)
+        response = post_image(
+            self._url_recognize, image_bytes, self._api_key, self._timeout
+        )
 
         self._response = response.json()
         if not self._response["success"]: