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

label_studio_sdk/import_storage/local/client.py

@@ -1,16 +1,16 @@
 # 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.local_files_import_storage import LocalFilesImportStorage
+from ...core.pydantic_utilities import parse_obj_as
+from json.decoder import JSONDecodeError
+from ...core.api_error import ApiError
 from .types.local_create_response import LocalCreateResponse
+from ...core.jsonable_encoder import jsonable_encoder
 from .types.local_update_response import LocalUpdateResponse
+from ...core.client_wrapper import AsyncClientWrapper
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -24,6 +24,7 @@ class LocalClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[LocalFilesImportStorage]:
         """
+
         If you have local files that you want to add to Label Studio from a specific directory, you can set up a specific local directory on the machine where LS is running as source or target storage. Use this API request to get a list of all local file import (source) storage connections for a specific project.
 
         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](../projects/list).
@@ -45,7 +46,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -53,11 +54,22 @@ class LocalClient:
         client.import_storage.local.list()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/localfiles/", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/localfiles/",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[LocalFilesImportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[LocalFilesImportStorage],
+                    parse_obj_as(
+                        type_=typing.List[LocalFilesImportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -75,6 +87,7 @@ class LocalClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalCreateResponse:
         """
+
         Create a new source storage connection to a local file directory.
 
         For information about the required fields and prerequisites, see [Local storage](https://labelstud.io/guide/storage#Local-storage) in the Label Studio documentation.
@@ -111,7 +124,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -129,12 +142,21 @@ class LocalClient:
                 "regex_filter": regex_filter,
                 "use_blob_urls": use_blob_urls,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalCreateResponse,
+                    parse_obj_as(
+                        type_=LocalCreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -153,6 +175,7 @@ class LocalClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific local file import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
@@ -187,7 +210,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -206,6 +229,9 @@ class LocalClient:
                 "regex_filter": regex_filter,
                 "use_blob_urls": use_blob_urls,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -219,6 +245,7 @@ class LocalClient:
 
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesImportStorage:
         """
+
         Get a specific local file import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -238,7 +265,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -248,11 +275,19 @@ class LocalClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/localfiles/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/localfiles/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalFilesImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalFilesImportStorage,
+                    parse_obj_as(
+                        type_=LocalFilesImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -260,6 +295,7 @@ class LocalClient:
 
     def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Deleting a source storage connection does not affect tasks with synced data in Label Studio. The sync process is designed to import new or updated tasks from the connected storage into the project, but it does not track deletions of files from the storage. Therefore, if you remove the external storage connection, the tasks that were created from that storage will remain in the project.
@@ -280,7 +316,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -290,7 +326,9 @@ class LocalClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/localfiles/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/localfiles/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -313,6 +351,7 @@ class LocalClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalUpdateResponse:
         """
+
         Update a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -350,7 +389,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -370,12 +409,21 @@ class LocalClient:
                 "regex_filter": regex_filter,
                 "use_blob_urls": use_blob_urls,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalUpdateResponse,
+                    parse_obj_as(
+                        type_=LocalUpdateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -383,6 +431,7 @@ class LocalClient:
 
     def sync(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesImportStorage:
         """
+
         Sync tasks from a local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Sync operations with external sources only go one way. They either create tasks from objects in the source directory (source/import storage) or push annotations to the output directory (export/target storage). Changing something on the local file side doesn’t guarantee consistency in results.
@@ -404,7 +453,7 @@ class LocalClient:
 
         Examples
         --------
-        from label_studio_sdk.client import LabelStudio
+        from label_studio_sdk import LabelStudio
 
         client = LabelStudio(
             api_key="YOUR_API_KEY",
@@ -414,11 +463,19 @@ class LocalClient:
         )
         """
         _response = self._client_wrapper.httpx_client.request(
-            f"api/storages/localfiles/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/localfiles/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalFilesImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalFilesImportStorage,
+                    parse_obj_as(
+                        type_=LocalFilesImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -433,6 +490,7 @@ class AsyncLocalClient:
         self, *, project: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None
     ) -> typing.List[LocalFilesImportStorage]:
         """
+
         If you have local files that you want to add to Label Studio from a specific directory, you can set up a specific local directory on the machine where LS is running as source or target storage. Use this API request to get a list of all local file import (source) storage connections for a specific project.
 
         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](../projects/list).
@@ -454,19 +512,38 @@ class AsyncLocalClient:
 
         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.import_storage.local.list()
+
+
+        async def main() -> None:
+            await client.import_storage.local.list()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/localfiles/", method="GET", params={"project": project}, request_options=request_options
+            "api/storages/localfiles/",
+            method="GET",
+            params={
+                "project": project,
+            },
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(typing.List[LocalFilesImportStorage], _response.json())  # type: ignore
+                return typing.cast(
+                    typing.List[LocalFilesImportStorage],
+                    parse_obj_as(
+                        type_=typing.List[LocalFilesImportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -484,6 +561,7 @@ class AsyncLocalClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalCreateResponse:
         """
+
         Create a new source storage connection to a local file directory.
 
         For information about the required fields and prerequisites, see [Local storage](https://labelstud.io/guide/storage#Local-storage) in the Label Studio documentation.
@@ -520,12 +598,20 @@ class AsyncLocalClient:
 
         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.import_storage.local.create()
+
+
+        async def main() -> None:
+            await client.import_storage.local.create()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/localfiles/",
@@ -538,12 +624,21 @@ class AsyncLocalClient:
                 "regex_filter": regex_filter,
                 "use_blob_urls": use_blob_urls,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalCreateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalCreateResponse,
+                    parse_obj_as(
+                        type_=LocalCreateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -562,6 +657,7 @@ class AsyncLocalClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> None:
         """
+
         Validate a specific local file import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
@@ -596,12 +692,20 @@ class AsyncLocalClient:
 
         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.import_storage.local.validate()
+
+
+        async def main() -> None:
+            await client.import_storage.local.validate()
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/localfiles/validate",
@@ -615,6 +719,9 @@ class AsyncLocalClient:
                 "regex_filter": regex_filter,
                 "use_blob_urls": use_blob_urls,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
@@ -628,6 +735,7 @@ class AsyncLocalClient:
 
     async def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesImportStorage:
         """
+
         Get a specific local file import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -647,21 +755,37 @@ class AsyncLocalClient:
 
         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.import_storage.local.get(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.local.get(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/localfiles/{jsonable_encoder(id)}", method="GET", request_options=request_options
+            f"api/storages/localfiles/{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalFilesImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalFilesImportStorage,
+                    parse_obj_as(
+                        type_=LocalFilesImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -669,6 +793,7 @@ class AsyncLocalClient:
 
     async def delete(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> None:
         """
+
         Delete a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Deleting a source storage connection does not affect tasks with synced data in Label Studio. The sync process is designed to import new or updated tasks from the connected storage into the project, but it does not track deletions of files from the storage. Therefore, if you remove the external storage connection, the tasks that were created from that storage will remain in the project.
@@ -689,17 +814,27 @@ class AsyncLocalClient:
 
         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.import_storage.local.delete(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.local.delete(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/localfiles/{jsonable_encoder(id)}", method="DELETE", request_options=request_options
+            f"api/storages/localfiles/{jsonable_encoder(id)}",
+            method="DELETE",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
@@ -722,6 +857,7 @@ class AsyncLocalClient:
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalUpdateResponse:
         """
+
         Update a specific local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         For more information about working with external storage, see [Sync data from external storage](https://labelstud.io/guide/storage).
@@ -759,14 +895,22 @@ class AsyncLocalClient:
 
         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.import_storage.local.update(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.local.update(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             f"api/storages/localfiles/{jsonable_encoder(id)}",
@@ -779,12 +923,21 @@ class AsyncLocalClient:
                 "regex_filter": regex_filter,
                 "use_blob_urls": use_blob_urls,
             },
+            headers={
+                "content-type": "application/json",
+            },
             request_options=request_options,
             omit=OMIT,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalUpdateResponse, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalUpdateResponse,
+                    parse_obj_as(
+                        type_=LocalUpdateResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -794,6 +947,7 @@ class AsyncLocalClient:
         self, id: int, *, request_options: typing.Optional[RequestOptions] = None
     ) -> LocalFilesImportStorage:
         """
+
         Sync tasks from a local import storage connection. You will need to provide the import storage ID. You can find this using [List import storages](list).
 
         Sync operations with external sources only go one way. They either create tasks from objects in the source directory (source/import storage) or push annotations to the output directory (export/target storage). Changing something on the local file side doesn’t guarantee consistency in results.
@@ -815,21 +969,37 @@ class AsyncLocalClient:
 
         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.import_storage.local.sync(
-            id=1,
-        )
+
+
+        async def main() -> None:
+            await client.import_storage.local.sync(
+                id=1,
+            )
+
+
+        asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            f"api/storages/localfiles/{jsonable_encoder(id)}/sync", method="POST", request_options=request_options
+            f"api/storages/localfiles/{jsonable_encoder(id)}/sync",
+            method="POST",
+            request_options=request_options,
         )
         try:
             if 200 <= _response.status_code < 300:
-                return pydantic_v1.parse_obj_as(LocalFilesImportStorage, _response.json())  # type: ignore
+                return typing.cast(
+                    LocalFilesImportStorage,
+                    parse_obj_as(
+                        type_=LocalFilesImportStorage,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)