update with schema folder

Author: jtsodapop

labelbox/client.py

@@ -11,6 +11,8 @@
 from google.api_core import retry
 import requests
 import requests.exceptions
+from labelbox.data.annotation_types.feature import FeatureSchema
+from labelbox.data.serialization.ndjson.base import DataRow
 
 import labelbox.exceptions
 from labelbox import utils
@@ -20,9 +22,13 @@
 from labelbox.orm.model import Entity
 from labelbox.pagination import PaginatedCollection
 from labelbox.schema.data_row_metadata import DataRowMetadataOntology
+from labelbox.schema.dataset import Dataset
 from labelbox.schema.iam_integration import IAMIntegration
 from labelbox.schema import role
-from labelbox.schema.ontology import Tool, Classification
+from labelbox.schema.labeling_frontend import LabelingFrontend
+from labelbox.schema.model import Model
+from labelbox.schema.ontology import Ontology, Tool, Classification
+from labelbox.schema.organization import Organization
 
 logger = logging.getLogger(__name__)
 
@@ -411,7 +417,7 @@ def get_project(self, project_id):
         """
         return self._get_single(Entity.Project, project_id)
 
-    def get_dataset(self, dataset_id):
+    def get_dataset(self, dataset_id) -> Dataset:
         """ Gets a single Dataset with the given ID.
 
             >>> dataset = client.get_dataset("<dataset_id>")
@@ -426,14 +432,14 @@ def get_dataset(self, dataset_id):
         """
         return self._get_single(Entity.Dataset, dataset_id)
 
-    def get_user(self):
+    def get_user(self) -> User:
         """ Gets the current User database object.
 
             >>> user = client.get_user()
         """
         return self._get_single(Entity.User, None)
 
-    def get_organization(self):
+    def get_organization(self) -> Organization:
         """ Gets the Organization DB object of the current user.
 
             >>> organization = client.get_organization()
@@ -461,7 +467,7 @@ def _get_all(self, db_object_type, where, filter_deleted=True):
             [utils.camel_case(db_object_type.type_name()) + "s"],
             db_object_type)
 
-    def get_projects(self, where=None):
+    def get_projects(self, where=None) -> List[Project]:
         """ Fetches all the projects the user has access to.
 
             >>> projects = client.get_projects(where=(Project.name == "<project_name>") & (Project.description == "<project_description>"))
@@ -474,7 +480,7 @@ def get_projects(self, where=None):
         """
         return self._get_all(Entity.Project, where)
 
-    def get_datasets(self, where=None):
+    def get_datasets(self, where=None) -> List[Dataset]:
         """ Fetches one or more datasets.
 
             >>> datasets = client.get_datasets(where=(Dataset.name == "<dataset_name>") & (Dataset.description == "<dataset_description>"))
@@ -487,7 +493,7 @@ def get_datasets(self, where=None):
         """
         return self._get_all(Entity.Dataset, where)
 
-    def get_labeling_frontends(self, where=None):
+    def get_labeling_frontends(self, where=None) -> List[LabelingFrontend]:
         """ Fetches all the labeling frontends.
 
             >>> frontend = client.get_labeling_frontends(where=LabelingFrontend.name == "Editor")
@@ -527,7 +533,7 @@ def _create(self, db_object_type, data):
         res = res["create%s" % db_object_type.type_name()]
         return db_object_type(self, res)
 
-    def create_dataset(self, iam_integration=IAMIntegration._DEFAULT, **kwargs):
+    def create_dataset(self, iam_integration=IAMIntegration._DEFAULT, **kwargs) -> Dataset:
         """ Creates a Dataset object on the server.
 
         Attribute values are passed as keyword arguments.
@@ -585,7 +591,7 @@ def create_dataset(self, iam_integration=IAMIntegration._DEFAULT, **kwargs):
             raise e
         return dataset
 
