tried it out and not so sure about this...

Author: ardila

.DS_Store

@@ -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

@@ -50,6 +50,7 @@
 geometry        |   dict    |   Representation of the bounding box in the Box2DGeometry format.\n
 metadata        |   dict    |   An arbitrary metadata blob for the annotation.\n
 """
+__version__ = "0.0.1"
 
 import json
 import logging
@@ -65,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 (
@@ -961,6 +965,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

@@ -89,8 +89,10 @@ def __str__(self):
 
     @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, [])

nucleus/annotation.py

@@ -1,4 +1,4 @@
-from typing import Optional, List, Union
+from typing import Dict, Optional, List, Union, Type
 from .constants import (
     ANNOTATIONS_KEY,
     DEFAULT_ANNOTATION_UPDATE_MODE,
@@ -125,19 +125,32 @@ def loc(self, dataset_item_id: str):
 
     def _format_prediction_response(
         self, response: dict
-    ) -> Union[dict, List[Union[BoxPrediction, PolygonPrediction]]]:
+    ) -> Union[
+        dict,
+        List[Union[BoxPrediction, PolygonPrediction, SegmentationPrediction]],
+    ]:
         annotation_payload = response.get(ANNOTATIONS_KEY, None)
-        if annotation_payload:
-            annotation_response = {}
-            for (type_key, type_cls) in zip(
-                [BOX_TYPE, POLYGON_TYPE, SEGMENTATION_TYPE],
-                [BoxPrediction, PolygonPrediction, SegmentationPrediction],
-            ):
-                if type_key in annotation_payload:
-                    annotation_response[type_key] = [
-                        type_cls.from_json(ann)
-                        for ann in annotation_payload[type_key]
-                    ]
-            return annotation_response
-        else:  # An error occurred
+        SegmentationPrediction.from_json({"asdf": "asdf"})
+        if not annotation_payload:
+            # An error occurred
             return response
+        annotation_response = {}
+        type_key_to_class: Dict[
+            str,
+            Union[
+                Type[BoxPrediction],
+                Type[PolygonPrediction],
+                Type[SegmentationPrediction],
+            ],
+        ] = {
+            BOX_TYPE: BoxPrediction,
+            POLYGON_TYPE: PolygonPrediction,
+            SEGMENTATION_TYPE: SegmentationPrediction,
+        }
+        for type_key in annotation_payload:
+            type_class = type_key_to_class[type_key]
+            annotation_response[type_key] = [
+                type_class.from_json(annotation)
+                for annotation in annotation_payload[type_key]
+            ]
+        return annotation_response

nucleus/model_run.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Dict, Optional, List, Any
 from .annotation import (
     BoxAnnotation,
@@ -28,7 +30,7 @@ class SegmentationPrediction(SegmentationAnnotation):
     # No need to define init or to_payload methods because
     # we default to functions defined in the parent class
     @classmethod
-    def from_json(cls, payload: dict):
+    def from_json(cls, payload: dict) -> SegmentationPrediction:
         return cls(
             mask_url=payload[MASK_URL_KEY],
             annotations=[
@@ -76,7 +78,7 @@ def to_payload(self) -> dict:
         return payload
 
     @classmethod
-    def from_json(cls, payload: dict):
+    def from_json(cls, payload: dict) -> BoxPrediction:
         geometry = payload.get(GEOMETRY_KEY, {})
         return cls(
             label=payload.get(LABEL_KEY, 0),
@@ -119,7 +121,7 @@ def to_payload(self) -> dict:
         return payload
 
     @classmethod
-    def from_json(cls, payload: dict):
+    def from_json(cls, payload: dict) -> PolygonPrediction:
         geometry = payload.get(GEOMETRY_KEY, {})
         return cls(
             label=payload.get(LABEL_KEY, 0),

nucleus/prediction.py

@@ -1,9 +1,4 @@
-from typing import List, Dict, Any
-from .constants import (
-    DATASET_ITEM_ID_KEY,
-    REFERENCE_IDS_KEY,
-    DATASET_ITEM_IDS_KEY,
-)
+from typing import List
 
 
 class Slice:
@@ -47,18 +42,9 @@ def append(
             "slice_id": str,
         }
         """
-        if dataset_item_ids and reference_ids:
-            raise Exception(
-                "You cannot specify both dataset_item_ids and reference_ids"
-            )
-
-        payload: Dict[str, Any] = {}
-        if dataset_item_ids:
-            payload[DATASET_ITEM_IDS_KEY] = dataset_item_ids
-        if reference_ids:
-            payload[REFERENCE_IDS_KEY] = reference_ids
-
-        response = self._client._make_request(
-            payload, f"slice/{self.slice_id}/append"
+        response = self._client.append_to_slice(
+            slice_id=self.slice_id,
+            dataset_item_ids=dataset_item_ids,
+            reference_ids=reference_ids,
         )
         return response

nucleus/slice.py

@@ -3,7 +3,6 @@ line-length = 79
 target-version = ['py37']
 include = '\.pyi?$'
 exclude = '''
-
 (
   /(
       \.eggs         # exclude a few common directories in the
@@ -17,11 +16,49 @@ exclude = '''
     | build
     | dist
   )/
-  | foo.py           # also separately exclude a file named foo.py in
-                     # the root of the project
 )
 '''
 
 [build-system]
-requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta:__legacy__"
+requires = [
+  "flit_core >=2,<4",
+]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.metadata]
+module = "nucleus"
+author = "Scale AI"
+author-email = "select@scaleapi.com"
+home-page = "https://github.com/scaleapi/nucleus-python-client"
+classifiers = [ "License :: OSI Approved :: MIT License",]
+description-file = "README.md"
+dist-name = "scale-nucleus"
+requires = ["grequests >= 0.6.0",
+  "requests >= 2.22.0",
+  "tqdm >= 4.56.1"]
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+isolated_build = True
+envlist = py36,py37,py38,py39 
+
+[testenv]
+deps =
+  black
+  coverage
+  flake8
+  mypy
+  mccabe
+  pylint
+  boto3
+commands = 
+  black nucleus
+  flake8 nucleus
+  pylint nucleus
+  mypy nucleus --ignore-missing-imports
+  coverage erase
+  coverage run --include=tests/* -m pytest -ra
+  coverage report -m
+"""
+