Merge pull request #53 from scaleapi/da/repr2

Improve reprs for all objects in API

Author: ardila

.DS_Store

@@ -127,3 +127,7 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+
+# Mac OS desktop services store
+.DS_Store

.gitignore

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Scale AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

LICENSE

@@ -6,6 +6,7 @@
 # https://github.com/gevent/gevent/issues/1016#issuecomment-328530533
 # https://github.com/spyoungtech/grequests/issues/8
 import grequests
+
 ################
 
 import logging
@@ -19,26 +20,28 @@
 
 from tests.helpers import TEST_DATASET_NAME, TEST_DATASET_ITEMS
 
-assert 'NUCLEUS_PYTEST_API_KEY' in os.environ, \
-    "You must set the 'NUCLEUS_PYTEST_API_KEY' environment variable to a valid " \
+assert "NUCLEUS_PYTEST_API_KEY" in os.environ, (
+    "You must set the 'NUCLEUS_PYTEST_API_KEY' environment variable to a valid "
     "Nucleus API key to run the test suite"
+)
 
-API_KEY = os.environ['NUCLEUS_PYTEST_API_KEY']
+API_KEY = os.environ["NUCLEUS_PYTEST_API_KEY"]
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def monkeypatch_session(request):
-    """ This workaround is needed to allow monkeypatching in session-scoped fixtures.
+    """This workaround is needed to allow monkeypatching in session-scoped fixtures.
 
     See https://github.com/pytest-dev/pytest/issues/363
     """
     from _pytest.monkeypatch import MonkeyPatch
+
     mpatch = MonkeyPatch()
     yield mpatch
     mpatch.undo()
 
 
-@pytest.fixture(scope='session')
+@pytest.fixture(scope="session")
 def CLIENT(monkeypatch_session):
     client = nucleus.NucleusClient(API_KEY)
 
@@ -49,14 +52,16 @@ def _make_request_patch(
         payload: dict, route: str, requests_command=requests.post
     ) -> dict:
         response = client._make_request_raw(payload, route, requests_command)
-        assert response.status_code in SUCCESS_STATUS_CODES, \
-            f"HTTP response had status code: {response.status_code}. " \
+        assert response.status_code in SUCCESS_STATUS_CODES, (
+            f"HTTP response had status code: {response.status_code}. "
             f"Full JSON: {response.json()}"
+        )
         return response.json()
 
     monkeypatch_session.setattr(client, "_make_request", _make_request_patch)
     return client
 
+
 @pytest.fixture()
 def dataset(CLIENT):
     ds = CLIENT.create_dataset(TEST_DATASET_NAME)

conftest.py

@@ -66,8 +66,11 @@
 from requests.adapters import HTTPAdapter
 
 # pylint: disable=E1101
+# TODO: refactor to reduce this file to under 1000 lines.
+# pylint: disable=C0302
 from requests.packages.urllib3.util.retry import Retry
 
+from .constants import REFERENCE_IDS_KEY, DATASET_ITEM_IDS_KEY
 from .dataset import Dataset
 from .dataset_item import DatasetItem
 from .annotation import (
@@ -146,9 +149,19 @@ class NucleusClient:
     def __init__(self, api_key: str, use_notebook: bool = False):
         self.api_key = api_key
         self.tqdm_bar = tqdm.tqdm
+        self._use_notebook = use_notebook
         if use_notebook:
             self.tqdm_bar = tqdm_notebook.tqdm
 
+    def __repr__(self):
+        return f"NucleusClient(api_key='{self.api_key}', use_notebook={self._use_notebook})"
+
+    def __eq__(self, other):
+        if self.api_key == other.api_key:
+            if self._use_notebook == other._use_notebook:
+                return True
+        return False
+
     def list_models(self) -> List[Model]:
         """
         Lists available models in your repo.
@@ -962,6 +975,42 @@ def delete_slice(self, slice_id: str) -> dict:
         )
         return response
 
