Bugfix for get_or_create_detector() unique name (#46)

* Fix get_or_create_detector()

* Improve log message

Author: mjvogelsong

pyproject.toml

@@ -9,7 +9,7 @@ packages = [
     {include = "**/*.py", from = "src"},
 ]
 readme = "README.md"
-version = "0.7.7"
+version = "0.7.8"
 
 [tool.poetry.dependencies]
 certifi = "^2021.10.8"

src/groundlight/client.py

@@ -13,7 +13,7 @@
 from groundlight.binary_labels import convert_display_label_to_internal
 from groundlight.config import API_TOKEN_VARIABLE_NAME, API_TOKEN_WEB_URL
 from groundlight.images import parse_supported_image_types
-from groundlight.internalapi import GroundlightApiClient, sanitize_endpoint_url
+from groundlight.internalapi import GroundlightApiClient, NotFoundError, sanitize_endpoint_url
 from groundlight.optional_imports import Image, np
 
 logger = logging.getLogger("groundlight.sdk")
@@ -109,25 +109,27 @@ def get_or_create_detector(
         confidence exists, return it. Otherwise, create a detector with the specified query and
         config.
         """
-        existing_detector = self.get_detector_by_name(name)
-        if existing_detector:
-            # TODO: We may soon allow users to update the retrieved detector's fields.
-            if existing_detector.query != query:
-                raise ValueError(
-                    f"Found existing detector with name={name} (id={existing_detector.id}) but the queries don't match."
-                    f" The existing query is '{existing_detector.query}'."
-                )
-            if confidence_threshold is not None and existing_detector.confidence_threshold != confidence_threshold:
-                raise ValueError(
-                    f"Found existing detector with name={name} (id={existing_detector.id}) but the confidence"
-                    " thresholds don't match. The existing confidence threshold is"
-                    f" {existing_detector.confidence_threshold}."
-                )
-            return existing_detector
-
-        return self.create_detector(
-            name=name, query=query, confidence_threshold=confidence_threshold, config_name=config_name
-        )
+        try:
+            existing_detector = self.get_detector_by_name(name)
+        except NotFoundError:
+            logger.debug(f"We could not find a detector with name='{name}'. So we will create a new detector ...")
+            return self.create_detector(
+                name=name, query=query, confidence_threshold=confidence_threshold, config_name=config_name
+            )
+
+        # TODO: We may soon allow users to update the retrieved detector's fields.
+        if existing_detector.query != query:
+            raise ValueError(
+                f"Found existing detector with name={name} (id={existing_detector.id}) but the queries don't match."
+                f" The existing query is '{existing_detector.query}'."
+            )
+        if confidence_threshold is not None and existing_detector.confidence_threshold != confidence_threshold:
+            raise ValueError(
+                f"Found existing detector with name={name} (id={existing_detector.id}) but the confidence"
+                " thresholds don't match. The existing confidence threshold is"
+                f" {existing_detector.confidence_threshold}."
+            )
+        return existing_detector
 
     def get_image_query(self, id: str) -> ImageQuery:  # pylint: disable=redefined-builtin
         obj = self.image_queries_api.get_image_query(id=id)

test/integration/test_groundlight.py

@@ -100,6 +100,19 @@ def test_list_detectors(gl: Groundlight):
     assert isinstance(detectors, PaginatedDetectorList)
 
 
+def test_get_or_create_detector(gl: Groundlight):
+    # With a unique name, we should be creating a new detector.
+    unique_name = f"Unique name {datetime.utcnow()}"
+    query = "Test query?"
+    detector = gl.get_or_create_detector(name=unique_name, query=query)
+    assert str(detector)
+    assert isinstance(detector, Detector)
+
+    # If we try to create a detector with the same name, we should get the same detector back.
+    retrieved_detector = gl.get_or_create_detector(name=unique_name, query=query)
+    assert retrieved_detector.id == detector.id
+
+
 def test_get_detector(gl: Groundlight, detector: Detector):
     _detector = gl.get_detector(id=detector.id)
     assert str(_detector)