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

label_studio_sdk/files/client.py

@@ -1,14 +1,14 @@
 # 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.file_upload import FileUpload
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -37,7 +37,7 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -47,11 +47,19 @@ class FilesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/import/file-upload/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(FileUpload, _response.json())  # type: ignore
+                return typing.cast(
+                    FileUpload,
+                    parse_obj_as(
+                        type_=FileUpload,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -75,7 +83,7 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -85,7 +93,9 @@ class FilesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/import/file-upload/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -104,10 +114,10 @@ class FilesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FileUpload:
         """
+
         Update a specific uploaded file. To get the file upload ID, use [Get files list](list).
 
         You will need to include the file data in the request body. For example:
-
         ```bash
         curl -H 'Authorization: Token abc123' \ -X POST 'https://localhost:8080/api/import/file-upload/245' -F ‘file=@path/to/my_file.csv’
         ```
@@ -131,7 +141,7 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -143,13 +153,22 @@ class FilesClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/import/file-upload/{jsonable_encoder(id_)}",
             method="PATCH",
-            json={"id": id, "file": file},
+            json={
+                "id": id,
+                "file": file,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(FileUpload, _response.json())  # type: ignore
+                return typing.cast(
+                    FileUpload,
+                    parse_obj_as(
+                        type_=FileUpload,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -164,6 +183,7 @@ class FilesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[FileUpload]:
         """
+
         Retrieve the list of uploaded files used to create labeling tasks for a specific project. These are files that have been uploaded directly to Label Studio.
 
         You must provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -189,7 +209,7 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -201,12 +221,21 @@ class FilesClient:
         _response = self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/file-uploads",
             method="GET",
-            params={"all": all_, "ids": ids},
+            params={
+                "all": all_,
+                "ids": ids,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[FileUpload], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[FileUpload],
+                    parse_obj_as(
+                        type_=typing.List[FileUpload],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -214,6 +243,7 @@ class FilesClient:
 
     def delete_many(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete uploaded files for a specific project. These are files that have been uploaded directly to Label Studio.
 
         You must provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -232,7 +262,7 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -242,7 +272,9 @@ class FilesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/file-uploads", method="DELETE", request_options=request_options
+            f"api/projects/{jsonable_encoder(id)}/file-uploads",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -269,7 +301,7 @@ class FilesClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -279,7 +311,9 @@ class FilesClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"data/upload/{jsonable_encoder(filename)}", method="GET", request_options=request_options
+            f"data/upload/{jsonable_encoder(filename)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -313,21 +347,37 @@ class AsyncFilesClient:
 
         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.files.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.files.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/import/file-upload/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(FileUpload, _response.json())  # type: ignore
+                return typing.cast(
+                    FileUpload,
+                    parse_obj_as(
+                        type_=FileUpload,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -351,17 +401,27 @@ class AsyncFilesClient:
 
         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.files.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.files.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/import/file-upload/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/import/file-upload/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -380,10 +440,10 @@ class AsyncFilesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> FileUpload:
         """
+
         Update a specific uploaded file. To get the file upload ID, use [Get files list](list).
 
         You will need to include the file data in the request body. For example:
-
         ```bash
         curl -H 'Authorization: Token abc123' \ -X POST 'https://localhost:8080/api/import/file-upload/245' -F ‘file=@path/to/my_file.csv’
         ```
@@ -407,25 +467,42 @@ class AsyncFilesClient:
 
         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.files.update(
-            id_=1,
-        )
+
+
+        async def main() -> None:
+            await client.files.update(
+                id_=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/import/file-upload/{jsonable_encoder(id_)}",
             method="PATCH",
-            json={"id": id, "file": file},
+            json={
+                "id": id,
+                "file": file,
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(FileUpload, _response.json())  # type: ignore
+                return typing.cast(
+                    FileUpload,
+                    parse_obj_as(
+                        type_=FileUpload,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -440,6 +517,7 @@ class AsyncFilesClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> typing.List[FileUpload]:
         """
+
         Retrieve the list of uploaded files used to create labeling tasks for a specific project. These are files that have been uploaded directly to Label Studio.
 
         You must provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -465,24 +543,41 @@ class AsyncFilesClient:
 
         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.files.list(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.files.list(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/projects/{jsonable_encoder(id)}/file-uploads",
             method="GET",
-            params={"all": all_, "ids": ids},
+            params={
+                "all": all_,
+                "ids": ids,
+            },
             request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[FileUpload], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[FileUpload],
+                    parse_obj_as(
+                        type_=typing.List[FileUpload],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -490,6 +585,7 @@ class AsyncFilesClient:
 
     async def delete_many(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete uploaded files for a specific project. These are files that have been uploaded directly to Label Studio.
 
         You must provide a project ID. The project ID can be found in the URL when viewing the project in Label Studio, or you can retrieve all project IDs using [List all projects](../list).
@@ -508,17 +604,27 @@ class AsyncFilesClient:
 
         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.files.delete_many(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.files.delete_many(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/projects/{jsonable_encoder(id)}/file-uploads", method="DELETE", request_options=request_options
+            f"api/projects/{jsonable_encoder(id)}/file-uploads",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -545,17 +651,27 @@ class AsyncFilesClient:
 
         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.files.download(
-            filename="filename",
-        )
+
+
+        async def main() -> None:
+            await client.files.download(
+                filename="filename",
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"data/upload/{jsonable_encoder(filename)}", method="GET", request_options=request_options
+            f"data/upload/{jsonable_encoder(filename)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300: