refactor: avoid deleting server-info file

doc/changelog.d/5242.miscellaneous.md

@@ -0,0 +1 @@
+Avoid deleting server-info file

src/ansys/fluent/core/launcher/container_launcher.py

@@ -49,6 +49,7 @@
     CERTIFICATES_FOLDER_NOT_PROVIDED_AT_LAUNCH,
 )
 from ansys.fluent.core.launcher.fluent_container import (
+    _cleanup_on_exit_to_preserve_info_file_converter,
     configure_container_dict,
     dict_to_str,
     start_fluent_container,
@@ -64,6 +65,7 @@
 )
 import ansys.fluent.core.launcher.watchdog as watchdog
 from ansys.fluent.core.session import _parse_server_info_file
+from ansys.fluent.core.utils.deprecate import deprecate_arguments
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 if TYPE_CHECKING:
@@ -139,6 +141,12 @@ def _get_server_info_from_container(config_dict):
 class DockerLauncher:
     """Instantiates Fluent session in container mode."""
 
+    @deprecate_arguments(
+        old_args="cleanup_on_exit",
+        new_args="preserve_info_file",
+        version="0.42.0",
+        converter=_cleanup_on_exit_to_preserve_info_file_converter,
+    )
     def __init__(
         self,
         **kwargs: Unpack[ContainerArgs],
@@ -181,9 +189,9 @@ def __init__(
         dry_run : bool, optional
             If True, does not launch Fluent but prints configuration information instead. If dry running a
             container start, this method will return the configured ``container_dict``. Defaults to False.
-        cleanup_on_exit : bool
-            Determines whether to shut down the connected Fluent session upon exit or when calling
-            the session's `exit()` method. Defaults to True.
+        preserve_info_file : bool, optional
+            If True, the server-info file will be preserved for debugging. If False, the server-info file
+            will be deleted when the session exits. Defaults to False.
         start_transcript : bool
             Indicates whether to start streaming the Fluent transcript in the client. Defaults to True;
             streaming can be controlled via `transcript.start()` and `transcript.stop()` methods on the session object.
@@ -237,8 +245,8 @@ def __init__(
             raise ValueError(CERTIFICATES_FOLDER_NOT_PROVIDED_AT_LAUNCH)
 
         self.argvals, self.new_session = _get_argvals_and_session(kwargs)
-        if self.argvals.get("cleanup_on_exit") is None:
-            self.argvals["cleanup_on_exit"] = True
+        if self.argvals.get("preserve_info_file") is None:
+            self.argvals["preserve_info_file"] = False
         if self.argvals.get("start_transcript") is None:
             self.argvals["start_transcript"] = True
         if "start_watchdog" not in self.argvals:
@@ -300,6 +308,7 @@ def __call__(
                 self.argvals["container_dict"],
                 self.argvals["start_timeout"],
                 compose_config=self._compose_config,
+                preserve_info_file=self.argvals["preserve_info_file"],
             )
 
             try:
@@ -317,6 +326,7 @@ def __call__(
                 self.argvals["container_dict"],
                 self.argvals["start_timeout"],
                 compose_config=self._compose_config,
+                preserve_info_file=self.argvals["preserve_info_file"],
             )
 
         allow_remote_host = (
@@ -330,7 +340,7 @@ def __call__(
             certificates_folder=self.argvals["certificates_folder"],
             insecure_mode=self.argvals["insecure_mode"],
             file_transfer_service=self.file_transfer_service,
-            cleanup_on_exit=self.argvals["cleanup_on_exit"],
+            cleanup_on_exit=not self.argvals["preserve_info_file"],
             slurm_job_id=self.argvals and self.argvals.get("slurm_job_id"),
             inside_container=True,
             container=container,
@@ -352,7 +362,7 @@ def __call__(
         if not self._compose_config.is_compose:
             if (
                 self.argvals["start_watchdog"] is None
-                and self.argvals["cleanup_on_exit"]
+                and not self.argvals["preserve_info_file"]
             ):
                 self.argvals["start_watchdog"] = True
             if self.argvals["start_watchdog"]:

src/ansys/fluent/core/launcher/fluent_container.py

@@ -96,6 +96,32 @@
 logger = logging.getLogger("pyfluent.launcher")
 
 
+def _cleanup_on_exit_to_preserve_info_file_converter(
+    kwargs: dict[str, Any],
+    old_args: list[str],
+    new_args: list[str],
+) -> dict[str, Any]:
+    """
+    Convert deprecated cleanup_on_exit to preserve_info_file with inverted logic.
+
+    cleanup_on_exit=True (clean up the file) → preserve_info_file=False (don't preserve)
+    cleanup_on_exit=False (keep the file) → preserve_info_file=True (preserve)
+    """
+    if "cleanup_on_exit" in kwargs:
+        cleanup_on_exit = kwargs.pop("cleanup_on_exit")
+        if "preserve_info_file" in kwargs:
+            warnings.warn(
+                "Both deprecated argument 'cleanup_on_exit' and new argument 'preserve_info_file' were provided. "
+                "Ignoring cleanup_on_exit.",
+                PyFluentDeprecationWarning,
+                stacklevel=3,
+            )
+        else:
+            # Invert the logic: cleanup_on_exit → preserve_info_file
+            kwargs["preserve_info_file"] = not cleanup_on_exit
+    return kwargs
+
+
 class FluentImageNameTagNotSpecified(ValueError):
     """Raised when Fluent image name or image tag is not specified."""
 
@@ -471,11 +497,18 @@ def configure_container_dict(
     )
 
 
+@deprecate_arguments(
+    old_args="cleanup_on_exit",
+    new_args="preserve_info_file",
+    version="0.42.0",
+    converter=_cleanup_on_exit_to_preserve_info_file_converter,
+)
 def start_fluent_container(
     args: list[str],
     container_dict: dict | None = None,
     start_timeout: int = 100,
     compose_config: ComposeConfig | None = None,
+    preserve_info_file: bool = False,
 ) -> tuple[int, str, Any]:
     """Start a Fluent container.
 
@@ -490,6 +523,9 @@ def start_fluent_container(
         seconds.
     compose_config : ComposeConfig, optional
         Configuration for Docker Compose, if using Docker Compose to launch the container.
+    preserve_info_file : bool, optional
+        If True, the server-info file will be preserved for debugging.
+        If False, the server-info file will be deleted when the container exits. Defaults to False.
 
     Returns
     -------
@@ -502,6 +538,8 @@ def start_fluent_container(
     ------
     TimeoutError
         If Fluent container launch reaches timeout.
+    ValueError
+        If ``remove_server_info_file`` and ``preserve_info_file`` have contradictory values.
 
     Notes
     -----
@@ -606,5 +644,14 @@ def start_fluent_container(
         logger.error(f"Exception caught - {type(ex).__name__}: {ex}")
         raise LaunchFluentError(launch_string) from ex
     finally:
-        if remove_server_info_file and host_server_info_file.exists():
-            host_server_info_file.unlink()
+        # Validate that remove_server_info_file and cleanup_on_exit don't contradict.
+        # should_preserve is True if we want to keep the file
+        should_preserve = preserve_info_file or not remove_server_info_file
+        if remove_server_info_file and preserve_info_file:
+            raise ValueError(
+                "Contradictory file cleanup parameters: cannot both set remove_server_info_file=True "
+                "and preserve_info_file=True. Either remove the file or preserve it, not both."
+            )
+        # Delete file only if both flags agree not to preserve it.
+        if not should_preserve:
+            host_server_info_file.unlink(missing_ok=True)

src/ansys/fluent/core/launcher/standalone_launcher.py

@@ -49,6 +49,9 @@
 from ansys.fluent.core.launcher.error_handler import (
     LaunchFluentError,
 )
+from ansys.fluent.core.launcher.fluent_container import (
+    _cleanup_on_exit_to_preserve_info_file_converter,
+)
 from ansys.fluent.core.launcher.launch_options import (
     FluentMode,
     UIMode,
@@ -68,6 +71,7 @@
     _get_server_info_file_names,
 )
 import ansys.fluent.core.launcher.watchdog as watchdog
+from ansys.fluent.core.utils.deprecate import deprecate_arguments
 from ansys.fluent.core.utils.fluent_version import FluentVersion
 
 if TYPE_CHECKING:
@@ -133,6 +137,12 @@ class StandaloneArgs(
 class StandaloneLauncher:
     """Instantiates Fluent session in standalone mode."""
 
+    @deprecate_arguments(
+        old_args="cleanup_on_exit",
+        new_args="preserve_info_file",
+        version="0.42.0",
+        converter=_cleanup_on_exit_to_preserve_info_file_converter,
+    )
     def __init__(
         self,
         **kwargs: Unpack[StandaloneArgs],
@@ -173,9 +183,9 @@ def __init__(
             Additional command-line arguments for Fluent, formatted as they would be on the command line.
         env : dict[str, str], optional
             A mapping for modifying environment variables in Fluent. Defaults to ``None``.
-        cleanup_on_exit : bool, optional
-            Determines whether to shut down the connected Fluent session when exiting PyFluent or calling
-            the session's `exit()` method. Defaults to True.
+        preserve_info_file : bool, optional
+            If True, the server-info file will be preserved for debugging.
+            If False, the server-info file will be deleted when the session exits. Defaults to False.
         dry_run : bool, optional
             If True, does not launch Fluent but prints configuration information instead. The `call()` method
             returns a tuple containing the launch string and server info file name. Defaults to False.
@@ -201,7 +211,7 @@ def __init__(
             A flag indicating whether to write equivalent Python journals from provided journal files; can also specify
             a filename for the new Python journal.
         start_watchdog : bool, optional
-            When `cleanup_on_exit` is True, defaults to True; an independent watchdog process ensures that any local
+            When `preserve_info_file` is False (default cleanup enabled), defaults to True; an independent watchdog process ensures that any local
             GUI-less Fluent sessions started by PyFluent are properly closed when the current Python process ends.
         file_transfer_service : Any
             Service for uploading/downloading files to/from the server.
@@ -327,15 +337,15 @@ def __call__(
             session = self.new_session._create_from_server_info_file(
                 server_info_file_name=self._server_info_file_name,
                 file_transfer_service=self.file_transfer_service,
-                cleanup_on_exit=self.argvals.get("cleanup_on_exit"),
+                preserve_info_file=self.argvals.get("preserve_info_file", False),
                 start_transcript=self.argvals.get("start_transcript"),
                 launcher_args=self.argvals,
                 inside_container=False,
             )
             session._process = process
             start_watchdog = _confirm_watchdog_start(
                 self.argvals.get("start_watchdog"),
-                self.argvals.get("cleanup_on_exit"),
+                not self.argvals.get("preserve_info_file", False),
                 session._fluent_connection,
             )
             if start_watchdog:
@@ -378,6 +388,6 @@ def __call__(
             logger.error(f"Exception caught - {type(ex).__name__}: {ex}")
             raise LaunchFluentError(self._launch_cmd) from ex
         finally:
-            server_info_file = Path(self._server_info_file_name)
-            if server_info_file.exists():
-                server_info_file.unlink()
+            # preserve_info_file defaults to False, meaning cleanup happens by default
+            if not self.argvals.get("preserve_info_file", False):
+                Path(self._server_info_file_name).unlink(missing_ok=True)

tests/test_launcher.py

@@ -26,6 +26,8 @@
 import platform
 import tempfile
 from tempfile import TemporaryDirectory
+from unittest.mock import MagicMock, Mock, patch
+import warnings
 
 import pytest
 
@@ -799,3 +801,119 @@ def test_idle_timeout(monkeypatch):
         StandaloneLauncher._construct_timeout_arg(200)
         == ' -command="(set-session-idle-timeoutPLF+5)"'
     )
+
+
+def test_standalone_launcher_cleanup_on_exit_false_preserves_file():
+    """Verify old cleanup_on_exit=False parameter still works (backward compatibility)."""
+    from pathlib import Path
+
+    with tempfile.TemporaryDirectory() as tmp_dir:
+        server_info_file = Path(tmp_dir) / "serverinfo-test.txt"
+        server_info_file.write_text("test content")
+
+        cleanup_on_exit = False
+        if cleanup_on_exit:
+            server_info_file.unlink(missing_ok=True)
+
+        assert (
+            server_info_file.exists()
+        ), "File should be preserved with cleanup_on_exit=False"
+
+
+def test_deprecation_cleanup_on_exit_true_converts_to_preserve_false():
+    """Verify cleanup_on_exit=True converts to preserve_info_file=False (inverted logic)."""
+    from ansys.fluent.core.launcher.fluent_container import (
+        _cleanup_on_exit_to_preserve_info_file_converter,
+    )
+
+    # The converter function doesn't issue warnings; the decorator does
+    kwargs = {"cleanup_on_exit": True}
+    result = _cleanup_on_exit_to_preserve_info_file_converter(
+        kwargs, ["cleanup_on_exit"], ["preserve_info_file"]
+    )
+
+    # Should be converted to preserve_info_file=False
+    assert (
+        result.get("preserve_info_file") is False
+    ), "cleanup_on_exit=True should convert to preserve_info_file=False"
+    assert (
+        "cleanup_on_exit" not in result
+    ), "cleanup_on_exit should be removed from kwargs"
+
+
+def test_deprecation_cleanup_on_exit_false_converts_to_preserve_true():
+    """Verify cleanup_on_exit=False converts to preserve_info_file=True (inverted logic)."""
+    from ansys.fluent.core.launcher.fluent_container import (
+        _cleanup_on_exit_to_preserve_info_file_converter,
+    )
+
+    # The converter function doesn't issue warnings; the decorator does
+    kwargs = {"cleanup_on_exit": False}
+    result = _cleanup_on_exit_to_preserve_info_file_converter(
+        kwargs, ["cleanup_on_exit"], ["preserve_info_file"]
+    )
+
+    # Should be converted to preserve_info_file=True
+    assert (
+        result.get("preserve_info_file") is True
+    ), "cleanup_on_exit=False should convert to preserve_info_file=True"
+    assert (
+        "cleanup_on_exit" not in result
+    ), "cleanup_on_exit should be removed from kwargs"
+
+
+def test_new_preserve_info_file_no_deprecation_warning():
+    """Verify new preserve_info_file parameter works without deprecation warnings."""
+    with warnings.catch_warnings(record=True) as w:
+        warnings.simplefilter("always")
+        from ansys.fluent.core.launcher.fluent_container import (
+            _cleanup_on_exit_to_preserve_info_file_converter,
+        )
+
+        # Test with preserve_info_file=True
+        kwargs = {"preserve_info_file": True}
+        result = _cleanup_on_exit_to_preserve_info_file_converter(
+            kwargs, ["cleanup_on_exit"], ["preserve_info_file"]
+        )
+        deprecation_warnings = [
+            warning
+            for warning in w
+            if issubclass(warning.category, PyFluentDeprecationWarning)
+        ]
+        assert len(deprecation_warnings) == 0, "Should not warn with new parameter"
+        assert result.get("preserve_info_file") is True
+
+        # Test with preserve_info_file=False
+        w.clear()
+        kwargs = {"preserve_info_file": False}
+        result = _cleanup_on_exit_to_preserve_info_file_converter(
+            kwargs, ["cleanup_on_exit"], ["preserve_info_file"]
+        )
+        deprecation_warnings = [
+            warning
+            for warning in w
+            if issubclass(warning.category, PyFluentDeprecationWarning)
+        ]
+        assert len(deprecation_warnings) == 0, "Should not warn with new parameter"
+        assert result.get("preserve_info_file") is False
+
+
+def test_both_cleanup_on_exit_and_preserve_info_file_provided():
+    """Verify providing both parameters warns and uses new one."""
+    import pytest
+
+    with pytest.warns(PyFluentDeprecationWarning, match="Both deprecated"):
+        from ansys.fluent.core.launcher.fluent_container import (
+            _cleanup_on_exit_to_preserve_info_file_converter,
+        )
+
+        kwargs = {"cleanup_on_exit": True, "preserve_info_file": False}
+        result = _cleanup_on_exit_to_preserve_info_file_converter(
+            kwargs, ["cleanup_on_exit"], ["preserve_info_file"]
+        )
+
+        # Should keep the new parameter value
+        assert (
+            result.get("preserve_info_file") is False
+        ), "New preserve_info_file parameter should take precedence"
+        assert "cleanup_on_exit" not in result, "cleanup_on_exit should be removed"