-    def create_project(self, **kwargs):
+    def create_project(self, **kwargs) -> Project:
         """ Creates a Project object on the server.
 
         Attribute values are passed as keyword arguments.
@@ -602,15 +608,15 @@ def create_project(self, **kwargs):
         """
         return self._create(Entity.Project, kwargs)
 
-    def get_roles(self):
+    def get_roles(self) -> List[Role]:
         """
         Returns:
             Roles: Provides information on available roles within an organization.
             Roles are used for user management.
         """
         return role.get_roles(self)
 
-    def get_data_row(self, data_row_id):
+    def get_data_row(self, data_row_id) -> DataRow:
         """
 
         Returns:
@@ -619,7 +625,7 @@ def get_data_row(self, data_row_id):
 
         return self._get_single(Entity.DataRow, data_row_id)
 
-    def get_data_row_metadata_ontology(self):
+    def get_data_row_metadata_ontology(self) -> DataRowMetadataOntology:
         """
 
         Returns:
@@ -628,7 +634,7 @@ def get_data_row_metadata_ontology(self):
         """
         return DataRowMetadataOntology(self)
 
-    def get_model(self, model_id):
+    def get_model(self, model_id) -> Model:
         """ Gets a single Model with the given ID.
 
             >>> model = client.get_model("<model_id>")
@@ -643,7 +649,7 @@ def get_model(self, model_id):
         """
         return self._get_single(Entity.Model, model_id)
 
-    def get_models(self, where=None):
+    def get_models(self, where=None) -> List[Model]:
         """ Fetches all the models the user has access to.
 
             >>> models = client.get_models(where=(Model.name == "<model_name>"))
@@ -656,7 +662,7 @@ def get_models(self, where=None):
         """
         return self._get_all(Entity.Model, where, filter_deleted=False)
 
-    def create_model(self, name, ontology_id):
+    def create_model(self, name, ontology_id) -> Model:
         """ Creates a Model object on the server.
 
         >>> model = client.create_model(<model_name>, <ontology_id>)
@@ -707,7 +713,7 @@ def get_data_row_ids_for_external_ids(
                 result[row['externalId']].append(row['dataRowId'])
         return result
 
-    def get_ontology(self, ontology_id):
+    def get_ontology(self, ontology_id) -> Ontology:
         """
         Fetches an Ontology by id.
 
@@ -718,7 +724,7 @@ def get_ontology(self, ontology_id):
         """
         return self._get_single(Entity.Ontology, ontology_id)
 
-    def get_ontologies(self, name_contains):
+    def get_ontologies(self, name_contains) -> PaginatedCollection]:
         """
         Fetches all ontologies with names that match the name_contains string.
 
@@ -739,7 +745,7 @@ def get_ontologies(self, name_contains):
                                    ['ontologies', 'nodes'], Entity.Ontology,
                                    ['ontologies', 'nextCursor'])
 
-    def get_feature_schema(self, feature_schema_id):
+    def get_feature_schema(self, feature_schema_id) -> FeatureSchema:
         """
         Fetches a feature schema. Only supports top level feature schemas.
 
@@ -760,7 +766,7 @@ def get_feature_schema(self, feature_schema_id):
         res['id'] = res['normalized']['featureSchemaId']
         return Entity.FeatureSchema(self, res)
 
-    def get_feature_schemas(self, name_contains):
+    def get_feature_schemas(self, name_contains) -> PaginatedCollection:
         """
         Fetches top level feature schemas with names that match the `name_contains` string
 
@@ -789,7 +795,7 @@ def rootSchemaPayloadToFeatureSchema(client, payload):
                                    rootSchemaPayloadToFeatureSchema,
                                    ['rootSchemaNodes', 'nextCursor'])
 
-    def create_ontology_from_feature_schemas(self, name, feature_schema_ids):
+    def create_ontology_from_feature_schemas(self, name, feature_schema_ids) -> Ontology:
         """
         Creates an ontology from a list of feature schema ids
 
