All objects have better repr now

Author: ardila

nucleus/__init__.py

@@ -141,7 +141,6 @@
 )
 
 
-
 class NucleusClient:
     """
     Nucleus client.
@@ -163,8 +162,6 @@ def __eq__(self, other):
                 return True
         return False
 
-    
-
     def list_models(self) -> List[Model]:
         """
         Lists available models in your repo.

nucleus/annotation.py

@@ -23,8 +23,8 @@
 
 from dataclasses import dataclass
 
-class Annotation:
 
+class Annotation:
     def _check_ids(self):
         if not bool(self.reference_id) and not bool(self.item_id):
             raise Exception(
@@ -40,6 +40,7 @@ def from_json(cls, payload: dict):
         else:
             return SegmentationAnnotation.from_json(payload)
 
+
 @dataclass
 class Segment:
     label: str
@@ -71,11 +72,11 @@ class SegmentationAnnotation(Annotation):
     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.")
         self._check_ids()
-        
 
     @classmethod
     def from_json(cls, payload: dict):
@@ -121,6 +122,7 @@ class BoxAnnotation(Annotation):
     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 {}
@@ -165,6 +167,7 @@ class PolygonAnnotation(Annotation):
     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 {}

nucleus/dataset.py

@@ -34,7 +34,7 @@ def __init__(self, dataset_id: str, 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:

nucleus/model.py

@@ -29,7 +29,7 @@ def __init__(
         self._client = client
 
     def __repr__(self):
-        return f"Model(model_id={self.id}, name={self.name}, reference_id={self.reference_id}, metadata={self.metadata}, client={self._client})"
+        return f"Model(model_id='{self.id}', name='{self.name}', reference_id='{self.reference_id}', metadata={self.metadata}, client={self._client})"
 
     def __eq__(self, other):
         return self.id == other.id

nucleus/model_run.py

@@ -23,6 +23,15 @@ def __init__(self, model_run_id: str, client):
         self.model_run_id = model_run_id
         self._client = client
 
+    def __repr__(self):
+        return f"ModelRun(model_run_id='{self.model_run_id}', client={self._client})"
+
+    def __eq__(self, other):
+        if self.model_run_id == other.model_run_id:
+            if self._client == other._client:
+                return True
+        return False
+
     def info(self) -> dict:
         """
         provides information about the Model Run:

nucleus/slice.py

@@ -9,6 +9,15 @@ class Slice:
     def __init__(self, slice_id: str, client):
         self.slice_id = slice_id
         self._client = client
+    
+    def __repr__(self):
+        return f"Slice(slice_id='{self.slice_id}', client={self._client})"
+
+    def __eq__(self, other):
+        if self.slice_id == other.slice_id:
+            if self._client == other._client:
+                return True
+        return False
 
     def info(self) -> dict:
         """

nucleus/upload_response.py

@@ -39,6 +39,12 @@ def __init__(self, json: dict):
         self.error_codes: Set[str] = set()
         self.error_payload = upload_error_payload
 
+    def __repr__(self):
+        return f"UploadResponse(json={self.json()})"
+
+    def __eq__(self, other):
+        return self.json() == other.json()
+
     def update_response(self, json):
         """
         :param json: { new_items: int, updated_items: int, ignored_items: int, upload_errors: int, }

tests/test_models.py

@@ -7,6 +7,7 @@
     Model,
     ModelRun,
     BoxPrediction,
+    NucleusClient
 )
 from nucleus.constants import (
     NEW_ITEMS,
@@ -23,6 +24,16 @@
     TEST_PREDS,
 )
 
+# Have to define here in order to have access to all relevant objects
+def test_repr(test_object: any):
+    assert eval(str(test_object)) == test_object
+
+def test_reprs():
+    client = NucleusClient(api_key="fake_key")
+    test_repr(Model(client=client, model_id="fake_model_id", name="fake_name", reference_id="fake_reference_id", metadata={"fake": "metadata"}))
+    test_repr(ModelRun(client=client, model_run_id="fake_model_run_id"))
+
+
 
 def test_model_creation_and_listing(CLIENT, dataset):
     models_before = CLIENT.list_models()