requested changes

Author: Matt Sokoloff

labelbox/schema/asset_metadata.py

@@ -18,7 +18,7 @@ class MetaType(Enum):
         TEXT = "TEXT"
         IMAGE_OVERLAY = "IMAGE_OVERLAY"
 
-    #For backwards compatibility
+    # For backwards compatibility
     for topic in MetaType:
         vars()[topic.name] = topic.value
 

labelbox/schema/data_row.py

@@ -34,6 +34,10 @@ class DataRow(DbObject, Updateable, BulkDeletable):
     metadata = Relationship.ToMany("AssetMetadata", False, "metadata")
     predictions = Relationship.ToMany("Prediction", False)
 
+    supported_meta_types = {
+        meta_type.value for meta_type in AssetMetadata.MetaType
+    }
+
     @staticmethod
     def bulk_delete(data_rows):
         """ Deletes all the given DataRows.
@@ -62,10 +66,10 @@ def create_metadata(self, meta_type, meta_value):
         Raises:
             ValueError: meta_type must be one of the supported types.
         """
-        supported_meta_types = [x.value for x in AssetMetadata.MetaType]
-        if meta_type not in supported_meta_types:
+
+        if meta_type not in self.supported_meta_types:
             raise ValueError(
-                f"metadata type must be one of {supported_meta_types}. Found {meta_type}"
+                f"meta_type must be one of {self.supported_meta_types}. Found {meta_type}"
             )
 
         meta_type_param = "metaType"

labelbox/schema/dataset.py

@@ -210,6 +210,6 @@ def data_row_for_external_id(self, external_id):
                                                    limit=2)
         if len(data_rows) > 1:
             logging.warn(
-                "More than one data_row has the provided external_id. Use function data_rows_for_external_id to fetch all"
+                f"More than one data_row has the provided external_id : `{external_id}`. Use function data_rows_for_external_id to fetch all"
             )
         return data_rows[0]

labelbox/schema/project.py

@@ -90,7 +90,7 @@ def create_label(self, **kwargs):
         # about them. At the same time they're connected to a Label at
         # label creation in a non-standard way (connect via name).
         logger.warning(
-            "This function is deprecated and is not compatible with the new editor."
+            "`create_label` is deprecated and is not compatible with the new editor."
         )
 
         Label = Entity.Label
@@ -417,7 +417,7 @@ def upsert_review_queue(self, quota_factor):
                 to reinitiate. Between 0 and 1.
         """
 
-        if (quota_factor > 1.) or (quota_factor < 0.):
+        if not 0. < quota_factor < 1.:
             raise ValueError("Quota factor must be in the range of [0,1]")
 
         id_param = "projectId"
@@ -460,7 +460,7 @@ def create_prediction_model(self, name, version):
         """
 
         logger.warning(
-            "This function is deprecated and is not compatible with the new editor."
+            "`create_prediction_model` is deprecated and is not compatible with the new editor."
         )
 
         PM = Entity.PredictionModel
@@ -489,7 +489,7 @@ def create_prediction(self, label, data_row, prediction_model=None):
                 None.
         """
         logger.warning(
-            "This function is deprecated and is not compatible with the new editor."
+            "`create_prediction` is deprecated and is not compatible with the new editor."
         )
 
         if prediction_model is None:

labelbox/schema/webhook.py

@@ -1,11 +1,10 @@
 import logging
 from enum import Enum
-from typing import List, Optional, Union
+from typing import Iterable, List
 
 from labelbox.orm import query
 from labelbox.orm.db_object import DbObject, Updateable
 from labelbox.orm.model import Entity, Field, Relationship
-from labelbox import Client, Project
 
 logger = logging.getLogger(__name__)
 
@@ -25,24 +24,24 @@ class Webhook(DbObject, Updateable):
 
     """
 
-    class WebhookStatus(Enum):
+    class Status(Enum):
         ACTIVE = "ACTIVE"
         INACTIVE = "INACTIVE"
         REVOKED = "REVOKED"
 
-    class WebhookTopic(Enum):
+    class Topic(Enum):
         LABEL_CREATED = "LABEL_CREATED"
         LABEL_UPDATED = "LABEL_UPDATED"
         LABEL_DELETED = "LABEL_DELETED"
         REVIEW_CREATED = "REVIEW_CREATED"
         REVIEW_UPDATED = "REVIEW_UPDATED"
         REVIEW_DELETED = "REVIEW_DELETED"
 
-    #For backwards compatibility
-    for topic in WebhookStatus:
+    # For backwards compatibility
+    for topic in Status:
         vars()[topic.name] = topic.value
 
-    for status in WebhookTopic:
+    for status in Topic:
         vars()[status.name] = status.value
 
     updated_at = Field.DateTime("updated_at")
@@ -56,15 +55,14 @@ class WebhookTopic(Enum):
     project = Relationship.ToOne("Project")
 
     @staticmethod
