Removing billed cost display; adding real_cost function for user

tidy3d/web/__init__.py

@@ -2,7 +2,7 @@
 import sys
 
 from .webapi import run, upload, get_info, start, monitor, delete, download, load, estimate_cost
-from .webapi import get_tasks, delete_old, download_json, download_log, load_simulation
+from .webapi import get_tasks, delete_old, download_json, download_log, load_simulation, real_cost
 from .container import Job, Batch, BatchData
 from .auth import get_credentials
 from .cli import tidy3d_cli

tidy3d/web/webapi.py

@@ -296,7 +296,10 @@ def monitor_preprocess() -> None:
     if verbose:
         est_flex_unit = get_estimated_cost()
         if est_flex_unit is not None and est_flex_unit > 0:
-            log.info(f"Maximum FlexUnit cost: {est_flex_unit:1.3f}")
+            log.info(
+                f"Maximum FlexUnit cost: {est_flex_unit:1.3f}. Use 'web.real_cost(task_id)' to "
+                "get the billed FlexUnit cost after a simulation run."
+            )
         log.info("starting up solver")
 
     # while running but before the percentage done is available, keep waiting
@@ -350,10 +353,6 @@ def monitor_preprocess() -> None:
         while get_status() not in break_statuses:
             time.sleep(REFRESH_TIME)
 
-    # show final billed cost
-    if verbose:
-        log.info(f"Billed FlexUnit cost: {get_info(task_id).realFlexUnit:1.3f}")
-
 
 def download(task_id: TaskId, path: str = "simulation_data.hdf5", verbose: bool = True) -> None:
     """Download results of task and log to file.
@@ -609,6 +608,24 @@ def estimate_cost(task_id: str) -> float:
     return resp.get("flex_unit")
 
 
+def real_cost(task_id: str) -> float:
+    """Get the billed cost for given task after it has been run.
+
+    Note
+    ----
+        The billed cost may not be immediately available when the task status is set to ``success``,
+        but should be available shortly after.
+    """
+
+    flex_unit = get_info(task_id).realFlexUnit
+    if not flex_unit:
+        log.warning(
+            f"Billed FlexUnit for task '{task_id}'' is not available. If the task has been "
+            "successfully run, it should be available shortly."
+        )
+    return flex_unit
+
+
 def _query_or_create_folder(folder_name) -> Folder:
     log.debug("query folder")
     method = f"tidy3d/project?projectName={folder_name}"