Update comment

Author: lgluszek

libs/labelbox/src/labelbox/data/serialization/ndjson/label.py

@@ -62,7 +62,9 @@ class NDLabel(BaseModel):
     annotations: AnnotationType
 
     @classmethod
-    def from_common(cls, data: LabelCollection) -> Generator["NDLabel", None, None]:
+    def from_common(
+        cls, data: LabelCollection
+    ) -> Generator["NDLabel", None, None]:
         for label in data:
             yield from cls._create_relationship_annotations(label)
             yield from cls._create_non_video_annotations(label)
@@ -126,12 +128,16 @@ def _create_video_annotations(
             if isinstance(
                 annot, (VideoClassificationAnnotation, VideoObjectAnnotation)
             ):
-                video_annotations[annot.feature_schema_id or annot.name].append(annot)
+                video_annotations[annot.feature_schema_id or annot.name].append(
+                    annot
+                )
             elif isinstance(annot, VideoMaskAnnotation):
                 yield NDObject.from_common(annotation=annot, data=label.data)
 
         for annotation_group in video_annotations.values():
-            segment_frame_ranges = cls._get_segment_frame_ranges(annotation_group)
+            segment_frame_ranges = cls._get_segment_frame_ranges(
+                annotation_group
+            )
             if isinstance(annotation_group[0], VideoClassificationAnnotation):
                 annotation = annotation_group[0]
                 frames_data = []
@@ -197,10 +203,12 @@ def _create_relationship_annotations(
             NDRelationship: Validated relationship annotations in NDJSON format
 
         Raises:
-            TypeError: If source/target types violate the validation rules:
-                - Invalid source type for PDF target
-                - Non-ObjectAnnotation source for non-PDF target
-                - Non-ObjectAnnotation target
+            TypeError: If source/target types are invalid:
+                - Source:
+                    - For PDF target annotations (DocumentRectangle, DocumentEntity): source must be ObjectAnnotation or ClassificationAnnotation
+                    - For other target annotations: source must be ObjectAnnotation
+                - Target:
+                    - Target must always be ObjectAnnotation
         """
         for annotation in label.annotations:
             if isinstance(annotation, RelationshipAnnotation):
@@ -210,7 +218,9 @@ def _create_relationship_annotations(
                 target = copy.copy(annotation.value.target)
 
                 # Check if source type is valid based on target type
-                if isinstance(target.value, (DocumentRectangle, DocumentEntity)):
+                if isinstance(
+                    target.value, (DocumentRectangle, DocumentEntity)
+                ):
                     if not isinstance(
                         source, (ObjectAnnotation, ClassificationAnnotation)
                     ):

libs/labelbox/tests/data/annotation_import/test_relationships.py

@@ -179,7 +179,9 @@ def configured_project(
     data_row_data = []
 
     for _ in range(3):
-        data_row_data.append(data_row_json_by_media_type[media_type](rand_gen(str)))
+        data_row_data.append(
+            data_row_json_by_media_type[media_type](rand_gen(str))
+        )
 
     task = dataset.create_data_rows(data_row_data)
     task.wait_till_done()
@@ -254,7 +256,9 @@ def create_pdf_annotation(target_type: str) -> ObjectAnnotation:
             )
         raise ValueError(f"Unknown target type: {target_type}")
 
-    def verify_relationship(source: ClassificationAnnotation, target: ObjectAnnotation):
+    def verify_relationship(
+        source: ClassificationAnnotation, target: ObjectAnnotation
+    ):
         relationship = RelationshipAnnotation(
             name="relationship",
             value=Relationship(
@@ -263,12 +267,16 @@ def verify_relationship(source: ClassificationAnnotation, target: ObjectAnnotati
                 type=Relationship.Type.UNIDIRECTIONAL,
             ),
         )
-        label = Label(data={"global_key": "global_key"}, annotations=[relationship])
+        label = Label(
+            data={"global_key": "global_key"}, annotations=[relationship]
+        )
         result = list(NDJsonConverter.serialize([label]))
         assert len(result) == 1
 
     # Test case 1: Text Classification -> DocumentRectangle
-    text_source = ClassificationAnnotation(name="text", value=Text(answer="test"))
+    text_source = ClassificationAnnotation(
+        name="text", value=Text(answer="test")
+    )
     verify_relationship(text_source, create_pdf_annotation("bbox"))
 
     # Test case 2: Text Classification -> DocumentEntity
@@ -284,7 +292,9 @@ def verify_relationship(source: ClassificationAnnotation, target: ObjectAnnotati
                     ClassificationAnnotation(
                         name="second_sub_radio_question",
                         value=Radio(
-                            answer=ClassificationAnswer(name="second_sub_radio_answer")
+                            answer=ClassificationAnswer(
+                                name="second_sub_radio_answer"
+                            )
                         ),
                     )
                 ],
@@ -323,5 +333,7 @@ def test_classification_relationship_restrictions():
         TypeError,
         match="Unable to create relationship with non ObjectAnnotation source: .*",
     ):
-        label = Label(data={"global_key": "test_key"}, annotations=[relationship])
+        label = Label(
+            data={"global_key": "test_key"}, annotations=[relationship]
+        )
         list(NDJsonConverter.serialize([label]))