Release v.3.63.0 (#1425)

Author: vbrodsky

CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+# Version 3.63.0 (2024-02-19)
+## Added
+* Ability for users to install and use sdk with pydantic v.2.* while still maintaining support for pydantic v1.*
+* `ModelRun` `export()` and `export_v2()` add model_run_details to support splits
+
+## Notebooks
+* Add composite mask notebook
 
 # Version 3.62.0 (2024-02-12)
 ## Added

docs/source/conf.py

@@ -21,7 +21,7 @@
 copyright = '2021, Labelbox'
 author = 'Labelbox'
 
-release = '3.62.0'
+release = '3.63.0'
 
 # -- General configuration ---------------------------------------------------
 

examples/exports/composite_mask_export.ipynb

@@ -16,12 +16,12 @@
       "metadata": {},
       "source": [
         "<td>\n",
-        "<a href=\"https://colab.research.google.com/github/Labelbox/labelbox-python/blob/master/examples/basics/export_data.ipynb\" target=\"_blank\"><img\n",
+        "<a href=\"https://colab.research.google.com/github/Labelbox/labelbox-python/blob/master/examples/exports/export_data.ipynb\" target=\"_blank\"><img\n",
         "src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n",
         "</td>\n",
         "\n",
         "<td>\n",
-        "<a href=\"https://github.com/Labelbox/labelbox-python/tree/master/examples/basics/export_data.ipynb\" target=\"_blank\"><img\n",
+        "<a href=\"https://github.com/Labelbox/labelbox-python/tree/master/examples/exports/export_data.ipynb\" target=\"_blank\"><img\n",
         "src=\"https://img.shields.io/badge/GitHub-100000?logo=github&logoColor=white\" alt=\"GitHub\"></a>\n",
         "</td>"
       ],
@@ -39,7 +39,7 @@
       "metadata": {},
       "source": [
         "!pip install -q \"labelbox[data]\"\n",
-        "!pip install -q urllib3 "
+        "!pip install -q urllib3"
       ],
       "cell_type": "code",
       "outputs": [],
@@ -136,7 +136,7 @@
     {
       "metadata": {},
       "source": [
-        "# Set the export params to include/exclude certain fields. \n",
+        "# Set the export params to include/exclude certain fields.\n",
         "export_params= {\n",
         "  \"attachments\": True,\n",
         "  \"metadata_fields\": True,\n",
@@ -180,7 +180,7 @@
     {
       "metadata": {},
       "source": [
-        "# Set the export params to include/exclude certain fields. \n",
+        "# Set the export params to include/exclude certain fields.\n",
         "export_params= {\n",
         "  \"attachments\": True,\n",
         "  \"metadata_fields\": True,\n",
@@ -221,7 +221,7 @@
         "\n",
         "if export_task.has_errors():\n",
         "  export_task.get_stream(\n",
-        "  \n",
+        "\n",
         "  converter=lb.JsonConverter(),\n",
         "  stream_type=lb.StreamType.ERRORS\n",
         "  ).start(stream_handler=lambda error: print(error))\n",
@@ -252,7 +252,7 @@
         "#         stream_type=lb.StreamType.ERRORS\n",
         "#     ).start()\n",
         "\n",
-        "# if export_task.has_result(): \n",
+        "# if export_task.has_result():\n",
         "#     export_task.get_stream(\n",
         "#         converter=lb.FileConverter(file_path=\"./result.txt\"),\n",
         "#         stream_type=lb.StreamType.RESULT\n",
@@ -324,7 +324,7 @@
         "  \"performance_details\": True,\n",
         "  \"interpolated_frames\": True,\n",
         "  # \"project_ids\": [\"<project_id>\", \"<project_id>\"],\n",
-        "  # \"model_run_ids\": [\"<model_run_id>\", \"<model_run_id>\"]  \n",
+        "  # \"model_run_ids\": [\"<model_run_id>\", \"<model_run_id>\"]\n",
         "}\n",
         "\n",
         "# Note: Filters follow AND logic, so typically using one filter is sufficient.\n",
@@ -367,7 +367,7 @@
         "  \"performance_details\": True,\n",
         "  \"interpolated_frames\": True,\n",
         "  # \"project_ids\": [\"<project_id>\", \"<project_id>\"],\n",
-        "  # \"model_run_ids\": [\"<model_run_id>\", \"<model_run_id>\"]  \n",
+        "  # \"model_run_ids\": [\"<model_run_id>\", \"<model_run_id>\"]\n",
         "}\n",
         "\n",
         "# Note: Filters follow AND logic, so typically using one filter is sufficient.\n",
@@ -427,7 +427,7 @@
         "#         stream_type=lb.StreamType.ERRORS\n",
         "#     ).start()\n",
         "\n",
-        "# if export_task.has_result(): \n",
+        "# if export_task.has_result():\n",
         "#     export_task.get_stream(\n",
         "#         converter=lb.FileConverter(file_path=\"./result.txt\"),\n",
         "#         stream_type=lb.StreamType.RESULT\n",
@@ -575,7 +575,7 @@
         "#         stream_type=lb.StreamType.ERRORS\n",
         "#     ).start()\n",
         "\n",
-        "# if export_task.has_result(): \n",
+        "# if export_task.has_result():\n",
         "#     export_task.get_stream(\n",
         "#         converter=lb.FileConverter(file_path=\"./result.txt\"),\n",
         "#         stream_type=lb.StreamType.RESULT\n",
@@ -719,7 +719,7 @@
         "#         stream_type=lb.StreamType.ERRORS\n",
         "#     ).start()\n",
         "\n",
-        "# if export_task.has_result(): \n",
+        "# if export_task.has_result():\n",
         "#     export_task.get_stream(\n",
         "#         converter=lb.FileConverter(file_path=\"./result.txt\"),\n",
         "#         stream_type=lb.StreamType.RESULT\n",
@@ -877,7 +877,7 @@
     {
       "metadata": {},
       "source": [
-        "# Make the API request \n",
+        "# Make the API request\n",
         "req = urllib.request.Request(mask_url, headers=client.headers)"
       ],
       "cell_type": "code",

examples/basics/export_data.ipynb renamed to examples/exports/export_data.ipynb

@@ -1,6 +1,6 @@
 name = "labelbox"
 
-__version__ = "3.62.0"
+__version__ = "3.63.0"
 
 from labelbox.client import Client
 from labelbox.schema.project import Project

labelbox/__init__.py

@@ -299,11 +299,14 @@ def get_error_status_code(error: dict) -> int:
                                              "extensions", "code")
         if internal_server_error is not None:
             message = internal_server_error.get("message")
+            error_status_code = get_error_status_code(internal_server_error)
 
-            if get_error_status_code(internal_server_error) == 400:
+            if error_status_code == 400:
                 raise labelbox.exceptions.InvalidQueryError(message)
-            elif get_error_status_code(internal_server_error) == 426:
+            elif error_status_code == 426:
                 raise labelbox.exceptions.OperationNotAllowedException(message)
+            elif error_status_code == 500:
+                raise labelbox.exceptions.LabelboxError(message)
             else:
                 raise labelbox.exceptions.InternalServerError(message)
 

labelbox/client.py

@@ -1,15 +1,15 @@
 import abc
 from uuid import UUID
 from typing import Any, Dict, Optional
-from pydantic import PrivateAttr
+from labelbox import pydantic_compat
 
 from .feature import FeatureSchema
 
 
 class BaseAnnotation(FeatureSchema, abc.ABC):
     """ Base annotation class. Shouldn't be directly instantiated
     """
-    _uuid: Optional[UUID] = PrivateAttr()
+    _uuid: Optional[UUID] = pydantic_compat.PrivateAttr()
     extra: Dict[str, Any] = {}
 
     def __init__(self, **data):

labelbox/data/annotation_types/base_annotation.py

@@ -9,12 +9,12 @@
 except:
     from typing_extensions import Literal
 
-from pydantic import BaseModel, validator
+from labelbox import pydantic_compat
 from ..feature import FeatureSchema
 
 
 # TODO: Replace when pydantic adds support for unions that don't coerce types
-class _TempName(ConfidenceMixin, BaseModel):
+class _TempName(ConfidenceMixin, pydantic_compat.BaseModel):
     name: str
 
     def dict(self, *args, **kwargs):
@@ -47,7 +47,7 @@ def dict(self, *args, **kwargs) -> Dict[str, str]:
         return res
 
 
-class Radio(ConfidenceMixin, CustomMetricsMixin, BaseModel):
+class Radio(ConfidenceMixin, CustomMetricsMixin, pydantic_compat.BaseModel):
     """ A classification with only one selected option allowed
 
     >>> Radio(answer = ClassificationAnswer(name = "dog"))
@@ -66,7 +66,7 @@ class Checklist(_TempName):
     answer: List[ClassificationAnswer]
 
 
-class Text(ConfidenceMixin, CustomMetricsMixin, BaseModel):
+class Text(ConfidenceMixin, CustomMetricsMixin, pydantic_compat.BaseModel):
     """ Free form text
 
     >>> Text(answer = "some text answer")

labelbox/data/annotation_types/classification/classification.py

@@ -1,10 +1,10 @@
 from abc import ABC
 from typing import Optional, Dict, List, Any
 
-from pydantic import BaseModel
+from labelbox import pydantic_compat
 
 
-class BaseData(BaseModel, ABC):
+class BaseData(pydantic_compat.BaseModel, ABC):
     """
     Base class for objects representing data.
     This class shouldn't directly be used

labelbox/data/annotation_types/data/base_data.py

@@ -5,18 +5,17 @@
 
 from PIL import Image
 from google.api_core import retry
-from pydantic import BaseModel
-from pydantic import root_validator
 from requests.exceptions import ConnectTimeout
 import requests
 import numpy as np
 
+from labelbox import pydantic_compat
 from labelbox.exceptions import InternalServerError
 from .base_data import BaseData
 from ..types import TypedArray
 
 
-class RasterData(BaseModel, ABC):
+class RasterData(pydantic_compat.BaseModel, ABC):
     """Represents an image or segmentation mask.
     """
     im_bytes: Optional[bytes] = None
@@ -156,7 +155,7 @@ def create_url(self, signer: Callable[[bytes], str]) -> str:
                 "One of url, im_bytes, file_path, arr must not be None.")
         return self.url
 
-    @root_validator()
+    @pydantic_compat.root_validator()
     def validate_args(cls, values):
         file_path = values.get("file_path")
         im_bytes = values.get("im_bytes")