Make path parameter optional instead of defaulting to simulation_data.hdf5

Co-authored-by: momchil-flex <92756559+momchil-flex@users.noreply.github.com>

Author: Copilot

tidy3d/web/api/webapi.py

@@ -83,31 +83,29 @@
 }
 
 
-def _get_default_path(task_id: str, provided_path: PathLike) -> Path:
+def _get_default_path(task_id: str, provided_path: Optional[PathLike]) -> Path:
     """Get the appropriate default path based on task type.
 
-    If the user provided a non-default path, returns it as-is.
-    Otherwise, returns the task-type-specific default filename.
+    If the user provided a path, returns it as-is.
+    If no path is provided (None), returns the task-type-specific default filename.
 
     Parameters
     ----------
     task_id : str
         Unique identifier of task on server.
-    provided_path : PathLike
-        Path provided by the user.
+    provided_path : Optional[PathLike]
+        Path provided by the user, or None to use task-type default.
 
     Returns
     -------
     Path
         The appropriate path to use for this task type.
     """
-    path = Path(provided_path)
+    # If user provided a path, respect it exactly
+    if provided_path is not None:
+        return Path(provided_path)
 
-    # If user provided a custom path (not the generic default), respect it
-    if path.name not in {"simulation_data.hdf5", "simulation_data.hdf5.gz"}:
-        return path
-
-    # Determine task type
+    # Determine task type for default filename
     if _is_modeler_batch(task_id):
         task_type = "RF"
     else:
@@ -117,11 +115,7 @@ def _get_default_path(task_id: str, provided_path: PathLike) -> Path:
     # Get the task-type-specific default filename
     default_filename = DEFAULT_DATA_FILENAME.get(task_type, "simulation_data.hdf5")
 
-    # Preserve .gz extension if present
-    if path.name.endswith(".gz") and not default_filename.endswith(".gz"):
-        default_filename += ".gz"
-
-    return path.with_name(default_filename)
+    return Path(default_filename)
 
 
 def _get_url(task_id: str) -> str:
@@ -338,7 +332,7 @@ def run(
     simulation: WorkflowType,
     task_name: Optional[str] = None,
     folder_name: str = "default",
-    path: PathLike = "simulation_data.hdf5",
+    path: Optional[PathLike] = None,
     callback_url: Optional[str] = None,
     verbose: bool = True,
     progress_callback_upload: Optional[Callable[[float], None]] = None,
@@ -364,8 +358,9 @@ def run(
         Name of task. If not provided, a default name will be generated.
     folder_name : str = "default"
         Name of folder to store task on web UI.
-    path : PathLike = "simulation_data.hdf5"
+    path : Optional[PathLike] = None
         Path to download results file (.hdf5), including filename.
+        If not provided, uses a task-type-specific default filename.
     callback_url : str = None
         Http PUT url to receive simulation finish event. The body content is a json file with
         fields ``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.
@@ -390,7 +385,7 @@ def run(
         It affects only simulations from vGPU licenses and does not impact simulations using FlexCredits.
     lazy : bool = False
         Whether to load the actual data (``lazy=False``) or return a proxy that loads
-        the data when accessed (``lazy=True``).
+        the data when accessed (``lazy=True`).
 
     Returns
     -------
@@ -1055,7 +1050,7 @@ def abort(task_id: TaskId) -> Optional[TaskInfo]:
 @wait_for_connection
 def download(
     task_id: TaskId,
-    path: PathLike = "simulation_data.hdf5",
+    path: Optional[PathLike] = None,
     verbose: bool = True,
     progress_callback: Optional[Callable[[float], None]] = None,
 ) -> None:
@@ -1065,8 +1060,9 @@ def download(
     ----------
     task_id : str
         Unique identifier of task on server.  Returned by :meth:`upload`.
-    path : PathLike = "simulation_data.hdf5"
+    path : Optional[PathLike] = None
         Download path to .hdf5 data file (including filename).
+        If not provided, uses a task-type-specific default filename.
     verbose : bool = True
         If ``True``, will print progressbars and status, otherwise, will run silently.
     progress_callback : Callable[[float], None] = None
@@ -1189,7 +1185,7 @@ def download_log(
 @wait_for_connection
 def load(
     task_id: Optional[TaskId],
-    path: PathLike = "simulation_data.hdf5",
+    path: Optional[PathLike] = None,
     replace_existing: bool = True,
     verbose: bool = True,
     progress_callback: Optional[Callable[[float], None]] = None,
@@ -1215,8 +1211,10 @@ def load(
     ----------
     task_id : Optional[str] = None
         Unique identifier of task on server. Returned by :meth:`upload`. If None, file is assumed to exist already from cache.
-    path : PathLike
+    path : Optional[PathLike] = None
         Download path to .hdf5 data file (including filename).
+        If not provided and task_id is given, uses a task-type-specific default filename.
+        If not provided and task_id is None, defaults to "simulation_data.hdf5".
     replace_existing : bool = True
         Downloads the data even if path exists (overwriting the existing).
     verbose : bool = True
@@ -1236,7 +1234,8 @@ def load(
     if task_id is not None:
         path = _get_default_path(task_id, path)
     else:
-        path = Path(path)
+        # When no task_id, use provided path or fall back to generic default
+        path = Path(path) if path is not None else Path("simulation_data.hdf5")
 
     if task_id is None:
         if not path.exists():