FEAT: Add lock option removal for save_as method

doc/changelog.d/1233.added.md

@@ -0,0 +1 @@
+Add lock option removal for `save_as` method

src/ansys/mechanical/core/embedding/app.py

@@ -28,7 +28,6 @@
 from pathlib import Path
 import shutil
 import typing
-import warnings
 
 from ansys.mechanical.core import LOG
 from ansys.mechanical.core.embedding import initializer, runtime
@@ -289,11 +288,9 @@
             lock_file = Path(self.DataModel.Project.ProjectDirectory) / ".mech_lock"
             # Remove the lock file if it exists before opening the project file
             if lock_file.exists():
-                warnings.warn(
-                    f"Removing the lock file, {lock_file}, before opening the project. \
-This may corrupt the project file.",
-                    UserWarning,
-                    stacklevel=2,
+                self.log_warning(
+                    f"Removing the lock file, {lock_file}, before opening the project. "
+                    "This may corrupt the project file."
                 )
                 lock_file.unlink()
 
@@ -306,7 +303,7 @@
         else:
             self.DataModel.Project.Save()
 
-    def save_as(self, path: str, overwrite: bool = False):
+    def save_as(self, path: str, overwrite: bool = False, remove_lock: bool = False):
         """
         Save the project as a new file.
 
@@ -318,6 +315,8 @@
             The path where the file needs to be saved.
         overwrite : bool, optional
             Whether the file should be overwritten if it already exists (default is False).
+        remove_lock : bool, optional
+            Whether to remove the lock file if it exists before saving the project file.
 
         Raises
         ------
@@ -350,7 +349,27 @@
             # Save the new file
             self.DataModel.Project.SaveAs(path)
         else:
-            self.DataModel.Project.SaveAs(path, overwrite)
+            if remove_lock:
+                file_path = Path(path)
+                associated_dir = file_path.parent / f"{file_path.stem}_Mech_Files"
+                lock_file = associated_dir / ".mech_lock"
+                # Remove the lock file if it exists before saving the project file
+                if lock_file.exists():
+                    self.log_warning(f"Removing the lock file, {lock_file}... ")
+                    lock_file.unlink()
+            try:
+                self.DataModel.Project.SaveAs(path, overwrite)
+            except Exception as e:
+                error_msg = str(e)
+                if "The project is locked by" in error_msg:
+                    self.log_error(
+                        f"Failed to save project as {path}: {error_msg}\n"
+                        "Hint: The project file is locked. "
+                        "Try using the 'remove_lock=True' option when saving the project."
+                    )
+                else:
+                    self.log_error(f"Failed to save project as {path}: {error_msg}")
+                raise e
 
     def launch_gui(self, delete_tmp_on_close: bool = True, dry_run: bool = False):
         """Launch the GUI."""

tests/embedding/test_app.py

@@ -539,7 +539,7 @@ def test_app_execute_script_from_file(embedded_app, rootdir, printer):
 
 
 @pytest.mark.embedding
-def test_app_lock_file_open(embedded_app, tmp_path: pytest.TempPathFactory):
+def test_app_lock_file_open(embedded_app, tmp_path: pytest.TempPathFactory, caplog):
     """Test the lock file is removed on open if remove_lock=True."""
     embedded_app.DataModel.Project.Name = "PROJECT 1"
     project_file = os.path.join(tmp_path, f"{NamedTemporaryFile().name}.mechdat")
@@ -554,9 +554,12 @@ def test_app_lock_file_open(embedded_app, tmp_path: pytest.TempPathFactory):
     assert lock_file.exists()
 
     # Assert a warning is emitted if the lock file is going to be removed
-    with pytest.warns(UserWarning):
+
+    with caplog.at_level("WARNING"):
         embedded_app.open(project_file, remove_lock=True)
 
+    assert any("Removing the lock file" in message for message in caplog.messages)
+
 
 @pytest.mark.embedding
 def test_app_initialized(embedded_app):