supervisely 6.73.432__tar.gz → 6.73.433__tar.gz

{supervisely-6.73.432/supervisely.egg-info → supervisely-6.73.433}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.432
+Version: 6.73.433
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely

{supervisely-6.73.432 → supervisely-6.73.433}/supervisely/api/dataset_api.py

@@ -185,6 +185,7 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
         filters: Optional[List[Dict[str, str]]] = None,
         recursive: Optional[bool] = False,
         parent_id: Optional[int] = None,
+        include_custom_data: Optional[bool] = False,
     ) -> List[DatasetInfo]:
         """
         Returns list of dataset in the given project, or list of nested datasets
@@ -200,6 +201,9 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
         :type recursive: bool, optional
         :param parent_id: Parent Dataset ID. If set to None, the search will be performed at the top level of the Project,
             otherwise the search will be performed in the specified Dataset.
+        :type parent_id: Union[int, None], optional
+        :param include_custom_data: If True, the response will include the `custom_data` field for each Dataset.
+        :type include_custom_data: bool, optional
         :return: List of all Datasets with information for the given Project. See :class:`info_sequence<info_sequence>`
         :rtype: :class:`List[DatasetInfo]`
         :Usage example:
@@ -246,14 +250,16 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
             filters.append({"field": ApiField.PARENT_ID, "operator": "=", "value": parent_id})
             recursive = True
 
-        return self.get_list_all_pages(
-            "datasets.list",
-            {
-                ApiField.PROJECT_ID: project_id,
-                ApiField.FILTER: filters,
-                ApiField.RECURSIVE: recursive,
-            },
-        )
+        method = "datasets.list"
+        data = {
+            ApiField.PROJECT_ID: project_id,
+            ApiField.FILTER: filters,
+            ApiField.RECURSIVE: recursive,
+        }
+        if include_custom_data:
+            data[ApiField.EXTRA_FIELDS] = [ApiField.CUSTOM_DATA]
+
+        return self.get_list_all_pages(method, data)
 
     def get_info_by_id(self, id: int, raise_error: Optional[bool] = False) -> DatasetInfo:
         """
@@ -304,6 +310,7 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
         description: Optional[str] = "",
         change_name_if_conflict: Optional[bool] = False,
         parent_id: Optional[int] = None,
+        custom_data: Optional[Dict[Any, Any]] = None,
     ) -> DatasetInfo:
         """
         Create Dataset with given name in the given Project.
@@ -318,6 +325,9 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
         :type change_name_if_conflict: bool, optional
         :param parent_id: Parent Dataset ID. If set to None, then the Dataset will be created at
             the top level of the Project, otherwise the Dataset will be created in a specified Dataset.
+        :type parent_id: Union[int, None]
+        :param custom_data: Custom data to store in the Dataset.
+        :type custom_data: Dict[Any, Any], optional
         :return: Information about Dataset. See :class:`info_sequence<info_sequence>`
         :rtype: :class:`DatasetInfo`
         :Usage example:
@@ -345,15 +355,16 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
             change_name_if_conflict=change_name_if_conflict,
             parent_id=parent_id,
         )
-        response = self._api.post(
-            "datasets.add",
-            {
-                ApiField.PROJECT_ID: project_id,
-                ApiField.NAME: effective_name,
-                ApiField.DESCRIPTION: description,
-                ApiField.PARENT_ID: parent_id,
-            },
-        )
+        method = "datasets.add"
+        payload = {
+            ApiField.PROJECT_ID: project_id,
+            ApiField.NAME: effective_name,
+            ApiField.DESCRIPTION: description,
+            ApiField.PARENT_ID: parent_id,
+        }
+        if custom_data is not None:
+            payload[ApiField.CUSTOM_DATA] = custom_data
+        response = self._api.post(method, payload)
         return self._convert_json_info(response.json())
 
     def get_or_create(
@@ -564,6 +575,7 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
                 new_dataset_name,
                 dataset.description,
                 change_name_if_conflict=change_name_if_conflict,
+                custom_data=dataset.custom_data,
             )
             items_api.copy_batch(
                 new_dataset.id, src_item_ids, change_name_if_conflict, with_annotations
@@ -797,6 +809,7 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
         sort_order: Optional[str] = None,
         per_page: Optional[int] = None,
         page: Union[int, Literal["all"]] = "all",
+        include_custom_data: Optional[bool] = False,
     ) -> dict:
         """
         List all available datasets from all available teams for the user that match the specified filtering criteria.
@@ -807,22 +820,20 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
                         - 'operator': Takes values '=', 'eq', '!=', 'not', 'in', '!in', '>', 'gt', '>=', 'gte', '<', 'lt', '<=', 'lte'
                         - 'value': Takes on values according to the meaning of 'field' or null
         :type filters: List[Dict[str, str]], optional
-
         :param sort: Specifies by which parameter to sort the project list.
                         Takes values 'id', 'name', 'size', 'createdAt', 'updatedAt'
         :type sort: str, optional
-
         :param sort_order: Determines which value to list from.
         :type sort_order: str, optional
-
         :param per_page: Number of first items found to be returned.
                         'None' will return the first page with a default size of 20000 datasets.
         :type per_page: int, optional
-
         :param page: Page number, used to retrieve the following items if the number of them found is more than per_page.
                      The default value is 'all', which retrieves all available datasets.
                      'None' will return the first page with datasets, the amount of which is set in param 'per_page'.
         :type page: Union[int, Literal["all"]], optional
+        :param include_custom_data: If True, the response will include the `custom_data` field for each Dataset.
+        :type include_custom_data: bool, optional
 
         :return: Search response information and 'DatasetInfo' of all datasets that are searched by a given criterion.
         :rtype: dict
