use alias instead of camelcase for ndjson

Author: Matt Sokoloff

labelbox/data/serialization/ndjson/base.py

@@ -1,5 +1,5 @@
 from uuid import uuid4
-from pydantic import BaseModel, validator
+from pydantic import BaseModel, validator, Field
 
 
 def to_camel(string: str) -> str:
@@ -21,21 +21,20 @@ def validate_id(cls, v):
 
 class NDJsonBase(BaseModel):
     uuid: str = None
-    dataRow: DataRow
+    data_row: DataRow = Field(..., alias="dataRow")
 
     @validator('uuid', pre=True, always=True)
     def set_id(cls, v):
         return v or str(uuid4())
 
     class Config:
-        #alias_generator = to_camel
         allow_population_by_field_name = True
 
 
 class NDAnnotation(NDJsonBase):
-    schemaId: str = None
+    schema_id: str = Field(None, alias="schemaId")
 
-    @validator('schemaId', pre=True, always=True)
+    @validator('schema_id', pre=True, always=True)
     def validate_id(cls, v):
         if v is None:
             raise ValueError(

labelbox/data/serialization/ndjson/classifications.py

@@ -1,23 +1,26 @@
 from typing import List, Union, Optional
 
-from pydantic import BaseModel, validator
+from pydantic import BaseModel, validator, Field
 
 from ...annotation_types.annotation import AnnotationType, ClassificationAnnotation, VideoClassificationAnnotation
 from ...annotation_types.classification.classification import ClassificationAnswer, Dropdown, Text, Checklist, Radio
 from .base import NDAnnotation
 
 
 class NDFeature(BaseModel):
-    schemaId: str  #= Field(..., alias = 'schemaId')
+    schema_id: str = Field(..., alias='schemaId')
 
-    @validator('schemaId', pre=True, always=True)
+    @validator('schema_id', pre=True, always=True)
     def validate_id(cls, v):
         if v is None:
             raise ValueError(
                 "Schema ids are not set. Use `LabelGenerator.assign_schema_ids`, `LabelCollection.assign_schema_ids`, or `Label.assign_schema_ids`."
             )
         return v
 
+    class Config:
+        allow_population_by_field_name = True
+
 
 class FrameLocation(BaseModel):
     end: int
@@ -45,38 +48,39 @@ def to_common(self) -> Text:
     @classmethod
     def from_common(cls, annotation) -> "NDTextSubclass":
         return cls(answer=annotation.value.answer,
-                   schemaId=annotation.schema_id)
+                   schema_id=annotation.schema_id)
 
 
 class NDChecklistSubclass(NDFeature):
     answer: List[NDFeature]
 
     def to_common(self) -> Checklist:
         return Checklist(answer=[
-            ClassificationAnswer(schema_id=answer.schemaId)
+            ClassificationAnswer(schema_id=answer.schema_id)
             for answer in self.answer
         ])
 
     @classmethod
     def from_common(cls, annotation) -> "NDChecklistSubclass":
         return cls(answer=[
-            NDFeature(schemaId=answer.schema_id)
+            NDFeature(schema_id=answer.schema_id)
             for answer in annotation.value.answer
         ],
-                   schemaId=annotation.schema_id)
+                   schema_id=annotation.schema_id)
 
 
 class NDRadioSubclass(NDFeature):
     answer: NDFeature
 
     def to_common(self) -> Radio:
         return Radio(answer=ClassificationAnswer(
-            schema_id=self.answer.schemaId))
+            schema_id=self.answer.schema_id))
 
     @classmethod
     def from_common(cls, annotation) -> "NDRadioSubclass":
-        return cls(answer=NDFeature(schemaId=annotation.value.answer.schema_id),
-                   schemaId=annotation.schema_id)
+        return cls(
+            answer=NDFeature(schema_id=annotation.value.answer.schema_id),
+            schema_id=annotation.schema_id)
 
 
 ### ====== End of subclasses
@@ -89,7 +93,7 @@ def from_common(cls, annotation, data) -> "NDText":
         return cls(
             answer=annotation.value.answer,
             dataRow={'id': data.uid},
-            schemaId=annotation.schema_id,
+            schema_id=annotation.schema_id,
             uuid=annotation.extra.get('uuid'),
         )
 
@@ -99,11 +103,11 @@ class NDChecklist(NDAnnotation, NDChecklistSubclass, VideoSupported):
     @classmethod
     def from_common(cls, annotation, data) -> "NDChecklist":
         return cls(answer=[
-            NDFeature(schemaId=answer.schema_id)
+            NDFeature(schema_id=answer.schema_id)
             for answer in annotation.value.answer
         ],
                    dataRow={'id': data.uid},
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    frames=annotation.extra.get('frames'))
 