@@ -828,7 +834,7 @@ def create_ontology_from_feature_schemas(self, name, feature_schema_ids):
         normalized = {'tools': tools, 'classifications': classifications}
         return self.create_ontology(name, normalized)
 
-    def create_ontology(self, name, normalized):
+    def create_ontology(self, name, normalized) -> Ontology:
         """
         Creates an ontology from normalized data
             >>> normalized = {"tools" : [{'tool': 'polygon',  'name': 'cat', 'color': 'black'}], "classifications" : []}
@@ -855,7 +861,7 @@ def create_ontology(self, name, normalized):
         res = self.execute(query_str, params)
         return Entity.Ontology(self, res['upsertOntology'])
 
-    def create_feature_schema(self, normalized):
+    def create_feature_schema(self, normalized) -> FeatureSchema:
         """
         Creates a feature schema from normalized data.
             >>> normalized = {'tool': 'polygon',  'name': 'cat', 'color': 'black'}

labelbox/data/serialization/labelbox_v1/objects.py

@@ -23,7 +23,7 @@ class LBV1ObjectBase(LBV1Feature):
     classifications: List[Union[LBV1Text, LBV1Radio, LBV1Dropdown,
                                 LBV1Checklist]] = []
 
-    def dict(self, *args, **kwargs) -> Dict[str, str]:
+    def dict(self, *args, **kwargs) -> Dict[str, Any]:
         res = super().dict(*args, **kwargs)
         # This means these are not video frames ..
         if self.instanceURI is None:

labelbox/schema/benchmark.py

@@ -27,7 +27,7 @@ class Benchmark(DbObject):
 
     reference_label = Relationship.ToOne("Label", False, "reference_label")
 
