label-studio-sdk 1.0.8__py3-none-any.whl → 1.0.11__py3-none-any.whl

label_studio_sdk/views/client.py

@@ -1,16 +1,17 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from json.decoder import JSONDecodeError
-
-from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.jsonable_encoder import jsonable_encoder
-from ..core.pydantic_utilities import pydantic_v1
+from ..core.client_wrapper import SyncClientWrapper
 from ..core.request_options import RequestOptions
 from ..types.view import View
+from ..core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
 from .types.views_create_request_data import ViewsCreateRequestData
+from ..core.serialization import convert_and_respect_annotation_metadata
+from ..core.jsonable_encoder import jsonable_encoder
 from .types.views_update_request_data import ViewsUpdateRequestData
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -24,6 +25,7 @@ class ViewsClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[View]:
         """
+
         List all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize which tasks and information appears.
 
         You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
@@ -43,7 +45,7 @@ class ViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -51,11 +53,22 @@ class ViewsClient:
         client.views.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/dm/views/", method="GET", params={"project": project}, request_options=request_options
+            "api/dm/views/",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[View], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[View],
+                    parse_obj_as(
+                        type_=typing.List[View],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -69,6 +82,7 @@ class ViewsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> View:
         """
+
         Create a new Data Manager view for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks and information appears.
 
         You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
@@ -91,7 +105,7 @@ class ViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -101,13 +115,27 @@ class ViewsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/dm/views/",
             method="POST",
