feat: Add folder parameter to project creation (#1325)

Author: dawoodhq

flow360/component/geometry.py

@@ -7,7 +7,7 @@
 import os
 import threading
 from enum import Enum
-from typing import Any, List, Literal, Union
+from typing import Any, List, Literal, Optional, Union
 
 import pydantic as pd
 
@@ -25,6 +25,7 @@
     ResourceDraft,
 )
 from flow360.component.simulation.entity_info import GeometryEntityInfo
+from flow360.component.simulation.folder import Folder
 from flow360.component.simulation.primitives import Edge, GeometryBodyGroup, Surface
 from flow360.component.simulation.unit_system import LengthType
 from flow360.component.simulation.utils import model_attribute_unlock
@@ -91,12 +92,14 @@ def __init__(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ):
         self._file_names = file_names
         self.project_name = project_name
         self.tags = tags if tags is not None else []
         self.length_unit = length_unit
         self.solver_version = solver_version
+        self.folder = folder
         self._validate()
         ResourceDraft.__init__(self)
 
@@ -186,9 +189,7 @@ def submit(self, description="", progress_callback=None, run_async=False) -> Geo
                 )
                 for file_path in self.file_names + mapbc_files
             ],
-            # pylint: disable=fixme
-            # TODO: remove hardcoding
-            parent_folder_id="ROOT.FLOW360",
+            parent_folder_id=self.folder.id if self.folder else "ROOT.FLOW360",
             length_unit=self.length_unit,
             description=description,
         )
@@ -296,9 +297,12 @@ def from_file(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ) -> GeometryDraft:
         # For type hint only but proper fix is to fully abstract the Draft class too.
-        return super().from_file(file_names, project_name, solver_version, length_unit, tags)
+        return super().from_file(
+            file_names, project_name, solver_version, length_unit, tags, folder=folder
+        )
 
     def show_available_groupings(self, verbose_mode: bool = False):
         """Display all the possible groupings for faces and edges"""

flow360/component/project.py

@@ -30,6 +30,7 @@
     validate_params_with_context,
 )
 from flow360.component.resource_base import Flow360Resource
+from flow360.component.simulation.folder import Folder
 from flow360.component.simulation.simulation_params import SimulationParams
 from flow360.component.simulation.unit_system import LengthType
 from flow360.component.simulation.web.asset_base import AssetBase
@@ -635,6 +636,7 @@ def _create_project_from_files(
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
         run_async: bool = False,
+        folder: Optional[Folder] = None,
     ):
         """
         Initializes a project from a file.
@@ -653,6 +655,8 @@ def _create_project_from_files(
             Tags to assign to the project (default is None).
         run_async : bool, optional
             Whether to create the project asynchronously (default is False).
+        folder : Optional[Folder], optional
+            Parent folder for the project. If None, creates in root.
 
         Returns
         -------
@@ -670,14 +674,16 @@ def _create_project_from_files(
         files._check_files_existence()
 
         if isinstance(files, GeometryFiles):
-            draft = Geometry.from_file(files.file_names, name, solver_version, length_unit, tags)
+            draft = Geometry.from_file(
+                files.file_names, name, solver_version, length_unit, tags, folder=folder
+            )
         elif isinstance(files, SurfaceMeshFile):
             draft = SurfaceMeshV2.from_file(
-                files.file_names, name, solver_version, length_unit, tags
+                files.file_names, name, solver_version, length_unit, tags, folder=folder
             )
         elif isinstance(files, VolumeMeshFile):
             draft = VolumeMeshV2.from_file(
-                files.file_names, name, solver_version, length_unit, tags
+                files.file_names, name, solver_version, length_unit, tags, folder=folder
             )
         else:
             raise Flow360FileError(
@@ -718,7 +724,11 @@ def _create_project_from_files(
         return project
 
     @classmethod
-    @pd.validate_call
+    @pd.validate_call(
+        config={
+            "arbitrary_types_allowed": True
+        }  # Folder (v2: component/simulation/folder.py) does not have validate() defined
+    )
     def from_geometry(
         cls,
         files: Union[str, list[str]],
@@ -728,6 +738,7 @@ def from_geometry(
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
         run_async: bool = False,
+        folder: Optional[Folder] = None,
     ):
         """
         Initializes a project from local geometry files.
@@ -746,6 +757,8 @@ def from_geometry(
             Tags to assign to the project (default is None).
         run_async : bool, optional
             Whether to create project asynchronously (default is False).
+        folder : Optional[Folder], optional
+            Parent folder for the project. If None, creates in root.
 
         Returns
         -------
@@ -781,10 +794,11 @@ def from_geometry(
             length_unit=length_unit,
             tags=tags,
             run_async=run_async,
+            folder=folder,
         )
 
     @classmethod
-    @pd.validate_call
+    @pd.validate_call(config={"arbitrary_types_allowed": True})
     def from_surface_mesh(
         cls,
         file: str,
@@ -794,6 +808,7 @@ def from_surface_mesh(
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
         run_async: bool = False,
+        folder: Optional[Folder] = None,
     ):
         """
         Initializes a project from a local surface mesh file.
@@ -813,6 +828,8 @@ def from_surface_mesh(
             Tags to assign to the project (default is None).
         run_async : bool, optional
             Whether to create project asynchronously (default is False).
+        folder : Optional[Folder], optional
+            Parent folder for the project. If None, creates in root.
 
         Returns
         -------
@@ -849,10 +866,11 @@ def from_surface_mesh(
             length_unit=length_unit,
             tags=tags,
             run_async=run_async,
+            folder=folder,
         )
 
     @classmethod
-    @pd.validate_call
+    @pd.validate_call(config={"arbitrary_types_allowed": True})
     def from_volume_mesh(
         cls,
         file: str,
@@ -862,6 +880,7 @@ def from_volume_mesh(
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
         run_async: bool = False,
+        folder: Optional[Folder] = None,
     ):
         """
         Initializes a project from a local volume mesh file.
@@ -881,6 +900,8 @@ def from_volume_mesh(
             Tags to assign to the project (default is None).
         run_async : bool, optional
             Whether to create project asynchronously (default is False).
+        folder : Optional[Folder], optional
+            Parent folder for the project. If None, creates in root.
 
         Returns
         -------
@@ -917,6 +938,7 @@ def from_volume_mesh(
             length_unit=length_unit,
             tags=tags,
             run_async=run_async,
+            folder=folder,
         )
 
     @classmethod

flow360/component/simulation/web/asset_base.py

@@ -24,6 +24,7 @@
     EntityInfoModel,
     parse_entity_info_model,
 )
+from flow360.component.simulation.folder import Folder
 from flow360.component.simulation.framework.updater_utils import Flow360Version
 from flow360.component.simulation.simulation_params import SimulationParams
 from flow360.component.utils import (
@@ -255,12 +256,14 @@ def from_file(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ):
         """
         Create asset draft from files
         :param file_names:
         :param project_name:
         :param tags:
+        :param folder: Folder object where the asset will be created (optional; defaults to root if unspecified)
         :return:
         """
         # pylint: disable=not-callable
@@ -270,6 +273,7 @@ def from_file(
             solver_version=solver_version,
             tags=tags,
             length_unit=length_unit,
+            folder=folder,
         )
 
     @classmethod

flow360/component/surface_mesh_v2.py

@@ -21,6 +21,7 @@
     ResourceDraft,
 )
 from flow360.component.simulation.entity_info import SurfaceMeshEntityInfo
+from flow360.component.simulation.folder import Folder
 from flow360.component.simulation.web.asset_base import AssetBase
 from flow360.component.utils import (
     MeshNameParser,
@@ -90,12 +91,14 @@ def __init__(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ):
         self._file_name = file_names
         self.project_name = project_name
         self.tags = tags if tags is not None else []
         self.length_unit = length_unit
         self.solver_version = solver_version
+        self.folder = folder
         self._validate()
         ResourceDraft.__init__(self)
 
@@ -157,9 +160,7 @@ def submit(self, description="", progress_callback=None, run_async=False) -> Sur
             solver_version=self.solver_version,
             tags=self.tags,
             file_name=self._file_name,
-            # pylint: disable=fixme
-            # TODO: remove hardcoding
-            parent_folder_id="ROOT.FLOW360",
+            parent_folder_id=self.folder.id if self.folder else "ROOT.FLOW360",
             length_unit=self.length_unit,
             description=description,
         )
@@ -277,6 +278,7 @@ def from_file(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ) -> SurfaceMeshDraftV2:
         """
         Parameters
@@ -291,6 +293,8 @@ def from_file(
             Length unit to use for the project ("m", "mm", "cm", "inch", "ft")
         tags: List[str]
             List of string tags to be added to the project upon creation
+        folder : Optional[Folder], optional
+            Parent folder for the project. If None, creates in root.
 
         Returns
         -------
@@ -304,6 +308,7 @@ def from_file(
             solver_version=solver_version,
             length_unit=length_unit,
             tags=tags,
+            folder=folder,
         )
 
     # pylint: disable=useless-parent-delegation

flow360/component/volume_mesh.py

@@ -28,6 +28,7 @@
 )
 from flow360.cloud.heartbeat import post_upload_heartbeat
 from flow360.cloud.rest_api import RestApi
+from flow360.component.simulation.folder import Folder
 from flow360.component.utils import VolumeMeshFile
 from flow360.component.v1.cloud.flow360_requests import NewVolumeMeshRequest
 from flow360.component.v1.meshing.params import VolumeMeshingParams
@@ -926,12 +927,14 @@ def __init__(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ):
         self.file_name = file_names
         self.project_name = project_name
         self.tags = tags if tags is not None else []
         self.length_unit = length_unit
         self.solver_version = solver_version
+        self.folder = folder
         self._validate()
         ResourceDraft.__init__(self)
 
@@ -1011,6 +1014,7 @@ def submit(
             solver_version=self.solver_version,
             tags=self.tags,
             file_name=original_file_with_compression,
+            parent_folder_id=self.folder.id if self.folder else "ROOT.FLOW360",
             length_unit=self.length_unit,
             format=mesh_format.value,
             description=description,
@@ -1137,6 +1141,7 @@ def from_file(
         solver_version: str = None,
         length_unit: LengthUnitType = "m",
         tags: List[str] = None,
+        folder: Optional[Folder] = None,
     ) -> VolumeMeshDraftV2:
         """
         Parameters
@@ -1151,6 +1156,8 @@ def from_file(
             Length unit to use for the project ("m", "mm", "cm", "inch", "ft")
         tags: List[str]
             List of string tags to be added to the project upon creation
+        folder : Optional[Folder], optional
+            Parent folder for the project. If None, creates in root.
 
         Returns
         -------
@@ -1164,6 +1171,7 @@ def from_file(
             solver_version=solver_version,
             length_unit=length_unit,
             tags=tags,
+            folder=folder,
         )
 
     # pylint: disable=useless-parent-delegation