+    def append_to_slice(
+        self,
+        slice_id: str,
+        dataset_item_ids: List[str] = None,
+        reference_ids: List[str] = None,
+    ) -> dict:
+        """
+        Appends to a slice from items already present in a dataset.
+        The caller must exclusively use either datasetItemIds or reference_ids
+        as a means of identifying items in the dataset.
+
+        :param
+        dataset_item_ids: List[str],
+        reference_ids: List[str],
+
+        :return:
+        {
+            "slice_id": str,
+        }
+        """
+        if dataset_item_ids and reference_ids:
+            raise Exception(
+                "You cannot specify both dataset_item_ids and reference_ids"
+            )
+
+        ids_to_append: Dict[str, Any] = {}
+        if dataset_item_ids:
+            ids_to_append[DATASET_ITEM_IDS_KEY] = dataset_item_ids
+        if reference_ids:
+            ids_to_append[REFERENCE_IDS_KEY] = reference_ids
+
+        response = self._make_request(
+            ids_to_append, f"slice/{slice_id}/append"
+        )
+        return response
+
     def list_autotags(self, dataset_id: str) -> List[str]:
         """
         Fetches a list of autotags for a given dataset id

nucleus/__init__.py

@@ -21,8 +21,16 @@
     ANNOTATIONS_KEY,
 )
 
+from dataclasses import dataclass
+
 
 class Annotation:
+    def _check_ids(self):
+        if bool(self.reference_id) == bool(self.item_id):
+            raise Exception(
+                "You must specify either a reference_id or an item_id for an annotation."
+            )
+
     @classmethod
     def from_json(cls, payload: dict):
         if payload.get(TYPE_KEY, None) == BOX_TYPE:
@@ -33,16 +41,11 @@ def from_json(cls, payload: dict):
             return SegmentationAnnotation.from_json(payload)
 
 
+@dataclass
 class Segment:
-    def __init__(
-        self, label: str, index: int, metadata: Optional[dict] = None
-    ):
-        self.label = label
-        self.index = index
-        self.metadata = metadata
-
-    def __str__(self):
-        return str(self.to_payload())
+    label: str
+    index: int
+    metadata: Optional[dict] = None
 
     @classmethod
     def from_json(cls, payload: dict):
@@ -62,35 +65,25 @@ def to_payload(self) -> dict:
         return payload
 
 
+@dataclass
 class SegmentationAnnotation(Annotation):
-    def __init__(
-        self,
-        mask_url: str,
-        annotations: List[Segment],
-        reference_id: Optional[str] = None,
-        item_id: Optional[str] = None,
-        annotation_id: Optional[str] = None,
-    ):
-        super().__init__()
-        if not mask_url:
+    mask_url: str
+    annotations: List[Segment]
+    reference_id: Optional[str] = None
+    item_id: Optional[str] = None
+    annotation_id: Optional[str] = None
+
+    def __post_init__(self):
+        if not self.mask_url:
             raise Exception("You must specify a mask_url.")
-        if bool(reference_id) == bool(item_id):
-            raise Exception(
-                "You must specify either a reference_id or an item_id for an annotation."
-            )
-        self.mask_url = mask_url
-        self.annotations = annotations
-        self.reference_id = reference_id
-        self.item_id = item_id
-        self.annotation_id = annotation_id
-
-    def __str__(self):
-        return str(self.to_payload())
+        self._check_ids()
 
     @classmethod
     def from_json(cls, payload: dict):
+        if MASK_URL_KEY not in payload:
+            raise ValueError(f"Missing {MASK_URL_KEY} in json")
         return cls(
-            mask_url=payload.get(MASK_URL_KEY),
+            mask_url=payload[MASK_URL_KEY],
             annotations=[
                 Segment.from_json(ann)
                 for ann in payload.get(ANNOTATIONS_KEY, [])
@@ -118,35 +111,21 @@ class AnnotationTypes(Enum):
     POLYGON = POLYGON_TYPE
 
 
-# TODO: Add base annotation class to reduce repeated code here
+@dataclass
 class BoxAnnotation(Annotation):
-    # pylint: disable=too-many-instance-attributes
-    def __init__(
-        self,
-        label: str,
-        x: Union[float, int],
-        y: Union[float, int],
-        width: Union[float, int],
-        height: Union[float, int],
-        reference_id: Optional[str] = None,
-        item_id: Optional[str] = None,
-        annotation_id: Optional[str] = None,
-        metadata: Optional[Dict] = None,
-    ):
-        super().__init__()
-        if bool(reference_id) == bool(item_id):
-            raise Exception(
-                "You must specify either a reference_id or an item_id for an annotation."
-            )
-        self.label = label
-        self.x = x
-        self.y = y
-        self.width = width
-        self.height = height
-        self.reference_id = reference_id
-        self.item_id = item_id
-        self.annotation_id = annotation_id
-        self.metadata = metadata if metadata else {}
+    label: str
+    x: Union[float, int]
+    y: Union[float, int]
+    width: Union[float, int]
+    height: Union[float, int]
+    reference_id: Optional[str] = None
+    item_id: Optional[str] = None
+    annotation_id: Optional[str] = None
+    metadata: Optional[Dict] = None
+
+    def __post_init__(self):
+        self._check_ids()
+        self.metadata = self.metadata if self.metadata else {}
 
     @classmethod
     def from_json(cls, payload: dict):
@@ -178,32 +157,20 @@ def to_payload(self) -> dict:
             METADATA_KEY: self.metadata,
         }
 
-    def __str__(self):
-        return str(self.to_payload())
-
 
 # TODO: Add Generic type for 2D point
+@dataclass
 class PolygonAnnotation(Annotation):
-    def __init__(
-        self,
-        label: str,
-        vertices: List[Any],
-        reference_id: Optional[str] = None,
-        item_id: Optional[str] = None,
-        annotation_id: Optional[str] = None,
-        metadata: Optional[Dict] = None,
-    ):
-        super().__init__()
-        if bool(reference_id) == bool(item_id):
-            raise Exception(
-                "You must specify either a reference_id or an item_id for an annotation."
-            )
-        self.label = label
-        self.vertices = vertices
-        self.reference_id = reference_id
-        self.item_id = item_id
-        self.annotation_id = annotation_id
-        self.metadata = metadata if metadata else {}
+    label: str
+    vertices: List[Any]
+    reference_id: Optional[str] = None
+    item_id: Optional[str] = None
+    annotation_id: Optional[str] = None
+    metadata: Optional[Dict] = None
+
+    def __post_init__(self):
+        self._check_ids()
+        self.metadata = self.metadata if self.metadata else {}
 
     @classmethod
     def from_json(cls, payload: dict):
@@ -226,6 +193,3 @@ def to_payload(self) -> dict:
             ANNOTATION_ID_KEY: self.annotation_id,
             METADATA_KEY: self.metadata,
         }
-
-    def __str__(self):
-        return str(self.to_payload())

nucleus/annotation.py

@@ -32,6 +32,15 @@ def __init__(self, dataset_id: str, client):
         self.id = dataset_id
         self._client = client
 
+    def __repr__(self):
+        return f"Dataset(dataset_id='{self.id}', client={self._client})"
+
+    def __eq__(self, other):
+        if self.id == other.id:
+            if self._client == other._client:
+                return True
+        return False
+
     @property
     def name(self) -> str:
         return self.info().get(DATASET_NAME_KEY, "")