add Dataset.scenes property (#191)

* add scenes_list

* sneak in some other typehint fixes

* bump ver and update changelog

* add TODOs for test

* rename scenes_list -> scenes

* add to tests

* lint

Author: drakejwong

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to the [Nucleus Python Client](https://github.com/scaleapi/n
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.5](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.4.4) - 2021-01-07
+
+### Added
+- `Dataset.scenes` property that fetches the Scale-generated ID, reference ID, type, and metadata of all scenes in the Dataset.
+
 ## [0.4.4](https://github.com/scaleapi/nucleus-python-client/releases/tag/v0.4.4) - 2021-01-04
 
 ### Added

nucleus/dataset.py

@@ -140,7 +140,7 @@ def is_scene(self) -> bool:
         return response
 
     @property
-    def model_runs(self) -> Dict[Any, Any]:
+    def model_runs(self) -> List[str]:
         """List of all model runs associated with the Dataset."""
         # TODO: model_runs -> models
         response = self._client.make_request(
@@ -149,7 +149,7 @@ def model_runs(self) -> Dict[Any, Any]:
         return response
 
     @property
-    def slices(self) -> Dict[Any, Any]:
+    def slices(self) -> List[str]:
         """List of all Slice IDs created from the Dataset."""
         response = self._client.make_request(
             {}, f"dataset/{self.id}/slices", requests.get
@@ -185,6 +185,15 @@ def items(self) -> List[DatasetItem]:
             raise DatasetItemRetrievalError(message=error)
         return constructed_dataset_items
 
+    @property
+    def scenes(self) -> List[Dict[str, Any]]:
+        """List of ID, reference ID, type, and metadata for all scenes in the Dataset."""
+        response = self._client.make_request(
+            {}, f"dataset/{self.id}/scenes_list", requests.get
+        )
+
+        return response.get("scenes", None)
+
     @sanitize_string_args
     def autotag_items(self, autotag_name, for_scores_greater_than=0):
         """Fetches the autotag's items above the score threshold, sorted by descending score.

pyproject.toml

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = "scale-nucleus"
-version = "0.4.4"
+version = "0.4.5"
 description = "The official Python client library for Nucleus, the Data Platform for AI"
 license =  "MIT"
 authors = ["Scale AI Nucleus Team <nucleusapi@scaleapi.com>"]

tests/test_scene.py

@@ -274,6 +274,16 @@ def test_scene_upload_sync(dataset_scene):
     assert response["dataset_id"] == dataset_scene.id
     assert response["new_scenes"] == len(scenes)
 
+    uploaded_scenes = dataset_scene.scenes
+    assert len(uploaded_scenes) == len(scenes)
+    assert all(
+        u["reference_id"] == o.reference_id
+        for u, o in zip(uploaded_scenes, scenes)
+    )
+    assert all(
+        u["metadata"] == o.metadata for u, o in zip(uploaded_scenes, scenes)
+    )
+
 
 @pytest.mark.skip("Deactivated sync upload for scenes")
 @pytest.mark.integration
@@ -289,6 +299,16 @@ def test_scene_and_cuboid_upload_sync(dataset_scene):
     assert response["dataset_id"] == dataset_scene.id
     assert response["new_scenes"] == len(scenes)
 
+    uploaded_scenes = dataset_scene.scenes
+    assert len(uploaded_scenes) == len(scenes)
+    assert all(
+        u["reference_id"] == o.reference_id
+        for u, o in zip(uploaded_scenes, scenes)
+    )
+    assert all(
+        u["metadata"] == o.metadata for u, o in zip(uploaded_scenes, scenes)
+    )
+
     lidar_item_ref = payload[SCENES_KEY][0][FRAMES_KEY][0]["lidar"][
         REFERENCE_ID_KEY
     ]
@@ -341,6 +361,16 @@ def test_scene_upload_async(dataset_scene):
         "total_steps": 1,
     }
 
+    uploaded_scenes = dataset_scene.scenes
+    assert len(uploaded_scenes) == len(scenes)
+    assert all(
+        u["reference_id"] == o.reference_id
+        for u, o in zip(uploaded_scenes, scenes)
+    )
+    assert all(
+        u["metadata"] == o.metadata for u, o in zip(uploaded_scenes, scenes)
+    )
+
 
 @pytest.mark.skip(reason="Temporarily skipped because failing 12/28/21")
 @pytest.mark.integration
@@ -349,7 +379,6 @@ def test_scene_upload_and_update(dataset_scene):
     scenes = [
         LidarScene.from_json(scene_json) for scene_json in payload[SCENES_KEY]
     ]
-    reference_ids = [s.reference_id for s in scenes]
     update = payload[UPDATE_KEY]
 
     job = dataset_scene.append(scenes, update=update, asynchronous=True)
@@ -374,10 +403,15 @@ def test_scene_upload_and_update(dataset_scene):
         "total_steps": 1,
     }
 
-    fetched_scenes = [
-        dataset_scene.get_scene(ref_id) for ref_id in reference_ids
-    ]
-    assert len(fetched_scenes) == len(scenes)
+    uploaded_scenes = dataset_scene.scenes
+    assert len(uploaded_scenes) == len(scenes)
+    assert all(
+        u["reference_id"] == o.reference_id
+        for u, o in zip(uploaded_scenes, scenes)
+    )
+    assert all(
+        u["metadata"] == o.metadata for u, o in zip(uploaded_scenes, scenes)
+    )
 
     job2 = dataset_scene.append(scenes, update=True, asynchronous=True)
     job2.sleep_until_complete()