updating some type hints and also updating a grammatic error for tiled imagery

Author: jtsodapop

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

@@ -99,7 +99,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')
@@ -142,7 +142,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": [[
@@ -415,7 +415,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))
 
@@ -435,7 +435,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)
 
@@ -450,7 +450,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)
 
@@ -463,8 +463,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.
@@ -478,11 +479,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,
@@ -492,11 +494,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
+from typing import Callable, Optional, Tuple, Union, Dict
 
 import numpy as np
 from pydantic.class_validators import validator
@@ -37,7 +37,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)
         polygons = (
             shape(shp)

labelbox/data/annotation_types/geometry/rectangle.py

@@ -55,6 +55,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))

labelbox/data/ontology.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Tuple
+from typing import Dict, List, Tuple, Union
 
 from labelbox.schema import ontology
 from .annotation_types import (Text, Dropdown, Checklist, Radio,
@@ -84,8 +84,9 @@ def get_classifications(
     return list(existing_classifications.values())
 
 
-def get_tools(annotations: List[ObjectAnnotation],
-              existing_tools: List[ontology.Classification]):
+def get_tools(
+        annotations: List[ObjectAnnotation],
+        existing_tools: List[ontology.Classification]) -> List[ontology.Tool]:
     existing_tools = {tool.name: tool for tool in existing_tools}
     for annotation in annotations:
         if annotation.name in existing_tools:
@@ -103,7 +104,8 @@ def get_tools(annotations: List[ObjectAnnotation],
     return list(existing_tools.values())
 
 
-def tool_mapping(annotation):
+def tool_mapping(
+        annotation) -> Union[Mask, Polygon, Point, Rectangle, Line, TextEntity]:
     tool_types = ontology.Tool.Type
     mapping = {
         Mask: tool_types.SEGMENTATION,
@@ -121,7 +123,8 @@ def tool_mapping(annotation):
     return result
 
 
-def classification_mapping(annotation):
+def classification_mapping(
+        annotation) -> Union[Text, Checklist, Radio, Dropdown]:
     classification_types = ontology.Classification.Type
     mapping = {
         Text: classification_types.TEXT,

labelbox/data/serialization/labelbox_v1/classification.py

@@ -81,7 +81,7 @@ def from_common(cls, dropdown: Dropdown, feature_schema_id: Cuid,
 class LBV1Text(LBV1Feature):
     answer: str
 
-    def to_common(self):
+    def to_common(self) -> Text:
         return Text(answer=self.answer)
 
     @classmethod

labelbox/data/serialization/labelbox_v1/converter.py

@@ -20,7 +20,7 @@ class LBV1Converter:
 
     @staticmethod
     def deserialize_video(json_data: Iterable[Dict[str, Any]],
-                          client: "labelbox.Client"):
+                          client: "labelbox.Client") -> LabelGenerator:
         """
         Converts a labelbox video export into the common labelbox format.