fix: make import component named selections optional (#2144)

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Ryan Ward <[email protected]>
Co-authored-by: rward <[email protected]>
Co-authored-by: Roberto Pastor Muela <[email protected]>

Author: 4 people

doc/changelog.d/2144.fixed.md

@@ -0,0 +1 @@
+Make import component named selections optional

src/ansys/geometry/core/_grpc/_services/v0/designs.py

@@ -170,7 +170,9 @@ def insert(self, **kwargs) -> dict:  # noqa: D102
         from ansys.api.dbu.v0.designs_pb2 import InsertRequest
 
         # Create the request - assumes all inputs are valid and of the proper type
-        request = InsertRequest(filepath=kwargs["filepath"])
+        request = InsertRequest(
+            filepath=kwargs["filepath"], import_named_selections=kwargs["import_named_selections"]
+        )
 
         # Call the gRPC service
         _ = self.stub.Insert(request)

src/ansys/geometry/core/designer/component.py

@@ -1905,6 +1905,14 @@ def import_named_selections(self) -> None:
         --------
         This method is only available starting on Ansys release 26R1.
         """
+        from ansys.geometry.core.designer import Design
+
+        if isinstance(self, Design):
+            raise ValueError(
+                "import_named_selections() cannot be used on a Design object, "
+                "it can only be used on a pure Component object."
+            )
+
         self._component_stub.ImportGroups(ImportGroupsRequest(id=self._grpc_id))
 
         design = get_design_from_component(self)

src/ansys/geometry/core/designer/design.py

@@ -973,7 +973,9 @@ def delete_beam_profile(self, beam_profile: BeamProfile | str) -> None:
     @ensure_design_is_active
     @min_backend_version(24, 2, 0)
     def insert_file(
-        self, file_location: Path | str, import_options: ImportOptions = ImportOptions()
+        self,
+        file_location: Path | str,
+        import_options: ImportOptions = ImportOptions(),
     ) -> Component:
         """Insert a file into the design.
 
@@ -997,7 +999,9 @@ def insert_file(
         filepath_server = self._modeler._upload_file(file_location, import_options=import_options)
 
         # Insert the file into the design
-        self._grpc_client.services.designs.insert(filepath=filepath_server)
+        self._grpc_client.services.designs.insert(
+            filepath=filepath_server, import_named_selections=import_options.import_named_selections
+        )
         self._grpc_client.log.debug(f"File {file_location} successfully inserted into design.")
 
         self._update_design_inplace()

src/ansys/geometry/core/misc/options.py

@@ -48,6 +48,8 @@ class ImportOptions:
         Import planes.
     import_points : bool = False
         Import points.
+    import_named_selections : bool = True
+        Import the named selections associated with the root component being inserted.
     """
 
     cleanup_bodies: bool = False
@@ -57,6 +59,7 @@ class ImportOptions:
     import_names: bool = False
     import_planes: bool = False
     import_points: bool = False
+    import_named_selections: bool = True
 
     def to_dict(self):
         """Provide the dictionary representation of the ImportOptions class."""

tests/_incompatible_tests.yml

@@ -102,6 +102,7 @@ backends:
       # Bug fix included from 26.1 onwards
       - tests/integration/test_design_import.py::test_named_selections_after_file_insert
       - tests/integration/test_design_import.py::test_named_selections_after_file_open
+      - tests/integration/test_design_import.py::test_file_insert_import_named_selections_post_import
       # Export body facets add in 26.1
       - tests/integration/test_design.py::test_write_body_facets_on_save
 
@@ -200,6 +201,7 @@ backends:
       # Bug fix included from 26.1 onwards
       - tests/integration/test_design_import.py::test_named_selections_after_file_insert
       - tests/integration/test_design_import.py::test_named_selections_after_file_open
+      - tests/integration/test_design_import.py::test_file_insert_import_named_selections_post_import
       # Export body facets add in 26.1
       - tests/integration/test_design.py::test_write_body_facets_on_save
 
@@ -267,6 +269,7 @@ backends:
       # Bug fix included from 26.1 onwards
       - tests/integration/test_design_import.py::test_named_selections_after_file_insert
       - tests/integration/test_design_import.py::test_named_selections_after_file_open
+      - tests/integration/test_design_import.py::test_file_insert_import_named_selections_post_import
       # Export body facets add in 26.1
       - tests/integration/test_design.py::test_write_body_facets_on_save
 
@@ -298,5 +301,6 @@ backends:
       # Bug fix included from 26.1 onwards
       - tests/integration/test_design_import.py::test_named_selections_after_file_insert
       - tests/integration/test_design_import.py::test_named_selections_after_file_open
+      - tests/integration/test_design_import.py::test_file_insert_import_named_selections_post_import
       # Export body facets add in 26.1
       - tests/integration/test_design.py::test_write_body_facets_on_save

tests/integration/test_design_import.py

@@ -32,7 +32,7 @@
 from ansys.geometry.core.designer import Component, Design
 from ansys.geometry.core.designer.design import DesignFileFormat
 from ansys.geometry.core.math import UNITVECTOR3D_Z, Plane, Point2D, Point3D, UnitVector3D, Vector3D
-from ansys.geometry.core.misc import UNITS, Distance
+from ansys.geometry.core.misc import UNITS, Distance, ImportOptions
 from ansys.geometry.core.sketch import Sketch
 from ansys.geometry.core.tools.unsupported import ExportIdData, PersistentIdType
 
@@ -588,7 +588,6 @@ def test_import_scdocx_with_external_docs(modeler: Modeler):
         assert len(component.bodies) == 1
 
 
-@pytest.mark.skip(reason="Temporary skip for build promotion")
 def test_named_selections_after_file_insert(modeler: Modeler):
     """Test to verify named selections are imported during inserting a file."""
     # Create a new design
@@ -666,3 +665,57 @@ def test_named_selections_after_file_open(modeler: Modeler):
     assert set(actual_named_selections) == set(expected_named_selections), (
         f"Expected named selections {expected_named_selections}, but got {actual_named_selections}."
     )
+
+
+def test_file_insert_import_named_selections_post_import(modeler: Modeler):
+    """Test to verify named selections can be imported after inserting a file."""
+    # Create a new design
+    design = modeler.create_design("BugFix_1277429")
+
+    # Verify initial named selections count
+    initial_named_selections_count = len(design.named_selections)
+    assert initial_named_selections_count == 0, (
+        f"Expected no named selections initially, but got {initial_named_selections_count}."
+    )
+
+    # Insert the file
+    file_path = Path(FILES_DIR, "reactorWNS.scdocx")
+    options = ImportOptions()
+    options.import_named_selections = False
+    design.insert_file(file_path, import_options=options)
+
+    # Verify initial named selections count
+    initial_named_selections_count = len(design.named_selections)
+    assert initial_named_selections_count == 0, (
+        f"Expected no named selections initially, but got {initial_named_selections_count}."
+    )
+    design.components[0].import_named_selections()
+    # Verify named selections count after importing
+    updated_named_selections_count = len(design.named_selections)
+    assert updated_named_selections_count == 9, (
+        f"Expected 9 named selections after file insertion, but got "
+        f"{updated_named_selections_count}."
+    )
+
+    # Expected named selections
+    expected_named_selections = [
+        "wall_liquid_level",
+        "wall_tank",
+        "wall_probe_1",
+        "wall_probe_2",
+        "wall_shaft",
+        "wall_impeller_1",
+        "wall_shaft_1",
+        "wall_impeller_2",
+        "wall_shaft_2",
+    ]
+
+    # Verify the names of the named selections
+    actual_named_selections = [ns.name for ns in design.named_selections]
+    for ns_name in actual_named_selections:
+        assert ns_name in expected_named_selections, f"Unexpected named selection: {ns_name}"
+
+    # Verify all expected named selections are present
+    assert set(actual_named_selections) == set(expected_named_selections), (
+        f"Expected named selections {expected_named_selections}, but got {actual_named_selections}."
+    )