label-studio-sdk 1.0.3__py3-none-any.whl → 1.0.4__py3-none-any.whl

label_studio_sdk/projects/client_ext.py

@@ -1,6 +1,18 @@
+import typing
+from typing_extensions import Annotated
 from .client import ProjectsClient, AsyncProjectsClient
-
+from pydantic import model_validator, validator, Field, ConfigDict
 from label_studio_sdk._extensions.pager_ext import SyncPagerExt, AsyncPagerExt, T
+from label_studio_sdk.types.project import Project
+from label_studio_sdk.label_interface import LabelInterface
+
+from ..core import RequestOptions
+
+
+class ProjectExt(Project):
+
+    def get_label_interface(self):
+        return LabelInterface(self.label_config)
 
 
 class ProjectsClientExt(ProjectsClient):
@@ -10,6 +22,9 @@ class ProjectsClientExt(ProjectsClient):
 
     list.__doc__ = ProjectsClient.list.__doc__
 
+    def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> ProjectExt:
+        return ProjectExt(**dict(super().get(id, request_options=request_options)))
+
 
 class AsyncProjectsClientExt(AsyncProjectsClient):
 

label_studio_sdk/projects/exports/client.py

@@ -105,12 +105,12 @@ class ExportsClient:
             },
             request_options=request_options,
         ) as _response:
-            if 200 <= _response.status_code < 300:
-                for _chunk in _response.iter_bytes():
-                    yield _chunk
-                return
-            _response.read()
             try:
+                if 200 <= _response.status_code < 300:
+                    for _chunk in _response.iter_bytes():
+                        yield _chunk
+                    return
+                _response.read()
                 _response_json = _response.json()
             except JSONDecodeError:
                 raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -149,9 +149,9 @@ class ExportsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/export/formats", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.List[str], _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[str], _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -190,9 +190,9 @@ class ExportsClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/exports/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.List[Export], _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[Export], _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -243,9 +243,9 @@ class ExportsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(ExportCreate, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ExportCreate, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -292,9 +292,9 @@ class ExportsClient:
             method="GET",
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Export, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Export, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -338,9 +338,9 @@ class ExportsClient:
             method="DELETE",
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -404,9 +404,9 @@ class ExportsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(ExportConvert, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ExportConvert, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -463,9 +463,9 @@ class ExportsClient:
             params={"exportType": export_type},
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -561,12 +561,12 @@ class AsyncExportsClient:
             },
             request_options=request_options,
         ) as _response:
-            if 200 <= _response.status_code < 300:
-                async for _chunk in _response.aiter_bytes():
-                    yield _chunk
-                return
-            await _response.aread()
             try:
