Merge pull request #401 from Labelbox/al-1284

updating some type hints and also updating a grammatic error for tile…

Author: jtsodapop

labelbox/__init__.py

@@ -13,11 +13,13 @@
 from labelbox.schema.user import User
 from labelbox.schema.organization import Organization
 from labelbox.schema.task import Task
-from labelbox.schema.labeling_frontend import LabelingFrontend
+from labelbox.schema.labeling_frontend import LabelingFrontend, LabelingFrontendOptions
 from labelbox.schema.asset_attachment import AssetAttachment
 from labelbox.schema.webhook import Webhook
 from labelbox.schema.ontology import Ontology, OntologyBuilder, Classification, Option, Tool, FeatureSchema
 from labelbox.schema.role import Role, ProjectRole
 from labelbox.schema.invite import Invite, InviteLimit
 from labelbox.schema.data_row_metadata import DataRowMetadataOntology
 from labelbox.schema.model_run import ModelRun
+from labelbox.schema.benchmark import Benchmark
+from labelbox.schema.iam_integration import IAMIntegration

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,16 @@
 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
+from labelbox.schema.user import User
+from labelbox.schema.project import Project
+from labelbox.schema.role import Role
 
 logger = logging.getLogger(__name__)
 
@@ -411,7 +420,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 +435,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 +470,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 +483,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 +496,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 +536,9 @@ 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 +596,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 +613,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 +630,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 +639,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 +654,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 +667,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 +718,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 +729,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 +750,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 +771,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 +800,8 @@ 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 +840,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 +867,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/annotation_types/classification/classification.py

@@ -33,7 +33,7 @@ class ClassificationAnswer(FeatureSchema):
     extra: Dict[str, Any] = {}
     keyframe: Optional[bool] = None
 
-    def dict(self, *args, **kwargs):
+    def dict(self, *args, **kwargs) -> Dict[str, str]:
         res = super().dict(*args, **kwargs)
         if res['keyframe'] is None:
             res.pop('keyframe')

labelbox/data/annotation_types/collection.py

@@ -133,7 +133,7 @@ def _ensure_unique_external_ids(self) -> None:
                     )
             external_ids.add(label.data.external_id)
 
-    def append(self, label: Label):
+    def append(self, label: Label) -> None:
         self._data.append(label)
 
     def __iter__(self) -> "LabelList":

labelbox/data/annotation_types/data/raster.py

@@ -23,7 +23,8 @@ class RasterData(BaseModel, ABC):
 
     @classmethod
     def from_2D_arr(cls, arr: Union[TypedArray[Literal['uint8']],
-                                    TypedArray[Literal['int']]], **kwargs):
+                                    TypedArray[Literal['int']]],
+                    **kwargs) -> "RasterData":
         """Construct from a 2D numpy array
 
         Args:

labelbox/data/annotation_types/data/text.py

@@ -11,7 +11,7 @@ class TextData(BaseData):
     """
     Represents text data. Requires arg file_path, text, or url
 
-    >>> TextData(text="") 
+    >>> TextData(text="")
 
     Args:
         file_path (str)

labelbox/data/annotation_types/data/tiled_image.py

@@ -95,7 +95,7 @@ class TileLayer(BaseModel):
     url: str
     name: Optional[str] = "default"
 
-    def asdict(self) -> Dict:
+    def asdict(self) -> Dict[str, str]:
         return {"tileLayerUrl": self.url, "name": self.name}
 
     @validator('url')
@@ -138,7 +138,7 @@ def __post_init__(self) -> None:
         if self.max_native_zoom is None:
             self.max_native_zoom = self.zoom_levels[0]
 
-    def asdict(self) -> Dict:
+    def asdict(self) -> Dict[str, str]:
         return {
             "tileLayerUrl": self.tile_layer.url,
             "bounds": [[
@@ -411,7 +411,7 @@ def geo_and_pixel(cls,
 
         if src_epsg == EPSG.SIMPLEPIXEL:
 
-            def transform(x: int, y: int) -> Callable:
+            def transform(x: int, y: int) -> Callable[[int, int], Transformer]:
                 scaled_xy = (x * (global_x_range) / (local_x_range),
                              y * (global_y_range) / (local_y_range))
 
@@ -431,7 +431,7 @@ def transform(x: int, y: int) -> Callable:
         #handles 4326 from lat,lng
         elif src_epsg == EPSG.EPSG4326:
 
-            def transform(x: int, y: int) -> Callable:
+            def transform(x: int, y: int) -> Callable[[int, int], Transformer]:
                 point_in_px = PygeoPoint.from_latitude_longitude(
                     latitude=y, longitude=x).pixels(zoom)
 
@@ -446,7 +446,7 @@ def transform(x: int, y: int) -> Callable:
         #handles 3857 from meters
         elif src_epsg == EPSG.EPSG3857:
 
-            def transform(x: int, y: int) -> Callable:
+            def transform(x: int, y: int) -> Callable[[int, int], Transformer]:
                 point_in_px = PygeoPoint.from_meters(meter_y=y,
                                                      meter_x=x).pixels(zoom)
 
@@ -459,8 +459,9 @@ def transform(x: int, y: int) -> Callable:
             return transform
 
     @classmethod
-    def create_geo_to_geo_transformer(cls, src_epsg: EPSG,
-                                      tgt_epsg: EPSG) -> Callable:
+    def create_geo_to_geo_transformer(
+            cls, src_epsg: EPSG,
+            tgt_epsg: EPSG) -> Callable[[int, int], Transformer]:
         """method to change from one projection to another projection. 
 
         supports EPSG transformations not Simple.
@@ -474,11 +475,12 @@ def create_geo_to_geo_transformer(cls, src_epsg: EPSG,
             src_epsg.value, tgt_epsg.value, always_xy=True).transform)
 
     @classmethod
-    def create_geo_to_pixel_transformer(cls,
-                                        src_epsg,
-                                        pixel_bounds: TiledBounds,
-                                        geo_bounds: TiledBounds,
-                                        zoom=0) -> Callable:
+    def create_geo_to_pixel_transformer(
+            cls,
+            src_epsg,
+            pixel_bounds: TiledBounds,
+            geo_bounds: TiledBounds,
+            zoom=0) -> Callable[[int, int], Transformer]:
         """method to change from a geo projection to Simple"""
 
         transform_function = cls.geo_and_pixel(src_epsg=src_epsg,
@@ -488,11 +490,12 @@ def create_geo_to_pixel_transformer(cls,
         return EPSGTransformer(transformer=transform_function)
 
     @classmethod
-    def create_pixel_to_geo_transformer(cls,
-                                        src_epsg,
-                                        pixel_bounds: TiledBounds,
-                                        geo_bounds: TiledBounds,
-                                        zoom=0) -> Callable:
+    def create_pixel_to_geo_transformer(
+            cls,
+            src_epsg,
+            pixel_bounds: TiledBounds,
+            geo_bounds: TiledBounds,
+            zoom=0) -> Callable[[int, int], Transformer]:
         """method to change from a geo projection to Simple"""
         transform_function = cls.geo_and_pixel(src_epsg=src_epsg,
                                                pixel_bounds=pixel_bounds,

labelbox/data/annotation_types/geometry/mask.py

@@ -1,4 +1,4 @@
-from typing import Callable, Optional, Tuple, Union, List
+from typing import Callable, Optional, Tuple, Union, Dict, List
 
 import numpy as np
 from pydantic.class_validators import validator
@@ -36,7 +36,7 @@ class Mask(Geometry):
     color: Union[Tuple[int, int, int], int]
 
     @property
-    def geometry(self):
+    def geometry(self) -> Dict[str, Tuple[int, int, int]]:
         mask = self.draw(color=1)
         contours, hierarchy = cv2.findContours(image=mask,
                                                mode=cv2.RETR_TREE,

labelbox/data/annotation_types/geometry/rectangle.py

@@ -74,6 +74,6 @@ def draw(self,
         return cv2.polylines(canvas, pts, True, color, thickness)
 
     @classmethod
-    def from_xyhw(cls, x: float, y: float, h: float, w: float):
+    def from_xyhw(cls, x: float, y: float, h: float, w: float) -> "Rectangle":
         """Create Rectangle from x,y, height width format"""
         return cls(start=Point(x=x, y=y), end=Point(x=x + w, y=y + h))