-    def create(client: Client, topics: List[WebhookTopic], url: str,
-               secret: str, project: Project):
+    def create(client, topics, url, secret, project):
         """ Creates a Webhook.
 
         Args:
             client (Client): The Labelbox client used to connect
                 to the server.
             topics (list of str): A list of topics this Webhook should
-                get notifications for. Must be one of Webhook.WebhookTopic
+                get notifications for. Must be one of Webhook.Topic
             url (str): The URL to which notifications should be sent
                 by the Labelbox server.
             secret (str): A secret key used for signing notifications.
@@ -75,7 +73,7 @@ def create(client: Client, topics: List[WebhookTopic], url: str,
             A newly created Webhook.
 
         Raises:
-            ValueError: If the topic is not one of WebhookTopic or status is not one of WebhookStatus
+            ValueError: If the topic is not one of Topic or status is not one of Status
 
         Information on configuring your server can be found here (this is where the url points to and the secret is set).
                         https://docs.labelbox.com/en/configure-editor/webhooks-setup#setup-steps
@@ -94,17 +92,17 @@ def create(client: Client, topics: List[WebhookTopic], url: str,
         return Webhook(client, client.execute(query_str)["createWebhook"])
 
     @staticmethod
-    def validate_topics(topics: List[WebhookTopic]):
-        if not isinstance(topics, list):
+    def validate_topics(topics):
+        if isinstance(topics, str) or not isinstance(topics, Iterable):
             raise TypeError(
-                f"Topics must be List[Webhook.WebhookTopic]. Found `{topics}`")
+                f"Topics must be List[Webhook.Topic]. Found `{topics}`")
 
         for topic in topics:
-            Webhook.validate_value(topic, Webhook.WebhookTopic)
+            Webhook.validate_value(topic, Webhook.Topic)
 
     @staticmethod
-    def validate_value(value: str, enum: Union[WebhookStatus, WebhookTopic]):
-        supported_values = [x.value for x in enum]
+    def validate_value(value, enum):
+        supported_values = {item.value for item in enum}
         if value not in supported_values:
             raise ValueError(
                 f"Value `{value}` does not exist in supported values. Expected one of {supported_values}"
@@ -114,18 +112,15 @@ def delete(self):
         """
         Deletes the webhook
         """
-        self.update(status=self.WebhookStatus.INACTIVE)
+        self.update(status=self.Status.INACTIVE)
 
-    def update(self,
-               topics: Optional[List[WebhookTopic]] = None,
-               url: Optional[str] = None,
-               status: Optional[WebhookStatus] = None):
+    def update(self, topics=None, url=None, status=None):
         """ Updates the Webhook.
 
         Args:
-            topics (Optional[List[WebhookTopic]]): The new topics.
+            topics (Optional[List[Topic]]): The new topics.
             url  Optional[str): The new URL value.
-            status (Optional[WebhookStatus]): The new status.
+            status (Optional[Status]): The new status.
 
         If values are set to None then there are no updates made to that field.
 
@@ -138,7 +133,7 @@ def update(self,
             self.validate_topics(topics)
 
         if status is not None:
-            self.validate_value(status, self.WebhookStatus)
+            self.validate_value(status, self.Status)
 
         topics_str = "" if topics is None \
             else "topics: {set: [%s]}" % " ".join(topics)

tests/integration/test_asset_metadata.py

@@ -21,8 +21,9 @@ def test_asset_metadata_crud(project, dataset, rand_gen):
 
     with pytest.raises(ValueError) as exc_info:
         data_row.create_metadata("NOT_SUPPORTED_TYPE", "Value")
+    expected_types = {item.value for item in AssetMetadata.MetaType}
     assert str(exc_info.value) == \
-        f"metadata type must be one of {[x.value for x in AssetMetadata.MetaType]}. Found NOT_SUPPORTED_TYPE"
+        f"meta_type must be one of {expected_types}. Found NOT_SUPPORTED_TYPE"
 
     # Check that filtering and sorting is prettily disabled
     with pytest.raises(InvalidQueryError) as exc_info:

tests/integration/test_webhook.py

@@ -24,15 +24,17 @@ def test_webhook_create_update(project, rand_gen):
 
     with pytest.raises(ValueError) as exc_info:
         webhook.update(status="invalid..")
+    valid_webhook_statuses = {item.value for item in Webhook.Status}
     assert str(exc_info.value) == \
-        f"Value `invalid..` does not exist in supported values. Expected one of {[x.value for x in Webhook.WebhookStatus]}"
+        f"Value `invalid..` does not exist in supported values. Expected one of {valid_webhook_statuses}"
 
     with pytest.raises(ValueError) as exc_info:
         webhook.update(topics=["invalid.."])
+    valid_webhook_topics = {item.value for item in Webhook.Topic}
     assert str(exc_info.value) == \
-        f"Value `invalid..` does not exist in supported values. Expected one of {[x.value for x in Webhook.WebhookTopic]}"
+        f"Value `invalid..` does not exist in supported values. Expected one of {valid_webhook_topics}"
 
     with pytest.raises(TypeError) as exc_info:
         webhook.update(topics="invalid..")
     assert str(exc_info.value) == \
-        "Topics must be List[Webhook.WebhookTopic]. Found `invalid..`"
+        "Topics must be List[Webhook.Topic]. Found `invalid..`"