@@ -899,6 +910,8 @@ class DatasetApi(UpdateableModule, RemoveableModuleApi):
             request_body[ApiField.PER_PAGE] = per_page
         if page is not None and page != "all":
             request_body[ApiField.PAGE] = page
+        if include_custom_data:
+            request_body[ApiField.EXTRA_FIELDS] = [ApiField.CUSTOM_DATA]
 
         first_response = self._api.post(method, request_body).json()
 

{supervisely-6.73.432 → supervisely-6.73.433}/supervisely/api/project_api.py

@@ -12,10 +12,12 @@ from typing import (
     Any,
     Callable,
     Dict,
+    Generator,
     List,
     Literal,
     NamedTuple,
     Optional,
+    Tuple,
     Union,
 )
 
@@ -38,6 +40,7 @@ from supervisely.annotation.annotation import TagCollection
 from supervisely.annotation.obj_class import ObjClass
 from supervisely.annotation.obj_class_collection import ObjClassCollection
 from supervisely.annotation.tag_meta import TagMeta, TagValueType
+from supervisely.api.dataset_api import DatasetInfo
 from supervisely.api.module_api import (
     ApiField,
     CloneableModuleApi,
@@ -2556,3 +2559,104 @@ class ProjectApi(CloneableModuleApi, UpdateableModule, RemoveableModuleApi):
             api.project.calculate_embeddings(project_id)
         """
         self._api.post("embeddings.calculate-project-embeddings", {ApiField.PROJECT_ID: id})
+
+    def recreate_structure_generator(
+        self,
+        src_project_id: int,
+        dst_project_id: Optional[int] = None,
+        dst_project_name: Optional[str] = None,
+    ) -> Generator[Tuple[DatasetInfo, DatasetInfo], None, None]:
+        """This method can be used to recreate a project with hierarchial datasets (without the data itself) and
+        yields the tuple of source and destination DatasetInfo objects.
+
+        :param src_project_id: Source project ID
+        :type src_project_id: int
+        :param dst_project_id: Destination project ID
+        :type dst_project_id: int, optional
+        :param dst_project_name: Name of the destination project. If `dst_project_id` is None, a new project will be created with this name. If `dst_project_id` is provided, this parameter will be ignored.
+        :type dst_project_name: str, optional
+
+        :return: Generator of tuples of source and destination DatasetInfo objects
+        :rtype: Generator[Tuple[DatasetInfo, DatasetInfo], None, None]
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            src_project_id = 123
+            dst_project_id = api.project.create("new_project", "images").id
+
+            for src_ds, dst_ds in api.project.recreate_structure_generator(src_project_id, dst_project_id):
+                print(f"Recreated dataset {src_ds.id} -> {dst_ds.id}")
+                # Implement your logic here to process the datasets.
+        """
+        if dst_project_id is None:
+            src_project_info = self._api.project.get_info_by_id(src_project_id)
+            dst_project_info = self._api.project.create(
+                src_project_info.workspace_id,
+                dst_project_name or f"Recreation of {src_project_info.name}",
+                src_project_info.type,
+                src_project_info.description,
+                change_name_if_conflict=True,
+            )
+            dst_project_id = dst_project_info.id
+
+        datasets = self._api.dataset.get_list(src_project_id, recursive=True, include_custom_data=True)
+        src_to_dst_ids = {}
+
+        for src_dataset_info in datasets:
+            dst_dataset_info = self._api.dataset.create(
+                dst_project_id,
+                src_dataset_info.name,
+                description=src_dataset_info.description,
+                parent_id=src_to_dst_ids.get(src_dataset_info.parent_id),
+                custom_data=src_dataset_info.custom_data,
+            )
+            src_to_dst_ids[src_dataset_info.id] = dst_dataset_info.id
+
+            yield src_dataset_info, dst_dataset_info
+
+    def recreate_structure(
+        self,
+        src_project_id: int,
+        dst_project_id: Optional[int] = None,
+        dst_project_name: Optional[str] = None,
+    ) -> Tuple[List[DatasetInfo], List[DatasetInfo]]:
+        """This method can be used to recreate a project with hierarchial datasets (without the data itself).
+
+        :param src_project_id: Source project ID
+        :type src_project_id: int
+        :param dst_project_id: Destination project ID
+        :type dst_project_id: int, optional
+        :param dst_project_name: Name of the destination project. If `dst_project_id` is None, a new project will be created with this name. If `dst_project_id` is provided, this parameter will be ignored.
+        :type dst_project_name: str, optional
+
+        :return: Destination project ID
+        :rtype: int
+
+        :Usage example:
+
+        .. code-block:: python
+
+            import supervisely as sly
+
+            api = sly.Api.from_env()
+
+            src_project_id = 123
+            dst_project_name = "New Project"
+
+            dst_project_id = api.project.recreate_structure(src_project_id, dst_project_name=dst_project_name)
+            print(f"Recreated project {src_project_id} -> {dst_project_id}")
+        """
+        infos = []
+        for src_info, dst_info in self.recreate_structure_generator(
+            src_project_id, dst_project_id, dst_project_name
+        ):
+            infos.append((src_info, dst_info))
+
+
+        return infos

{supervisely-6.73.432 → supervisely-6.73.433}/supervisely/versions.json

@@ -23,5 +23,6 @@
 	"6.13.8": "6.73.394",
 	"6.14.0": "6.73.400",
 	"6.14.4": "6.73.410",
-	"6.15.0": "6.73.431"
+	"6.15.0": "6.73.431",
+	"6.15.2": "6.73.433"
 }

{supervisely-6.73.432 → supervisely-6.73.433/supervisely.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: supervisely
-Version: 6.73.432
+Version: 6.73.433
 Summary: Supervisely Python SDK.
 Home-page: https://github.com/supervisely/supervisely
 Author: Supervisely