-            json={"data": data, "project": project},
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=ViewsCreateRequestData, direction="write"
+                ),
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+                return typing.cast(
+                    View,
+                    parse_obj_as(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -115,6 +143,7 @@ class ViewsClient:
 
     def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks appear.
 
         You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
@@ -132,7 +161,7 @@ class ViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -144,7 +173,12 @@ class ViewsClient:
         _response = self._client_wrapper.httpx_client.request(
             "api/dm/views/reset/",
             method="DELETE",
-            json={"project": project},
+            json={
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -158,6 +192,7 @@ class ViewsClient:
 
     def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
         """
+
         Get the details about a specific Data Manager view (tab). You will need to supply the view ID. You can find this using [List views](list).
 
         Parameters
@@ -175,7 +210,7 @@ class ViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -185,11 +220,19 @@ class ViewsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+                return typing.cast(
+                    View,
+                    parse_obj_as(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -213,7 +256,7 @@ class ViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -223,7 +266,9 @@ class ViewsClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -242,6 +287,7 @@ class ViewsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> View:
         """
+
         You can update a specific Data Manager view (tab) with additional filters and other customizations. You will need to supply the view ID. You can find this using [List views](list).
 
         Parameters
@@ -265,7 +311,7 @@ class ViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -277,13 +323,27 @@ class ViewsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/dm/views/{jsonable_encoder(id)}/",
             method="PATCH",
-            json={"data": data, "project": project},
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=ViewsUpdateRequestData, direction="write"
+                ),
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+                return typing.cast(
+                    View,
+                    parse_obj_as(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -298,6 +358,7 @@ class AsyncViewsClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[View]:
         """
+
         List all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize which tasks and information appears.
 
         You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
@@ -317,19 +378,38 @@ class AsyncViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.views.list()
+
+
+        async def main() -> None:
+            await client.views.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/dm/views/", method="GET", params={"project": project}, request_options=request_options
+            "api/dm/views/",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[View], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[View],
+                    parse_obj_as(
+                        type_=typing.List[View],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -343,6 +423,7 @@ class AsyncViewsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> View:
         """
+
         Create a new Data Manager view for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks and information appears.
 
         You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
@@ -365,23 +446,45 @@ class AsyncViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.views.create()
+
+
+        async def main() -> None:
+            await client.views.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/dm/views/",
             method="POST",
-            json={"data": data, "project": project},
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=ViewsCreateRequestData, direction="write"
+                ),
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+                return typing.cast(
+                    View,
+                    parse_obj_as(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -389,6 +492,7 @@ class AsyncViewsClient:
 
     async def delete_all(self, *, project: int, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete all views for a specific project. A view is a tab in the Data Manager where you can set filters and customize what tasks appear.
 
         You will need to provide the project ID. You can find this in the URL when viewing the project in Label Studio, or you can use [List all projects](../projects/list).
@@ -406,19 +510,32 @@ class AsyncViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.views.delete_all(
-            project=1,
-        )
+
+
+        async def main() -> None:
+            await client.views.delete_all(
+                project=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/dm/views/reset/",
             method="DELETE",
-            json={"project": project},
+            json={
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -432,6 +549,7 @@ class AsyncViewsClient:
 
     async def get(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> View:
         """
+
         Get the details about a specific Data Manager view (tab). You will need to supply the view ID. You can find this using [List views](list).
 
         Parameters
@@ -449,21 +567,37 @@ class AsyncViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.views.get(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.views.get(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/", method="GET", request_options=request_options
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+                return typing.cast(
+                    View,
+                    parse_obj_as(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -487,17 +621,27 @@ class AsyncViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.views.delete(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.views.delete(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/dm/views/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
+            f"api/dm/views/{jsonable_encoder(id)}/",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -516,6 +660,7 @@ class AsyncViewsClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> View:
         """
+
         You can update a specific Data Manager view (tab) with additional filters and other customizations. You will need to supply the view ID. You can find this using [List views](list).
 
         Parameters
@@ -539,25 +684,47 @@ class AsyncViewsClient:
 
         Examples
         --------
-        from label_studio_sdk.client import AsyncLabelStudio
+        import asyncio
+
+        from label_studio_sdk import AsyncLabelStudio
 
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.views.update(
-            id="id",
-        )
+
+
+        async def main() -> None:
+            await client.views.update(
+                id="id",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/dm/views/{jsonable_encoder(id)}/",
             method="PATCH",
-            json={"data": data, "project": project},
+            json={
+                "data": convert_and_respect_annotation_metadata(
+                    object_=data, annotation=ViewsUpdateRequestData, direction="write"
+                ),
+                "project": project,
+            },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(View, _response.json())  # type: ignore
+                return typing.cast(
+                    View,
+                    parse_obj_as(
+                        type_=View,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

label_studio_sdk/views/types/views_create_request_data.py

@@ -1,43 +1,33 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
+from ...core.pydantic_utilities import UniversalBaseModel
 import typing
-
-from ...core.datetime_utils import serialize_datetime
-from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 from .views_create_request_data_filters import ViewsCreateRequestDataFilters
+import pydantic
 from .views_create_request_data_ordering_item import ViewsCreateRequestDataOrderingItem
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ViewsCreateRequestData(pydantic_v1.BaseModel):
+class ViewsCreateRequestData(UniversalBaseModel):
     """
     Custom view data
     """
 
-    filters: typing.Optional[ViewsCreateRequestDataFilters] = pydantic_v1.Field(default=None)
+    filters: typing.Optional[ViewsCreateRequestDataFilters] = pydantic.Field(default=None)
     """
     Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.<br>Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`
     """
 
-    ordering: typing.Optional[typing.List[ViewsCreateRequestDataOrderingItem]] = pydantic_v1.Field(default=None)
+    ordering: typing.Optional[typing.List[ViewsCreateRequestDataOrderingItem]] = pydantic.Field(default=None)
     """
     List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`.
     """
 
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
-
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
-        )
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
 
-    class Config:
-        frozen = True
-        smart_union = True
-        extra = pydantic_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

label_studio_sdk/views/types/views_create_request_data_filters.py

@@ -1,43 +1,33 @@
 # This file was auto-generated by Fern from our API Definition.
 
-import datetime as dt
-import typing
-
-from ...core.datetime_utils import serialize_datetime
-from ...core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
+from ...core.pydantic_utilities import UniversalBaseModel
 from .views_create_request_data_filters_conjunction import ViewsCreateRequestDataFiltersConjunction
+import pydantic
+import typing
 from .views_create_request_data_filters_items_item import ViewsCreateRequestDataFiltersItemsItem
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
 
 
-class ViewsCreateRequestDataFilters(pydantic_v1.BaseModel):
+class ViewsCreateRequestDataFilters(UniversalBaseModel):
     """
     Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.<br>Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`
     """
 
-    conjunction: ViewsCreateRequestDataFiltersConjunction = pydantic_v1.Field()
+    conjunction: ViewsCreateRequestDataFiltersConjunction = pydantic.Field()
     """
     Logical conjunction for the filters. This conjunction (either "or" or "and") will be applied to all items in the filters list. It is not possible to combine "or" and "and" within one list of filters. All filters will be either combined with "or" or with "and", but not a mix of both.
     """
 
-    items: typing.List[ViewsCreateRequestDataFiltersItemsItem] = pydantic_v1.Field()
+    items: typing.List[ViewsCreateRequestDataFiltersItemsItem] = pydantic.Field()
     """
     List of filter items
     """
 
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        return super().json(**kwargs_with_defaults)
-
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
-        kwargs_with_defaults_exclude_unset: typing.Any = {"by_alias": True, "exclude_unset": True, **kwargs}
-        kwargs_with_defaults_exclude_none: typing.Any = {"by_alias": True, "exclude_none": True, **kwargs}
-
-        return deep_union_pydantic_dicts(
-            super().dict(**kwargs_with_defaults_exclude_unset), super().dict(**kwargs_with_defaults_exclude_none)
-        )
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
 
-    class Config:
-        frozen = True
-        smart_union = True
-        extra = pydantic_v1.Extra.allow
-        json_encoders = {dt.datetime: serialize_datetime}
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow