label-studio-sdk 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

label_studio_sdk/export_storage/local/client.py

@@ -79,11 +79,11 @@ class LocalClient:
     def create(
         self,
         *,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
+        title: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalFilesExportStorage:
@@ -92,21 +92,21 @@ class LocalClient:
 
         Parameters
         ----------
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
-
         path : typing.Optional[str]
             Path to local directory
 
+        project : typing.Optional[int]
+            Project ID
+
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
+        title : typing.Optional[str]
+            Storage title
+
         use_blob_urls : typing.Optional[bool]
             Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
 
@@ -131,11 +131,11 @@ class LocalClient:
             "api/storages/export/localfiles",
             method="POST",
             json={
-                "title": title,
                 "description": description,
-                "project": project,
                 "path": path,
+                "project": project,
                 "regex_filter": regex_filter,
+                "title": title,
                 "use_blob_urls": use_blob_urls,
             },
             headers={
@@ -158,6 +158,86 @@ class LocalClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
+    def validate(
+        self,
+        *,
+        description: typing.Optional[str] = OMIT,
+        id: typing.Optional[int] = OMIT,
+        path: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
+        """
+        Validate a specific local file export storage connection.
+
+        Parameters
+        ----------
+        description : typing.Optional[str]
+            Storage description
+
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        path : typing.Optional[str]
+            Path to local directory
+
+        project : typing.Optional[int]
+            Project ID
+
+        regex_filter : typing.Optional[str]
+            Regex for filtering objects
+
+        title : typing.Optional[str]
+            Storage title
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        None
+
+        Examples
+        --------
+        from label_studio_sdk import LabelStudio
+
+        client = LabelStudio(
+            api_key="YOUR_API_KEY",
+        )
+        client.export_storage.local.validate()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/storages/export/localfiles/validate",
+            method="POST",
+            json={
+                "description": description,
+                "id": id,
+                "path": path,
+                "project": project,
+                "regex_filter": regex_filter,
+                "title": title,
+                "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
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
     def get(self, id: int, *, request_options: typing.Optional[RequestOptions] = None) -> LocalFilesExportStorage:
         """
         Get a specific local file export storage connection.
@@ -247,11 +327,11 @@ class LocalClient:
         self,
         id: int,
         *,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
+        title: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalFilesExportStorage:
@@ -262,21 +342,21 @@ class LocalClient:
         ----------
         id : int
 
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
-
         path : typing.Optional[str]
             Path to local directory
 
+        project : typing.Optional[int]
+            Project ID
+
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
+        title : typing.Optional[str]
+            Storage title
+
         use_blob_urls : typing.Optional[bool]
             Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
 
@@ -303,11 +383,11 @@ class LocalClient:
             f"api/storages/export/localfiles/{jsonable_encoder(id)}",
             method="PATCH",
             json={
-                "title": title,
                 "description": description,
-                "project": project,
                 "path": path,
+                "project": project,
                 "regex_filter": regex_filter,
+                "title": title,
                 "use_blob_urls": use_blob_urls,
             },
             headers={
@@ -376,115 +456,117 @@ class LocalClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def validate(
+
+class AsyncLocalClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def list(
         self,
         *,
-        id: typing.Optional[int] = OMIT,
-        title: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        path: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
+        ordering: typing.Optional[str] = None,
+        project: typing.Optional[int] = None,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
+    ) -> typing.List[LocalFilesExportStorage]:
         """
-        Validate a specific local file export storage connection.
+        Get a list of all local file export storage connections.
 
         Parameters
         ----------
-        id : typing.Optional[int]
-            Storage ID. If set, storage with specified ID will be updated
-
-        title : typing.Optional[str]
-            Storage title
-
-        description : typing.Optional[str]
-            Storage description
+        ordering : typing.Optional[str]
+            Which field to use when ordering the results.
 
         project : typing.Optional[int]
             Project ID
 
-        path : typing.Optional[str]
-            Path to local directory
-
-        regex_filter : typing.Optional[str]
-            Regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        None
+        typing.List[LocalFilesExportStorage]
+
 
         Examples
         --------
-        from label_studio_sdk import LabelStudio
+        import asyncio
 
-        client = LabelStudio(
+        from label_studio_sdk import AsyncLabelStudio
+
+        client = AsyncLabelStudio(
             api_key="YOUR_API_KEY",
         )
-        client.export_storage.local.validate()
+
+
+        async def main() -> None:
+            await client.export_storage.local.list()
+
+
+        asyncio.run(main())
         """
-        _response = self._client_wrapper.httpx_client.request(
-            "api/storages/export/localfiles/validate",
-            method="POST",
-            json={
-                "id": id,
-                "title": title,
-                "description": description,
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/storages/export/localfiles",
+            method="GET",
+            params={
+                "ordering": ordering,
                 "project": project,
-                "path": path,
-                "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
+                return typing.cast(
+                    typing.List[LocalFilesExportStorage],
+                    construct_type(
+                        type_=typing.List[LocalFilesExportStorage],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-
-class AsyncLocalClient:
-    def __init__(self, *, client_wrapper: AsyncClientWrapper):
-        self._client_wrapper = client_wrapper
-
-    async def list(
+    async def create(
         self,
         *,
-        ordering: typing.Optional[str] = None,
-        project: typing.Optional[int] = None,
+        description: typing.Optional[str] = OMIT,
+        path: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> typing.List[LocalFilesExportStorage]:
+    ) -> LocalFilesExportStorage:
         """
-        Get a list of all local file export storage connections.
+        Create a new local file export storage connection to store annotations.
 
         Parameters
         ----------
-        ordering : typing.Optional[str]
-            Which field to use when ordering the results.
+        description : typing.Optional[str]
+            Storage description
+
+        path : typing.Optional[str]
+            Path to local directory
 
         project : typing.Optional[int]
             Project ID
 
+        regex_filter : typing.Optional[str]
+            Regex for filtering objects
+
+        title : typing.Optional[str]
+            Storage title
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        typing.List[LocalFilesExportStorage]
+        LocalFilesExportStorage
 
 
         Examples
@@ -499,26 +581,34 @@ class AsyncLocalClient:
 
 
         async def main() -> None:
-            await client.export_storage.local.list()
+            await client.export_storage.local.create()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
             "api/storages/export/localfiles",
-            method="GET",
-            params={
-                "ordering": ordering,
+            method="POST",
+            json={
+                "description": description,
+                "path": path,
                 "project": project,
+                "regex_filter": regex_filter,
+                "title": title,
+                "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 typing.cast(
-                    typing.List[LocalFilesExportStorage],
+                    LocalFilesExportStorage,
                     construct_type(
-                        type_=typing.List[LocalFilesExportStorage],  # type: ignore
+                        type_=LocalFilesExportStorage,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -527,37 +617,41 @@ class AsyncLocalClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def create(
+    async def validate(
         self,
         *,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
+        id: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
+        title: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
-    ) -> LocalFilesExportStorage:
+    ) -> None:
         """
-        Create a new local file export storage connection to store annotations.
+        Validate a specific local file export storage connection.
 
         Parameters
         ----------
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
 
         path : typing.Optional[str]
             Path to local directory
 
+        project : typing.Optional[int]
+            Project ID
+
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
+        title : typing.Optional[str]
+            Storage title
+
         use_blob_urls : typing.Optional[bool]
             Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
 
@@ -566,8 +660,7 @@ class AsyncLocalClient:
 
         Returns
         -------
-        LocalFilesExportStorage
-
+        None
 
         Examples
         --------
@@ -581,20 +674,21 @@ class AsyncLocalClient:
 
 
         async def main() -> None:
-            await client.export_storage.local.create()
+            await client.export_storage.local.validate()
 
 
         asyncio.run(main())
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/localfiles",
+            "api/storages/export/localfiles/validate",
             method="POST",
             json={
-                "title": title,
                 "description": description,
-                "project": project,
+                "id": id,
                 "path": path,
+                "project": project,
                 "regex_filter": regex_filter,
+                "title": title,
                 "use_blob_urls": use_blob_urls,
             },
             headers={
@@ -605,13 +699,7 @@ class AsyncLocalClient:
         )
         try:
             if 200 <= _response.status_code < 300:
-                return typing.cast(
-                    LocalFilesExportStorage,
-                    construct_type(
-                        type_=LocalFilesExportStorage,  # type: ignore
-                        object_=_response.json(),
-                    ),
-                )
+                return
             _response_json = _response.json()
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
@@ -722,11 +810,11 @@ class AsyncLocalClient:
         self,
         id: int,
         *,
-        title: typing.Optional[str] = OMIT,
         description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
         path: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
         regex_filter: typing.Optional[str] = OMIT,
+        title: typing.Optional[str] = OMIT,
         use_blob_urls: typing.Optional[bool] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> LocalFilesExportStorage:
@@ -737,21 +825,21 @@ class AsyncLocalClient:
         ----------
         id : int
 
-        title : typing.Optional[str]
-            Storage title
-
         description : typing.Optional[str]
             Storage description
 
-        project : typing.Optional[int]
-            Project ID
-
         path : typing.Optional[str]
             Path to local directory
 
+        project : typing.Optional[int]
+            Project ID
+
         regex_filter : typing.Optional[str]
             Regex for filtering objects
 
+        title : typing.Optional[str]
+            Storage title
+
         use_blob_urls : typing.Optional[bool]
             Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
 
@@ -786,11 +874,11 @@ class AsyncLocalClient:
             f"api/storages/export/localfiles/{jsonable_encoder(id)}",
             method="PATCH",
             json={
-                "title": title,
                 "description": description,
-                "project": project,
                 "path": path,
+                "project": project,
                 "regex_filter": regex_filter,
+                "title": title,
                 "use_blob_urls": use_blob_urls,
             },
             headers={
@@ -868,91 +956,3 @@ class AsyncLocalClient:
         except JSONDecodeError:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
-
-    async def validate(
-        self,
-        *,
-        id: typing.Optional[int] = OMIT,
-        title: typing.Optional[str] = OMIT,
-        description: typing.Optional[str] = OMIT,
-        project: typing.Optional[int] = OMIT,
-        path: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
-        request_options: typing.Optional[RequestOptions] = None,
-    ) -> None:
-        """
-        Validate a specific local file export storage connection.
-
-        Parameters
-        ----------
-        id : typing.Optional[int]
-            Storage ID. If set, storage with specified ID will be updated
-
-        title : typing.Optional[str]
-            Storage title
-
-        description : typing.Optional[str]
-            Storage description
-
-        project : typing.Optional[int]
-            Project ID
-
-        path : typing.Optional[str]
-            Path to local directory
-
-        regex_filter : typing.Optional[str]
-            Regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs. For example, if your directory contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
-
-        request_options : typing.Optional[RequestOptions]
-            Request-specific configuration.
-
-        Returns
-        -------
-        None
-
-        Examples
-        --------
-        import asyncio
-
-        from label_studio_sdk import AsyncLabelStudio
-
-        client = AsyncLabelStudio(
-            api_key="YOUR_API_KEY",
-        )
-
-
-        async def main() -> None:
-            await client.export_storage.local.validate()
-
-
-        asyncio.run(main())
-        """
-        _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/export/localfiles/validate",
-            method="POST",
-            json={
-                "id": id,
-                "title": title,
-                "description": description,
-                "project": project,
-                "path": path,
-                "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
-            _response_json = _response.json()
-        except JSONDecodeError:
-            raise ApiError(status_code=_response.status_code, body=_response.text)
-        raise ApiError(status_code=_response.status_code, body=_response_json)