+                if 200 <= _response.status_code < 300:
+                    async for _chunk in _response.aiter_bytes():
+                        yield _chunk
+                    return
+                await _response.aread()
                 _response_json = _response.json()
             except JSONDecodeError:
                 raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -607,9 +607,9 @@ class AsyncExportsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/export/formats", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.List[str], _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[str], _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -648,9 +648,9 @@ class AsyncExportsClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/exports/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(typing.List[Export], _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(typing.List[Export], _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -701,9 +701,9 @@ class AsyncExportsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(ExportCreate, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ExportCreate, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -750,9 +750,9 @@ class AsyncExportsClient:
             method="GET",
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(Export, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(Export, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -796,9 +796,9 @@ class AsyncExportsClient:
             method="DELETE",
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -862,9 +862,9 @@ class AsyncExportsClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(ExportConvert, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ExportConvert, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -921,9 +921,9 @@ class AsyncExportsClient:
             params={"exportType": export_type},
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

label_studio_sdk/tasks/client.py

@@ -68,9 +68,9 @@ class TasksClient:
             method="GET",
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(ProjectImport, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ProjectImport, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -108,9 +108,9 @@ class TasksClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/tasks/", method="DELETE", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -186,7 +186,12 @@ class TasksClient:
         client = LabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.tasks.list()
+        response = client.tasks.list()
+        for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        for page in response.iter_pages():
+            yield page
         """
         page = page or 1
         _response = self._client_wrapper.httpx_client.request(
@@ -205,24 +210,24 @@ class TasksClient:
             },
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            _parsed_response = pydantic_v1.parse_obj_as(TasksListResponse, _response.json())  # type: ignore
-            _has_next = True
-            _get_next = lambda: self.list(
-                page=page + 1,
-                page_size=page_size,
-                view=view,
-                project=project,
-                resolve_uri=resolve_uri,
-                fields=fields,
-                review=review,
-                include=include,
-                query=query,
-                request_options=request_options,
-            )
-            _items = _parsed_response.tasks
-            return SyncPager(has_next=_has_next, items=_items, get_next=_get_next)
         try:
+            if 200 <= _response.status_code < 300:
+                _parsed_response = pydantic_v1.parse_obj_as(TasksListResponse, _response.json())  # type: ignore
+                _has_next = True
+                _get_next = lambda: self.list(
+                    page=page + 1,
+                    page_size=page_size,
+                    view=view,
+                    project=project,
+                    resolve_uri=resolve_uri,
+                    fields=fields,
+                    review=review,
+                    include=include,
+                    query=query,
+                    request_options=request_options,
+                )
+                _items = _parsed_response.tasks
+                return SyncPager(has_next=_has_next, items=_items, get_next=_get_next)
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -277,9 +282,9 @@ class TasksClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -317,9 +322,9 @@ class TasksClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/tasks/{jsonable_encoder(id)}/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(DataManagerTaskSerializer, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DataManagerTaskSerializer, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -359,9 +364,9 @@ class TasksClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/tasks/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -419,9 +424,9 @@ class TasksClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -476,9 +481,9 @@ class AsyncTasksClient:
             method="GET",
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(ProjectImport, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(ProjectImport, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -516,9 +521,9 @@ class AsyncTasksClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/tasks/", method="DELETE", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -594,7 +599,12 @@ class AsyncTasksClient:
         client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        await client.tasks.list()
+        response = await client.tasks.list()
+        async for item in response:
+            yield item
+        # alternatively, you can paginate page-by-page
+        async for page in response.iter_pages():
+            yield page
         """
         page = page or 1
         _response = await self._client_wrapper.httpx_client.request(
@@ -613,24 +623,24 @@ class AsyncTasksClient:
             },
             request_options=request_options,
         )
-        if 200 <= _response.status_code < 300:
-            _parsed_response = pydantic_v1.parse_obj_as(TasksListResponse, _response.json())  # type: ignore
-            _has_next = True
-            _get_next = lambda: self.list(
-                page=page + 1,
-                page_size=page_size,
-                view=view,
-                project=project,
-                resolve_uri=resolve_uri,
-                fields=fields,
-                review=review,
-                include=include,
-                query=query,
-                request_options=request_options,
-            )
-            _items = _parsed_response.tasks
-            return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next)
         try:
+            if 200 <= _response.status_code < 300:
+                _parsed_response = pydantic_v1.parse_obj_as(TasksListResponse, _response.json())  # type: ignore
+                _has_next = True
+                _get_next = lambda: self.list(
+                    page=page + 1,
+                    page_size=page_size,
+                    view=view,
+                    project=project,
+                    resolve_uri=resolve_uri,
+                    fields=fields,
+                    review=review,
+                    include=include,
+                    query=query,
+                    request_options=request_options,
+                )
+                _items = _parsed_response.tasks
+                return AsyncPager(has_next=_has_next, items=_items, get_next=_get_next)
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -685,9 +695,9 @@ class AsyncTasksClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -727,9 +737,9 @@ class AsyncTasksClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/tasks/{jsonable_encoder(id)}/", method="GET", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(DataManagerTaskSerializer, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(DataManagerTaskSerializer, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -769,9 +779,9 @@ class AsyncTasksClient:
         _response = await self._client_wrapper.httpx_client.request(
             f"api/tasks/{jsonable_encoder(id)}/", method="DELETE", request_options=request_options
         )
-        if 200 <= _response.status_code < 300:
-            return
         try:
+            if 200 <= _response.status_code < 300:
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -829,9 +839,9 @@ class AsyncTasksClient:
             request_options=request_options,
             omit=OMIT,
         )
-        if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
         try:
+            if 200 <= _response.status_code < 300:
+                return pydantic_v1.parse_obj_as(BaseTask, _response.json())  # type: ignore
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)

