Parametrized folder endpoints

Author: daquinteroflex

tidy3d/plugins/smatrix/component_modelers/base.py

@@ -186,6 +186,7 @@ def batch(self) -> Batch:
             callback_url=self.callback_url,
             verbose=self.verbose,
             solver_version=self.solver_version,
+            simulation_type="microwave",
         )
 
     @cached_property

tidy3d/web/api/container.py

@@ -32,6 +32,8 @@
 DEFAULT_DATA_DIR = "."
 BATCH_MONITOR_PROGRESS_REFRESH_TIME = 0.02
 
+BatchSimulationType = Literal["tidy3d", "microwave"]
+
 
 class WebContainer(Tidy3dBaseModel, ABC):
     """Base class for :class:`Job` and :class:`Batch`, technically not used"""
@@ -158,7 +160,7 @@ class Job(WebContainer):
         True, title="Verbose", description="Whether to print info messages and progressbars."
     )
 
-    simulation_type: str = pd.Field(
+    simulation_type: BatchSimulationType = pd.Field(
         "tidy3d",
         title="Simulation Type",
         description="Type of simulation, used internally only.",
@@ -530,7 +532,7 @@ class Batch(WebContainer):
         "``{'id', 'status', 'name', 'workUnit', 'solverVersion'}``.",
     )
 
-    simulation_type: str = pd.Field(
+    simulation_type: BatchSimulationType = pd.Field(
         "tidy3d",
         title="Simulation Type",
         description="Type of each simulation in the batch, used internally only.",
@@ -1068,3 +1070,8 @@ def _check_path_dir(path_dir: str) -> None:
         """
         if len(path_dir) > 0 and not os.path.exists(path_dir):
             os.makedirs(path_dir, exist_ok=True)
+
+    @staticmethod
+    def _check_folder(folder_name: str, endpoint_type: BatchSimulationType) -> None:
+        """Make sure ``folder_name`` exists on the web UI and create it if not."""
+        Folder.get(folder_name, create=True)

tidy3d/web/core/task_core.py

@@ -37,15 +37,15 @@ class Folder(Tidy3DResource, Queryable, extra=Extra.allow):
     )
 
     @classmethod
-    def list(cls) -> []:
+    def list(cls, project_endpoint: str = "tidy3d/project") -> []:
         """List all folders.
 
         Returns
         -------
         folders : [Folder]
             List of folders
         """
-        resp = http.get("tidy3d/projects")
+        resp = http.get(project_endpoint)
         return (
             parse_obj_as(
                 list[Folder],
@@ -56,7 +56,7 @@ def list(cls) -> []:
         )
 
     @classmethod
-    def get(cls, folder_name: str, create: bool = False):
+    def get(cls, folder_name: str, create: bool = False, project_endpoint: str = "tidy3d/project"):
         """Get folder by name.
 
         Parameters
@@ -72,11 +72,11 @@ def get(cls, folder_name: str, create: bool = False):
         """
         folder = FOLDER_CACHE.get(folder_name)
         if not folder:
-            resp = http.get("tidy3d/project", params={"projectName": folder_name})
+            resp = http.get(project_endpoint, params={"projectName": folder_name})
             if resp:
                 folder = Folder(**resp)
         if create and not folder:
-            resp = http.post("tidy3d/projects", {"projectName": folder_name})
+            resp = http.post(project_endpoint, {"projectName": folder_name})
             if resp:
                 folder = Folder(**resp)
         FOLDER_CACHE[folder_name] = folder
@@ -97,10 +97,10 @@ def create(cls, folder_name: str):
         """
         return Folder.get(folder_name, True)
 
-    def delete(self):
+    def delete(self, project_endpoint: str = "tidy3d/project"):
         """Remove this folder."""
 
-        http.delete(f"tidy3d/projects/{self.folder_id}")
+        http.delete(f"{project_endpoint}/{self.folder_id}")
 
     def delete_old(self, days_old: int) -> int:
         """Remove folder contents older than ``days_old``."""
@@ -110,15 +110,15 @@ def delete_old(self, days_old: int) -> int:
             params={"daysOld": days_old},
         )
 
-    def list_tasks(self) -> list[Tidy3DResource]:
+    def list_tasks(self, project_endpoint: str = "tidy3d/project") -> list[Tidy3DResource]:
         """List all tasks in this folder.
 
         Returns
         -------
         tasks : List[:class:`.SimulationTask`]
             List of tasks in this folder
         """
-        resp = http.get(f"tidy3d/projects/{self.folder_id}/tasks")
+        resp = http.get(f"{project_endpoint}/{self.folder_id}/tasks")
         return (
             parse_obj_as(
                 list[SimulationTask],
@@ -209,6 +209,7 @@ def create(
         simulation_type: str = "tidy3d",
         parent_tasks: Optional[list[str]] = None,
         file_type: str = "Gz",
+        project_endpoint: str = "tidy3d/project",
     ) -> SimulationTask:
         """Create a new task on the server.
 
@@ -243,7 +244,7 @@ def create(
 
         folder = Folder.get(folder_name, create=True)
         resp = http.post(
-            f"tidy3d/projects/{folder.folder_id}/tasks",
+            f"{project_endpoint}/{folder.folder_id}/tasks",
             {
                 "taskName": task_name,
                 "taskType": task_type,