chore: FIT-1717: Feature Request: Label Studio SDK - Migrate away from deprecated Pydantic v1 models

GitOrigin-RevId: abb2d0d2be9b8daace6f0c562d7250c207175ebc

Author: matt-bernstein

poetry.lock

@@ -4,11 +4,10 @@
 import json
 import logging
 import os
+from typing import Optional
 
 import requests
-
-from typing import Optional
-from pydantic import BaseModel, constr, root_validator
+from pydantic import BaseModel, constr, model_validator
 from requests.adapters import HTTPAdapter
 
 logger = logging.getLogger(__name__)
@@ -24,7 +23,7 @@ class ClientCredentials(BaseModel):
     password: Optional[str] = None
     api_key: Optional[constr()] = None
 
-    @root_validator(pre=True, allow_reuse=True)
+    @model_validator(mode="before")
     def either_key_or_email_password(cls, values):
         assert (
             "email" in values or "api_key" in values

src/label_studio_sdk/_legacy/client.py

@@ -1,15 +1,14 @@
 """
 """
 
-import xml.etree.ElementTree
 import json
-from typing import Type, Dict, Optional, List, Tuple, Any, Union
-from pydantic import BaseModel, confloat, Field, validator
+import xml.etree.ElementTree
+from typing import Any, Dict, List, Optional, Tuple, Type, Union
 
 from .base import LabelStudioTag, get_tag_class
-from .region import Region
 from .object_tags import ObjectTag
-
+from .region import Region
+from pydantic import BaseModel, Field, confloat, field_validator
 
 _NOT_CONTROL_TAGS = {
     "Filter",
@@ -731,7 +730,8 @@ class BrushValue(BaseModel):
     format: str = "rle"
     rle: List[int]
 
-    @validator('rle')
+    @field_validator("rle")
+    @classmethod
     def validate_rle(cls, rle_data):
         if not validate_rle(rle_data):
             raise ValueError('Invalid RLE format')
@@ -1400,12 +1400,12 @@ class RelationsTag(ControlTag):
     tag: str = "Relations"
     def validate_value(self, **kwargs) -> bool:
         """ """
-        raise NotImplemented("""Should not be called directly, instead
+        raise NotImplementedError("""Should not be called directly, instead
         use validate_relation() method found in LabelInterface class""")
 
     def label(self, *args, **kwargs):
         """ """
-        raise NotImplemented("""
+        raise NotImplementedError("""
         Relations work on regions instead of Object tags
         use Regions add_relation() method""")
 
@@ -1605,7 +1605,6 @@ def _parse_delimited_list(self, outputs_str: str) -> list:
         Returns:
             list: List of parsed output field names/definitions.
         """
-        import re
         # Split on common delimiters: comma, semicolon, pipe, or whitespace
         # But preserve content inside parentheses for type aliases
         parts = []

src/label_studio_sdk/label_interface/control_tags.py

@@ -1,7 +1,7 @@
-from typing import Type, Dict, Optional, List, Tuple, Any, Union
-from pydantic import BaseModel, Field, confloat, field_serializer
+from typing import Any, Dict, List, Optional, Union
 
 from .region import Region
+from pydantic import BaseModel, ConfigDict, Field, field_serializer
 
 
 def serialize_regions(result):
@@ -24,9 +24,7 @@ class PredictionValue(BaseModel):
     score: Optional[float] = 0.00
     result: Optional[List[Union[Dict[str, Any], Region]]]
 
-    class Config:
-        populate_by_name = True
-        protected_namespaces = ()
+    model_config = ConfigDict(populate_by_name=True, protected_namespaces=())
 
     @field_serializer('result')
     def serialize_result(self, result):
@@ -44,8 +42,7 @@ class AnnotationValue(BaseModel):
 
     result: Optional[List[Union[Dict[str, Any], Region]]]
 
-    class Config:
-        populate_by_name = True
+    model_config = ConfigDict(populate_by_name=True)
 
     @field_serializer('result')
     def serialize_result(self, result):

src/label_studio_sdk/label_interface/objects.py

@@ -0,0 +1,29 @@
+import importlib
+import warnings
+
+
+def _collect_module_deprecation_warning_messages(module_name: str) -> list[str]:
+    with warnings.catch_warnings(record=True) as caught:
+        warnings.simplefilter("always", DeprecationWarning)
+        module = importlib.import_module(module_name)
+        importlib.reload(module)
+    return [str(warning.message) for warning in caught]
+
+
+def test_legacy_client_import_has_no_v1_root_validator_deprecation_warning():
+    warning_messages = _collect_module_deprecation_warning_messages("label_studio_sdk._legacy.client")
+
+    assert all("V1 style `@root_validator` validators are deprecated" not in message for message in warning_messages)
+    assert all("`allow_reuse` is deprecated" not in message for message in warning_messages)
+
+
+def test_control_tags_import_has_no_v1_validator_deprecation_warning():
+    warning_messages = _collect_module_deprecation_warning_messages("label_studio_sdk.label_interface.control_tags")
+
+    assert all("V1 style `@validator` validators are deprecated" not in message for message in warning_messages)
+
+
+def test_objects_import_has_no_class_config_deprecation_warning():
+    warning_messages = _collect_module_deprecation_warning_messages("label_studio_sdk.label_interface.objects")
+
+    assert all("Support for class-based `config` is deprecated" not in message for message in warning_messages)