Warn if readonly is True

Author: kvilon

libs/labelbox/src/labelbox/data/annotation_types/relationship.py

@@ -1,6 +1,7 @@
 from typing import Union, Optional
-from pydantic import BaseModel
+from pydantic import BaseModel, model_validator
 from enum import Enum
+import warnings
 from labelbox.data.annotation_types.annotation import (
     BaseAnnotation,
     ObjectAnnotation,
@@ -18,6 +19,14 @@ class Type(Enum):
     type: Type = Type.UNIDIRECTIONAL
     readonly: Optional[bool] = None
 
+    @model_validator(mode='after')
+    def check_readonly(self):
+        if self.readonly is True:
+            warnings.warn(
+                "Creating a relationship with readonly=True is in beta and its behavior may change in future releases.",
+            )
+        return self
+
 
 class RelationshipAnnotation(BaseAnnotation):
     value: Relationship

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

@@ -31,6 +31,7 @@ def to_common(
                 source=source,
                 target=target,
                 type=Relationship.Type(annotation.relationship.type),
+                readonly=annotation.relationship.readonly,
             ),
             extra={"uuid": annotation.uuid},
             feature_schema_id=annotation.schema_id,