docs(spm): strip _ from generated models

Otherwise docs can't be generated for them

Author: nfrasser

cryosparc/api.pyi

@@ -68,7 +68,7 @@ from .models.notification import Notification
 from .models.preview import DeleteProjectPreview, DeleteWorkspacePreview
 from .models.project import GenerateIntermediateResultsSettings, Project, ProjectSymlink
 from .models.scheduler_lane import SchedulerLane
-from .models.scheduler_target import SchedulerTarget, SchedulerTarget_Cluster_, SchedulerTarget_Node_
+from .models.scheduler_target import SchedulerTarget, SchedulerTargetCluster, SchedulerTargetNode
 from .models.services import LoggingService
 from .models.session import (
     DataManagementStats,
@@ -690,7 +690,7 @@ class ResourcesAPI(APINamespace):
 
         """
         ...
-    def find_nodes(self, *, lane: Optional[str] = None) -> List[SchedulerTarget_Node_]:
+    def find_nodes(self, *, lane: Optional[str] = None) -> List[SchedulerTargetNode]:
         """
         Finds a list of targets with type "node" that are registered with the master scheduler.
         These correspond to discrete worker hostname accessible over SSH.
@@ -699,24 +699,24 @@ class ResourcesAPI(APINamespace):
             lane (str, optional): Defaults to None
 
         Returns:
-            List[SchedulerTarget_Node_]: List of targets with type 'node'
+            List[SchedulerTargetNode]: List of targets with type 'node'
 
         """
         ...
-    def add_node(self, body: SchedulerTarget_Node_) -> SchedulerTarget_Node_:
+    def add_node(self, body: SchedulerTargetNode) -> SchedulerTargetNode:
         """
         Adds a node or updates an existing node. Updates existing node if they share
         share the same name.
 
         Args:
-            body (SchedulerTarget_Node_):
+            body (SchedulerTargetNode):
 
         Returns:
-            SchedulerTarget_Node_: Successful Response
+            SchedulerTargetNode: Successful Response
 
         """
         ...
-    def find_clusters(self, *, lane: Optional[str] = None) -> List[SchedulerTarget_Cluster_]:
+    def find_clusters(self, *, lane: Optional[str] = None) -> List[SchedulerTargetCluster]:
         """
         Finds a list of targets with type "cluster" that are registered with the master scheduler.
         These are multi-node clusters managed by workflow managers like SLURM or PBS and are accessible via submission script.
@@ -725,20 +725,20 @@ class ResourcesAPI(APINamespace):
             lane (str, optional): Defaults to None
 
         Returns:
-            List[SchedulerTarget_Cluster_]: List of targets with type 'cluster'
+            List[SchedulerTargetCluster]: List of targets with type 'cluster'
 
         """
         ...
-    def add_cluster(self, body: SchedulerTarget_Cluster_) -> SchedulerTarget_Cluster_:
+    def add_cluster(self, body: SchedulerTargetCluster) -> SchedulerTargetCluster:
         """
         Adds a cluster or updates an existing cluster. Updates existing cluster if
         they share share the same name.
 
         Args:
-            body (SchedulerTarget_Cluster_):
+            body (SchedulerTargetCluster):
 
         Returns:
-            SchedulerTarget_Cluster_: Successful Response
+            SchedulerTargetCluster: Successful Response
 
         """
         ...
@@ -766,15 +766,15 @@ class ResourcesAPI(APINamespace):
 
         """
         ...
-    def find_node(self, name: str, /) -> SchedulerTarget_Node_:
+    def find_node(self, name: str, /) -> SchedulerTargetNode:
         """
         Finds a node with a given name.
 
         Args:
             name (str):
 
         Returns:
-            SchedulerTarget_Node_: Successful Response
+            SchedulerTargetNode: Successful Response
 
         """
         ...
@@ -787,15 +787,15 @@ class ResourcesAPI(APINamespace):
 
         """
         ...
-    def find_cluster(self, name: str, /) -> SchedulerTarget_Cluster_:
+    def find_cluster(self, name: str, /) -> SchedulerTargetCluster:
         """
         Finds a cluster with a given name.
 
         Args:
             name (str):
 
         Returns:
-            SchedulerTarget_Cluster_: Successful Response
+            SchedulerTargetCluster: Successful Response
 
         """
         ...
@@ -848,7 +848,7 @@ class ResourcesAPI(APINamespace):
 
         """
         ...
-    def update_node_lane(self, name: str, /, lane: str) -> SchedulerTarget_Node_:
+    def update_node_lane(self, name: str, /, lane: str) -> SchedulerTargetNode:
         """
         Changes the lane on the given target (assumed to exist). Target type must
         match lane type.
@@ -858,7 +858,7 @@ class ResourcesAPI(APINamespace):
             lane (str):
 
         Returns:
-            SchedulerTarget_Node_: Successful Response
+            SchedulerTargetNode: Successful Response
 
         """
         ...
@@ -882,7 +882,7 @@ class ResourcesAPI(APINamespace):
 
         """
         ...
-    def update_cluster_custom_vars(self, name: str, /, value: Dict[str, str]) -> SchedulerTarget_Cluster_:
+    def update_cluster_custom_vars(self, name: str, /, value: Dict[str, str]) -> SchedulerTargetCluster:
         """
         Changes the custom cluster variables on the given target (assumed to exist)
 
@@ -891,7 +891,7 @@ class ResourcesAPI(APINamespace):
             value (Dict[str, str]):
 
         Returns:
-            SchedulerTarget_Cluster_: Successful Response
+            SchedulerTargetCluster: Successful Response
 
         """
         ...

cryosparc/models/scheduler_target.py

@@ -159,7 +159,7 @@ class SchedulerTarget(BaseModel):
     config: Union[Node, Cluster]
 
 
-class SchedulerTarget_Cluster_(BaseModel):
+class SchedulerTargetCluster(BaseModel):
     cache_path: Optional[str] = None
     """
     Path the SSD cache scratch directory, if applicable.
@@ -200,7 +200,7 @@ class SchedulerTarget_Cluster_(BaseModel):
     config: Cluster
 
 
-class SchedulerTarget_Node_(BaseModel):
+class SchedulerTargetNode(BaseModel):
     cache_path: Optional[str] = None
     """
     Path the SSD cache scratch directory, if applicable.

cryosparc/registry.py

@@ -102,8 +102,13 @@ def model_for_ref(schema_ref: str) -> Optional[Type]:
         return
 
     schema_name = components[3]
-    if schema_name in REGISTERED_MODEL_CLASSES:
-        return REGISTERED_MODEL_CLASSES[schema_name]
+
+    # remove underscores used to delimit type vars, which are excluded in models
+    # generated from openapi.json (cannot generate docs for classes that end in `_`)
+    clean_schema_name = schema_name.replace("_", "")
+
+    if clean_schema_name in REGISTERED_MODEL_CLASSES:
+        return REGISTERED_MODEL_CLASSES[clean_schema_name]
     elif "_" in schema_name:  # type var
         generic, var, *_ = schema_name.split("_")
         if generic in REGISTERED_MODEL_CLASSES and var in REGISTERED_MODEL_CLASSES: