enh[web]: make pay type selection case insensitive

Author: yaugenst-flex

tests/test_web/test_tidy3d_task.py

@@ -256,6 +256,67 @@ def test_submit(set_api_key):
     # monitor(TASK_ID, True)
 
 
+@responses.activate
+def test_pay_type_case_insensitivity(set_api_key):
+    """Test PayType enum's case-insensitive behavior with different string formats."""
+    project_id = "1234"
+    TASK_ID = "5678"
+    task_name = "test pay type"
+
+    responses.add(
+        responses.GET,
+        f"{Env.current.web_api_endpoint}/tidy3d/project",
+        match=[matchers.query_param_matcher({"projectName": "test pay type folder"})],
+        json={"data": {"projectId": project_id, "projectName": "test pay type folder"}},
+        status=200,
+    )
+    responses.add(
+        responses.POST,
+        f"{Env.current.web_api_endpoint}/tidy3d/projects/{project_id}/tasks",
+        json={
+            "data": {
+                "taskId": TASK_ID,
+                "taskName": task_name,
+                "createdAt": "2022-01-01T00:00:00.000Z",
+            }
+        },
+        status=200,
+    )
+
+    responses.add(
+        responses.POST,
+        f"{Env.current.web_api_endpoint}/tidy3d/tasks/{TASK_ID}/submit",
+        json={
+            "data": {
+                "taskId": TASK_ID,
+                "taskName": task_name,
+                "createdAt": "2022-01-01T00:00:00.000Z",
+                "taskBlockInfo": {
+                    "chargeType": "free",
+                    "maxFreeCount": 20,
+                    "maxGridPoints": 1000,
+                    "maxTimeSteps": 1000,
+                },
+            }
+        },
+        status=200,
+    )
+
+    task = SimulationTask.create(TaskType.FDTD, task_name, "test pay type folder")
+
+    valid_pay_types = [
+        "auto",
+        "AUTO",
+        PayType.AUTO,
+        "credits",
+        "CREDITS",
+        PayType.CREDITS,
+    ]
+
+    for pay_type in valid_pay_types:
+        task.submit(pay_type=pay_type)
+
+
 @responses.activate
 def test_estimate_cost(set_api_key):
     TASK_ID = "3eb06d16-208b-487b-864b-e9b1d3e010a7"

tidy3d/web/api/asynchronous.py

@@ -1,6 +1,6 @@
 """Interface to run several jobs in batch using simplified syntax."""
 
-from typing import Dict, List, Literal
+from typing import Dict, List, Literal, Union
 
 from ...log import log
 from ..core.types import PayType
@@ -18,7 +18,7 @@ def run_async(
     simulation_type: str = "tidy3d",
     parent_tasks: Dict[str, List[str]] = None,
     reduce_simulation: Literal["auto", True, False] = "auto",
-    pay_type: PayType = PayType.AUTO,
+    pay_type: Union[PayType, str] = PayType.AUTO,
 ) -> BatchData:
     """Submits a set of Union[:class:`.Simulation`, :class:`.HeatSimulation`, :class:`.EMESimulation`] objects to server,
     starts running, monitors progress, downloads, and loads results as a :class:`.BatchData` object.
@@ -42,7 +42,7 @@ def run_async(
         If ``True``, will print progressbars and status, otherwise, will run silently.
     reduce_simulation: Literal["auto", True, False] = "auto"
         Whether to reduce structures in the simulation to the simulation domain only. Note: currently only implemented for the mode solver.
-    pay_type: PayType = PayType.AUTO
+    pay_type: Union[PayType, str] = PayType.AUTO
         Specify the payment method.
 
     Returns
@@ -60,7 +60,6 @@ def run_async(
     :class:`Batch`
         Interface for submitting several :class:`Simulation` objects to sever.
     """
-
     if simulation_type is None:
         simulation_type = "tidy3d"
 

tidy3d/web/api/autograd/autograd.py

@@ -107,7 +107,7 @@ def run(
     local_gradient: bool = LOCAL_GRADIENT,
     max_num_adjoint_per_fwd: int = MAX_NUM_ADJOINT_PER_FWD,
     reduce_simulation: Literal["auto", True, False] = "auto",
-    pay_type: PayType = PayType.AUTO,
+    pay_type: typing.Union[PayType, str] = PayType.AUTO,
 ) -> SimulationDataType:
     """
     Submits a :class:`.Simulation` to server, starts running, monitors progress, downloads,
@@ -145,7 +145,7 @@ def run(
         Maximum number of adjoint simulations allowed to run automatically.
     reduce_simulation: Literal["auto", True, False] = "auto"
         Whether to reduce structures in the simulation to the simulation domain only. Note: currently only implemented for the mode solver.
-    pay_type: PayType = AUTO
+    pay_type: typing.Union[PayType, str] = PayType.AUTO
         Which method to pay for the simulation.
     Returns
     -------
@@ -191,7 +191,6 @@ def run(
     :meth:`tidy3d.web.api.container.Batch.monitor`
         Monitor progress of each of the running tasks.
     """
-
     if is_valid_for_autograd(simulation):
         return _run(
             simulation=simulation,
@@ -241,7 +240,7 @@ def run_async(
     local_gradient: bool = LOCAL_GRADIENT,
     max_num_adjoint_per_fwd: int = MAX_NUM_ADJOINT_PER_FWD,
     reduce_simulation: Literal["auto", True, False] = "auto",
-    pay_type: PayType = PayType.AUTO,
+    pay_type: typing.Union[PayType, str] = PayType.AUTO,
 ) -> BatchData:
     """Submits a set of Union[:class:`.Simulation`, :class:`.HeatSimulation`, :class:`.EMESimulation`] objects to server,
     starts running, monitors progress, downloads, and loads results as a :class:`.BatchData` object.
@@ -270,7 +269,7 @@ def run_async(
         Maximum number of adjoint simulations allowed to run automatically.
     reduce_simulation: Literal["auto", True, False] = "auto"
         Whether to reduce structures in the simulation to the simulation domain only. Note: currently only implemented for the mode solver.
-    pay_type: PayType = PayType.AUTO
+    pay_type: typing.Union[PayType, str] = PayType.AUTO
         Specify the payment method.
 
     Returns
@@ -288,7 +287,6 @@ def run_async(
     :class:`Batch`
         Interface for submitting several :class:`Simulation` objects to sever.
     """
-
     if is_valid_for_autograd_async(simulations):
         return _run_async(
             simulations=simulations,

tidy3d/web/api/mode.py

@@ -7,7 +7,7 @@
 import tempfile
 import time
 from datetime import datetime
-from typing import Callable, List, Optional
+from typing import Callable, List, Optional, Union
 
 import pydantic.v1 as pydantic
 from botocore.exceptions import ClientError
@@ -56,7 +56,7 @@ def run(
     progress_callback_upload: Callable[[float], None] = None,
     progress_callback_download: Callable[[float], None] = None,
     reduce_simulation: Literal["auto", True, False] = "auto",
-    pay_type: PayType = PayType.AUTO,
+    pay_type: Union[PayType, str] = PayType.AUTO,
 ) -> ModeSolverData:
     """Submits a :class:`.ModeSolver` to server, starts running, monitors progress, downloads,
     and loads results as a :class:`.ModeSolverData` object.
@@ -82,14 +82,13 @@ def run(
     reduce_simulation : Literal["auto", True, False] = "auto"
         Restrict simulation to mode solver region. If "auto", then simulation is automatically
         restricted if it contains custom mediums.
-    pay_type: PayType = PayType.AUTO
+    pay_type: Union[PayType, str] = PayType.AUTO
         Which method to pay the simulation.
     Returns
     -------
     :class:`.ModeSolverData`
         Mode solver data with the calculated results.
     """
-
     log_level = "DEBUG" if verbose else "INFO"
     if verbose:
         console = get_logging_console()
@@ -466,13 +465,16 @@ def upload(
 
     def submit(
         self,
-        pay_type: PayType = PayType.AUTO,
+        pay_type: Union[PayType, str] = PayType.AUTO,
     ):
         """Start the execution of this task.
 
         The mode solver must be uploaded to the server with the :meth:`ModeSolverTask.upload` method
         before this step.
         """
+        # convert right before sending to API
+        pay_type = PayType(pay_type) if not isinstance(pay_type, PayType) else pay_type
+
         http.post(
             f"{MODESOLVER_API}/{self.task_id}/{self.solver_id}/run",
             {

tidy3d/web/api/webapi.py

@@ -5,7 +5,7 @@
 import tempfile
 import time
 from datetime import datetime, timedelta
-from typing import Callable, Dict, List
+from typing import Callable, Dict, List, Union
 
 import pytz
 from requests import HTTPError
@@ -86,7 +86,7 @@ def run(
     simulation_type: str = "tidy3d",
     parent_tasks: list[str] = None,
     reduce_simulation: Literal["auto", True, False] = "auto",
-    pay_type: PayType = PayType.AUTO,
+    pay_type: Union[PayType, str] = PayType.AUTO,
 ) -> SimulationDataType:
     """
     Submits a :class:`.Simulation` to server, starts running, monitors progress, downloads,
@@ -119,7 +119,7 @@ def run(
         worker group
     reduce_simulation : Literal["auto", True, False] = "auto"
         Whether to reduce structures in the simulation to the simulation domain only. Note: currently only implemented for the mode solver.
-    pay_type: PayType = PayType.AUTO
+    pay_type: Union[PayType, str] = PayType.AUTO
        Which method to pay the simulation.
 
     Returns
@@ -376,7 +376,7 @@ def start(
     task_id: TaskId,
     solver_version: str = None,
     worker_group: str = None,
-    pay_type: PayType = PayType.AUTO,
+    pay_type: Union[PayType, str] = PayType.AUTO,
 ) -> None:
     """Start running the simulation associated with task.
 
@@ -389,7 +389,7 @@ def start(
         target solver version.
     worker_group: str = None
         worker group
-    pay_type: PayType = PayType.AUTO
+    pay_type: Union[PayType, str] = PayType.AUTO
         Which method to pay the simulation
     Note
     ----

tidy3d/web/core/task_core.py

@@ -6,7 +6,7 @@
 import pathlib
 import tempfile
 from datetime import datetime
-from typing import Callable, List, Optional, Tuple
+from typing import Callable, List, Optional, Tuple, Union
 
 import pydantic.v1 as pd
 from botocore.exceptions import ClientError
@@ -413,7 +413,7 @@ def submit(
         self,
         solver_version: str = None,
         worker_group: str = None,
-        pay_type: PayType = PayType.AUTO,
+        pay_type: Union[PayType, str] = PayType.AUTO,
     ):
         """Kick off this task.
 
@@ -427,9 +427,10 @@ def submit(
             target solver version.
         worker_group: str = None
             worker group
-        pay_type: PayType = PayType.AUTO
+        pay_type: Union[PayType, str] = PayType.AUTO
             Which method to pay the simulation.
         """
+        pay_type = PayType(pay_type) if not isinstance(pay_type, PayType) else pay_type
 
         if solver_version:
             protocol_version = None

tidy3d/web/core/types.py

@@ -59,3 +59,11 @@ class TaskType(str, Enum):
 class PayType(str, Enum):
     CREDITS = "FLEX_CREDIT"
     AUTO = "AUTO"
+
+    @classmethod
+    def _missing_(cls, value: object) -> PayType:
+        if isinstance(value, str):
+            key = value.strip().replace(" ", "_").upper()
+            if key in cls.__members__:
+                return cls.__members__[key]
+        return super()._missing_(value)