add type hints, fix typos

Author: Matt Sokoloff

labelbox/schema/project.py

@@ -351,9 +351,10 @@ def set_labeling_parameter_overrides(self, data):
         Args:
             data (iterable): An iterable of tuples. Each tuple must contain
                 (DataRow, priority<int>, number_of_labels<int>) for the new override.
+
                 Priority:
                     * Data will be labeled in priority order.
-                        - Lower number priority is labeled first.
+                        - A lower number priority is labeled first.
                         - Minimum priority is 1.
                     * Priority is not the queue position.
                         - The position is determined by the relative priority.
@@ -363,15 +364,13 @@ def set_labeling_parameter_overrides(self, data):
                     * The priority only effects items in the queue.
                         - Assigning a priority will not automatically add the item back into the queue.  
                 Number of labels:
-                    * The number times a data row should be labeled.
-                    * This will create duplicate data rows in a project (one for each number of labels).
-                    * Data rows will be sent to the queue (even if they have already been labeled).
-                        - New copies will only be assigned to members who have not labeled that same datarow before. 
+                    * The number of times a data row should be labeled.
+                        - Creates duplicate data rows in a project (one for each number of labels).
+                    * New duplicated data rows will be added to the queue.
                         - Already labeled duplicates will not be sent back to the queue.
                     * The queue will never assign the same datarow to a single labeler more than once.
                         - If the number of labels is greater than the number of labelers working on a project then
                             the extra items will remain in the queue (this can be fixed by removing the override at any time).
-
                     * Setting this to 1 will result in the default behavior (no duplicates).
         Returns:
             bool, indicates if the operation was a success.

labelbox/schema/webhook.py

@@ -1,10 +1,11 @@
 import logging
 from enum import Enum
-from typing import Iterable, List
+from typing import List, Optional, Union
 
 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__)
 
@@ -55,7 +56,8 @@ class WebhookTopic(Enum):
     project = Relationship.ToOne("Project")
 
     @staticmethod
-    def create(client, topics, url, secret, project):
+    def create(client: Client, topics: List[WebhookTopic], url: str,
+               secret: str, project: Project):
         """ Creates a Webhook.
 
         Args:
@@ -92,7 +94,7 @@ def create(client, topics, url, secret, project):
         return Webhook(client, client.execute(query_str)["createWebhook"])
 
     @staticmethod
-    def validate_topics(topics: List["Webhook.WebhookTopic"]):
+    def validate_topics(topics: List[WebhookTopic]):
         if not isinstance(topics, list):
             raise TypeError(
                 f"Topics must be List[Webhook.WebhookTopic]. Found `{topics}`")
@@ -101,23 +103,29 @@ def validate_topics(topics: List["Webhook.WebhookTopic"]):
             Webhook.validate_value(topic, Webhook.WebhookTopic)
 
     @staticmethod
-    def validate_value(value, enum):
+    def validate_value(value: str, enum: Union[WebhookStatus, WebhookTopic]):
         supported_values = [x.value for x in enum]
         if value not in supported_values:
             raise ValueError(
                 f"Value `{value}` does not exist in supported values. Expected one of {supported_values}"
             )
 
     def delete(self):
+        """
+        Deletes the webhook
+        """
         self.update(status=self.WebhookStatus.INACTIVE)
 
-    def update(self, topics=None, url=None, status=None):
+    def update(self,
+               topics: Optional[List[WebhookTopic]] = None,
+               url: Optional[str] = None,
+               status: Optional[WebhookStatus] = None):
         """ Updates the Webhook.
 
         Args:
-            topics (List[str]): The new topics.
-            url (str): The new URL value.
-            status (str): The new status.
+            topics (Optional[List[WebhookTopic]]): The new topics.
+            url  Optional[str): The new URL value.
+            status (Optional[WebhookStatus]): The new status.
 
         If values are set to None then there are no updates made to that field.