-    def delete(self):
+    def delete(self) -> None:
         label_param = "labelId"
         query_str = """mutation DeleteBenchmarkPyApi($%s: ID!) {
             deleteBenchmark(where: {labelId: $%s}) {id}} """ % (label_param,

labelbox/schema/data_row.py

@@ -49,15 +49,16 @@ def __init__(self, *args, **kwargs):
         self.attachments.supports_sorting = False
 
     @staticmethod
-    def bulk_delete(data_rows):
+    def bulk_delete(data_rows) -> None:
         """ Deletes all the given DataRows.
 
         Args:
             data_rows (list of DataRow): The DataRows to delete.
         """
         BulkDeletable._bulk_delete(data_rows, True)
 
-    def create_attachment(self, attachment_type, attachment_value):
+    def create_attachment(self, attachment_type,
+                          attachment_value) -> AssetAttachment:
         """ Adds an AssetAttachment to a DataRow.
             Labelers can view these attachments while labeling.
 

labelbox/schema/dataset.py

@@ -1,15 +1,19 @@
-from labelbox.schema import iam_integration
-from labelbox import utils
+from typing import Generator, List
 import os
 import json
 import logging
-from itertools import islice
-from concurrent.futures import ThreadPoolExecutor, as_completed
+from collections.abc import Iterable
 import time
 import ndjson
+from itertools import islice
+
+from labelbox.data.serialization.ndjson.base import DataRow
+from labelbox.schema import iam_integration
+from labelbox.schema.task import Task
+from labelbox import utils
+from concurrent.futures import ThreadPoolExecutor, as_completed
 from io import StringIO
 import requests
-from collections.abc import Iterable
 
 from labelbox.exceptions import InvalidQueryError, LabelboxError, ResourceNotFoundError, InvalidAttributeError
 from labelbox.orm.db_object import DbObject, Updateable, Deletable
@@ -48,7 +52,7 @@ class Dataset(DbObject, Updateable, Deletable):
     iam_integration = Relationship.ToOne("IAMIntegration", False,
                                          "iam_integration", "signer")
 
-    def create_data_row(self, **kwargs):
+    def create_data_row(self, **kwargs) -> DataRow:
         """ Creates a single DataRow belonging to this dataset.
 
         >>> dataset.create_data_row(row_data="http://my_site.com/photos/img_01.jpg")
@@ -76,7 +80,7 @@ def create_data_row(self, **kwargs):
         kwargs[DataRow.dataset.name] = self
         return self.client._create(DataRow, kwargs)
 
-    def create_data_rows_sync(self, items):
+    def create_data_rows_sync(self, items) -> None:
         """ Synchronously bulk upload data rows.
 
         Use this instead of `Dataset.create_data_rows` for smaller batches of data rows that need to be uploaded quickly.
@@ -117,7 +121,7 @@ def create_data_rows_sync(self, items):
             url_param: descriptor_url
         })
 
-    def create_data_rows(self, items):
+    def create_data_rows(self, items) -> Task:
         """ Asynchronously bulk upload data rows
 
         Use this instead of `Dataset.create_data_rows_sync` uploads for batches that contain more than 1000 data rows.
@@ -311,16 +315,16 @@ def convert_item(item):
         data = json.dumps(items)
         return self.client.upload_data(data)
 
-    def data_rows_for_external_id(self, external_id, limit=10):
-        """ Convenience method for getting a single `DataRow` belonging to this
+    def data_rows_for_external_id(self, external_id, limit=10) -> List[DataRow]:
+        """ Convenience method for getting a multiple `DataRow` belonging to this
         `Dataset` that has the given `external_id`.
 
         Args:
             external_id (str): External ID of the sought `DataRow`.
             limit (int): The maximum number of data rows to return for the given external_id
 
         Returns:
-            A single `DataRow` with the given ID.
+            A list of `DataRow` with the given ID.
 
         Raises:
             labelbox.exceptions.ResourceNotFoundError: If there is no `DataRow`
@@ -338,7 +342,7 @@ def data_rows_for_external_id(self, external_id, limit=10):
             raise ResourceNotFoundError(DataRow, where)
         return data_rows
 
-    def data_row_for_external_id(self, external_id):
+    def data_row_for_external_id(self, external_id) -> DataRow:
         """ Convenience method for getting a single `DataRow` belonging to this
         `Dataset` that has the given `external_id`.
 
@@ -361,7 +365,7 @@ def data_row_for_external_id(self, external_id):
                 external_id)
         return data_rows[0]
 
-    def export_data_rows(self, timeout_seconds=120):
+    def export_data_rows(self, timeout_seconds=120) -> Generator:
         """ Returns a generator that produces all data rows that are currently
         attached to this dataset.
 

labelbox/schema/label.py

@@ -1,6 +1,8 @@
+from labelbox.data.serialization.labelbox_v1.label import Review
 from labelbox.orm import query
 from labelbox.orm.db_object import DbObject, Updateable, BulkDeletable
 from labelbox.orm.model import Entity, Field, Relationship
+from labelbox.schema.benchmark import Benchmark
 """ Client-side object type definitions. """
 
 
@@ -40,15 +42,15 @@ def __init__(self, *args, **kwargs):
     created_by = Relationship.ToOne("User", False, "created_by")
 
     @staticmethod
-    def bulk_delete(labels):
+    def bulk_delete(labels) -> None:
         """ Deletes all the given Labels.
 
         Args:
             labels (list of Label): The Labels to delete.
         """
         BulkDeletable._bulk_delete(labels, False)
 
-    def create_review(self, **kwargs):
+    def create_review(self, **kwargs) -> Review:
         """ Creates a Review for this label.
 
         Args:
@@ -58,7 +60,7 @@ def create_review(self, **kwargs):
         kwargs[Entity.Review.project.name] = self.project()
         return self.client._create(Entity.Review, kwargs)
 
-    def create_benchmark(self):
+    def create_benchmark(self) -> Benchmark:
         """ Creates a Benchmark for this Label.
 
         Returns: