Merge pull request #242 from Labelbox/ms/abc

abstract base classes

Author: msokoloff1

CHANGELOG.md

@@ -4,8 +4,7 @@
 ## Updates
 * Geometry.raster now has a consistent interface and improved functionality
 * renamed schema_id to feature_schema_id in the `FeatureSchema` class
-* ImageData can load 2d images or masks
-* Mask objects now use `MaskData` to represent segmentation masks instead of `ImageData`
+* `Mask` objects now use `MaskData` to represent segmentation masks instead of `ImageData`
 
 # Version 3.0.0-rc2 (2021-08-09)
 ## Updates

labelbox/data/annotation_types/data/base_data.py

@@ -1,9 +1,10 @@
+from abc import ABC
 from typing import Optional
 
 from pydantic import BaseModel
 
 
-class BaseData(BaseModel):
+class BaseData(BaseModel, ABC):
     """
     Base class for objects representing data.
     This class shouldn't directly be used

labelbox/data/annotation_types/data/raster.py

@@ -1,5 +1,6 @@
 from typing import Callable, Optional
 from io import BytesIO
+from abc import ABC
 
 import numpy as np
 from pydantic import BaseModel
@@ -13,7 +14,7 @@
 from ..types import TypedArray
 
 
-class RasterData(BaseModel):
+class RasterData(BaseModel, ABC):
     """
     Represents an image or segmentation mask.
     """

labelbox/data/annotation_types/geometry/geometry.py

@@ -1,36 +1,25 @@
 from typing import Dict, Any, Optional, Union, Tuple
+from abc import ABC, abstractmethod
 
 import geojson
 import numpy as np
 from shapely import geometry as geom
 from pydantic import BaseModel
 
 
-class Geometry(BaseModel):
+class Geometry(BaseModel, ABC):
     """
-    Base class for geometry objects. Shouldn't be directly instantiated.
+    Base class for geometry objects.
     """
     extra: Dict[str, Any] = {}
 
-    @property
-    def geometry(self) -> geojson:
-        raise NotImplementedError("Subclass must override this")
-
     @property
     def shapely(
         self
     ) -> Union[geom.Point, geom.LineString, geom.Polygon, geom.MultiPoint,
                geom.MultiLineString, geom.MultiPolygon]:
         return geom.shape(self.geometry)
 
-    def raster(self,
-               height: Optional[int] = None,
-               width: Optional[int] = None,
-               canvas: Optional[np.ndarray] = None,
-               color: Optional[Union[int, Tuple[int, int, int]]] = None,
-               thickness: Optional[int] = 1) -> np.ndarray:
-        raise NotImplementedError("Subclass must override this")
-
     def get_or_create_canvas(self, height: Optional[int], width: Optional[int],
                              canvas: Optional[np.ndarray]) -> np.ndarray:
         if canvas is None:
@@ -39,3 +28,17 @@ def get_or_create_canvas(self, height: Optional[int], width: Optional[int],
                     "Must either provide canvas or height and width")
             canvas = np.zeros((height, width, 3), dtype=np.uint8)
         return canvas
+
+    @property
+    @abstractmethod
+    def geometry(self) -> geojson:
+        pass
+
+    @abstractmethod
+    def raster(self,
+               height: Optional[int] = None,
+               width: Optional[int] = None,
+               canvas: Optional[np.ndarray] = None,
+               color: Optional[Union[int, Tuple[int, int, int]]] = None,
+               thickness: Optional[int] = 1) -> np.ndarray:
+        pass