label_studio_sdk/tasks/client_ext.py

@@ -5,6 +5,8 @@ from label_studio_sdk._extensions.pager_ext import SyncPagerExt, AsyncPagerExt,
 class TasksClientExt(TasksClient):
 
     def list(self, **kwargs) -> SyncPagerExt[T]:
+        # use `fields: all` by default and return the full data
+        kwargs['fields'] = kwargs.get('fields', 'all')
         return SyncPagerExt.from_sync_pager(super().list(**kwargs))
 
     list.__doc__ = TasksClient.list.__doc__
@@ -13,6 +15,8 @@ class TasksClientExt(TasksClient):
 class AsyncTasksClientExt(AsyncTasksClient):
 
     async def list(self, **kwargs):
+        # use `fields: all` by default and return the full data
+        kwargs['fields'] = kwargs.get('fields', 'all')
         return await AsyncPagerExt.from_async_pager(await super().list(**kwargs))
 
     list.__doc__ = AsyncTasksClient.list.__doc__

label_studio_sdk/types/__init__.py

@@ -53,6 +53,9 @@ from .s3export_storage import S3ExportStorage
 from .s3export_storage_status import S3ExportStorageStatus
 from .s3import_storage import S3ImportStorage
 from .s3import_storage_status import S3ImportStorageStatus
+from .s3s_export_storage import S3SExportStorage
+from .s3s_import_storage import S3SImportStorage
+from .s3s_import_storage_status import S3SImportStorageStatus
 from .serialization_option import SerializationOption
 from .serialization_options import SerializationOptions
 from .task import Task
@@ -64,6 +67,7 @@ from .webhook import Webhook
 from .webhook_actions_item import WebhookActionsItem
 from .webhook_serializer_for_update import WebhookSerializerForUpdate
 from .webhook_serializer_for_update_actions_item import WebhookSerializerForUpdateActionsItem
+from .workspace import Workspace
 
 __all__ = [
     "Annotation",
@@ -119,6 +123,9 @@ __all__ = [
     "S3ExportStorageStatus",
     "S3ImportStorage",
     "S3ImportStorageStatus",
+    "S3SExportStorage",
+    "S3SImportStorage",
+    "S3SImportStorageStatus",
     "SerializationOption",
     "SerializationOptions",
     "Task",
@@ -130,4 +137,5 @@ __all__ = [
     "WebhookActionsItem",
     "WebhookSerializerForUpdate",
     "WebhookSerializerForUpdateActionsItem",
+    "Workspace",
 ]

label_studio_sdk/types/s3s_export_storage.py

@@ -0,0 +1,80 @@
+# 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
+
+
+class S3SExportStorage(pydantic_v1.BaseModel):
+    id: typing.Optional[int] = None
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage title
+    """
+
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Cloud storage description
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic_v1.Field(default=None)
+    """
+    Creation time
+    """
+
+    bucket: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket name
+    """
+
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    S3 bucket prefix
+    """
+
+    external_id: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS External ID
+    """
+
+    role_arn: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS Role ARN
+    """
+
+    region_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    AWS Region
+    """
+
+    s3endpoint: typing.Optional[str] = pydantic_v1.Field(alias="s3_endpoint", default=None)
+    """
+    S3 Endpoint
+    """
+
+    project: int = pydantic_v1.Field()
+    """
+    A unique integer value identifying this project.
+    """
+
+    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)
+        )
+
+    class Config:
+        frozen = True
+        smart_union = True
+        allow_population_by_field_name = True
+        populate_by_name = True
+        extra = pydantic_v1.Extra.allow
+        json_encoders = {dt.datetime: serialize_datetime}