@@ -112,11 +116,12 @@ class NDRadio(NDAnnotation, NDRadioSubclass, VideoSupported):
 
     @classmethod
     def from_common(cls, annotation, data) -> "NDRadio":
-        return cls(answer=NDFeature(schemaId=annotation.value.answer.schema_id),
-                   dataRow={'id': data.uid},
-                   schemaId=annotation.schema_id,
-                   uuid=annotation.extra.get('uuid'),
-                   frames=annotation.extra.get('frames'))
+        return cls(
+            answer=NDFeature(schema_id=annotation.value.answer.schema_id),
+            dataRow={'id': data.uid},
+            schema_id=annotation.schema_id,
+            uuid=annotation.extra.get('uuid'),
+            frames=annotation.extra.get('frames'))
 
 
 class NDSubclassification:
@@ -135,7 +140,7 @@ def from_common(
     @staticmethod
     def to_common(annotation: AnnotationType) -> ClassificationAnnotation:
         return ClassificationAnnotation(value=annotation.to_common(),
-                                        schema_id=annotation.schemaId)
+                                        schema_id=annotation.schema_id)
 
     @staticmethod
     def lookup_subclassification(annotation: AnnotationType):
@@ -155,7 +160,7 @@ def to_common(
         annotation: AnnotationType
     ) -> Union[ClassificationAnnotation, VideoClassificationAnnotation]:
         common = ClassificationAnnotation(value=annotation.to_common(),
-                                          schema_id=annotation.schemaId,
+                                          schema_id=annotation.schema_id,
                                           extra={'uuid': annotation.uuid})
         if getattr(annotation, 'frames', None) is None:
             return [common]

labelbox/data/serialization/ndjson/label.py

@@ -19,10 +19,10 @@ class NDLabel(BaseModel):
     def to_common(self) -> LabelGenerator:
         data_rows = {}
         for annotation in self.annotations:
-            if annotation.dataRow.id in data_rows:
-                data_rows[annotation.dataRow.id].append(annotation)
+            if annotation.data_row.id in data_rows:
+                data_rows[annotation.data_row.id].append(annotation)
             else:
-                data_rows[annotation.dataRow.id] = [annotation]
+                data_rows[annotation.data_row.id] = [annotation]
 
         def generate_annotations() -> LabelGenerator:
             for data_row_id, annotations in data_rows.items():

labelbox/data/serialization/ndjson/objects.py

@@ -40,7 +40,7 @@ def from_common(cls, annotation, data) -> "NDPoint":
             'y': annotation.value.y
         },
                    dataRow=DataRow(id=data.uid),
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    classifications=[
                        NDSubclassification.from_common(annot)
@@ -61,7 +61,7 @@ def from_common(cls, annotation, data) -> "NDLine":
             'y': pt.y
         } for pt in annotation.value.points],
                    dataRow=DataRow(id=data.uid),
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    classifications=[
                        NDSubclassification.from_common(annot)
@@ -83,7 +83,7 @@ def from_common(cls, annotation, data) -> "NDPolygon":
             'y': pt.y
         } for pt in annotation.value.points],
                    dataRow=DataRow(id=data.uid),
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    classifications=[
                        NDSubclassification.from_common(annot)
@@ -107,7 +107,7 @@ def from_common(cls, annotation, data) -> "NDRectangle":
             height=annotation.value.end.y - annotation.value.start.y,
             width=annotation.value.end.x - annotation.value.start.x),
                    dataRow=DataRow(id=data.uid),
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    classifications=[
                        NDSubclassification.from_common(annot)
@@ -132,7 +132,7 @@ def from_common(cls, annotation, data) -> "NDMask":
         return cls(mask=_Mask(instanceURI=annotation.value.mask.url,
                               colorRGB=annotation.value.color_rgb),
                    dataRow=DataRow(id=data.uid),
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    classifications=[
                        NDSubclassification.from_common(annot)
@@ -158,7 +158,7 @@ def from_common(cls, annotation, data) -> "NDTextEntity":
             end=annotation.value.end,
         ),
                    dataRow=DataRow(id=data.uid),
-                   schemaId=annotation.schema_id,
+                   schema_id=annotation.schema_id,
                    uuid=annotation.extra.get('uuid'),
                    classifications=[
                        NDSubclassification.from_common(annot)
@@ -176,7 +176,7 @@ def to_common(annotation) -> ObjectAnnotation:
             for annot in annotation.classifications
         ]
         return ObjectAnnotation(value=common_annotation,
-                                schema_id=annotation.schemaId,
+                                schema_id=annotation.schema_id,
                                 classifications=classifications,
                                 extra={'uuid': annotation.uuid})