fix: correct typevar generated definitions (#142)

Previously typevars were not correctly imported in the api client type stub. They should be now, though somewhat inelegantly, because it's difficult to generate model stubs with typevars

Author: nfrasser

cryosparc/api.py

@@ -389,7 +389,9 @@ def _decode_json_response(value: Any, schema: dict):
     # Check for schema that links to one of our existing models
     if "$ref" in schema:
         model_class = registry.model_for_ref(schema["$ref"])
-        if model_class and issubclass(model_class, Enum):
+        if model_class and registry.is_literal(model_class):
+            return value  # literal type, return as-is
+        elif model_class and issubclass(model_class, Enum):
             return model_class(value)
         elif model_class and issubclass(model_class, dict):  # typed dict
             return model_class(**value)

cryosparc/api.pyi

@@ -1,15 +1,14 @@
 # THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
 # SEE dev/api_generate_client.py
-
 import datetime
 from typing import Any, Dict, List, Literal, Optional, Tuple, Union
 
+import httpx
+
 from .dataset import Dataset
 from .models.api_request import AppSession, SHA256Password
 from .models.api_response import (
     BrowseFileResponse,
-    DeleteProjectPreview,
-    DeleteWorkspacePreview,
     GetFinalResultsResponse,
     Hello,
     WorkspaceAncestorUidsResponse,
@@ -27,21 +26,22 @@ from .models.job_register import JobRegister
 from .models.job_spec import Category, InputSpec, OutputResult, OutputSpec
 from .models.license import LicenseInstance, UpdateTag
 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 Cluster, Node, SchedulerTarget
+from .models.scheduler_target import SchedulerTarget, SchedulerTarget_Cluster_, SchedulerTarget_Node_
 from .models.services import LoggingService
 from .models.session import (
     DataManagementStats,
     ExposureGroup,
     ExposureGroupUpdate,
     LiveComputeResources,
     Session,
+    SessionStatus,
     TemplateSelectionThreshold,
 )
 from .models.session_config_profile import SessionConfigProfile, SessionConfigProfileBody
 from .models.session_params import LiveAbinitParams, LiveClass2DParams, LivePreprocessingParams, LiveRefineParams
-from .models.session_spec import SessionStatus
 from .models.tag import Tag
 from .models.user import User
 from .models.workspace import Workspace
@@ -53,7 +53,7 @@ Auth token or email/password.
 """
 
 class APINamespace:
-    def __init__(self, http_client: Any = None) -> None: ...
+    def __init__(self, http_client: httpx.Client) -> None: ...
 
 class ConfigNamespace(APINamespace):
     """
@@ -70,13 +70,6 @@ class ConfigNamespace(APINamespace):
         Gets this CryoSPARC instance's unique UID.
         """
         ...
-    def generate_new_instance_uid(self, *, force_takeover_projects: bool = False) -> str:
-        """
-        Generates a new uid for the CryoSPARC instance
-        If force_takeover_projects is True, overwrites existing lockfiles,
-        otherwise if force_takeover_projects is False, only creates lockfile in projects that don't already have one
-        """
-        ...
     def set_default_job_priority(self, value: int) -> Any:
         """
         Job priority
@@ -159,6 +152,13 @@ class InstanceNamespace(APINamespace):
         """
         ...
     def audit_dump(self) -> str | None: ...
+    def generate_new_uid(self, *, force_takeover_projects: bool = False) -> str:
+        """
+        Generates a new uid for the CryoSPARC instance
+        If force_takeover_projects is True, overwrites existing lockfiles,
+        otherwise, creates lockfiles in projects that don't already have one.
+        """
+        ...
 
 class CacheNamespace(APINamespace):
     """
@@ -338,25 +338,25 @@ class ResourcesNamespace(APINamespace):
         Finds a list of targets that are registered with the master scheduler.
         """
         ...
-    def find_nodes(self, *, lane: Optional[str] = ...) -> List[SchedulerTarget[Node]]:
+    def find_nodes(self, *, lane: Optional[str] = ...) -> List[SchedulerTarget_Node_]:
         """
         Finds a list of targets with type "node" that are registered with the master scheduler.
         These correspond to discrete worker hostname accessible over SSH.
         """
         ...
-    def add_node(self, body: SchedulerTarget[Node]) -> SchedulerTarget[Node]:
+    def add_node(self, body: SchedulerTarget_Node_) -> SchedulerTarget_Node_:
         """
         Adds a node or updates an existing node. Updates existing node if they share
         share the same name.
         """
         ...
-    def find_clusters(self, *, lane: Optional[str] = ...) -> List[SchedulerTarget[Cluster]]:
+    def find_clusters(self, *, lane: Optional[str] = ...) -> List[SchedulerTarget_Cluster_]:
         """
         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.
         """
         ...
-    def add_cluster(self, body: SchedulerTarget[Cluster]) -> SchedulerTarget[Cluster]:
+    def add_cluster(self, body: SchedulerTarget_Cluster_) -> SchedulerTarget_Cluster_:
         """
         Adds a cluster or updates an existing cluster. Updates existing cluster if
         they share share the same name.
@@ -372,7 +372,7 @@ class ResourcesNamespace(APINamespace):
         Finds a target with a given name.
         """
         ...
-    def find_node(self, name: str, /) -> SchedulerTarget[Node]:
+    def find_node(self, name: str, /) -> SchedulerTarget_Node_:
         """
         Finds a node with a given name.
         """
@@ -382,7 +382,7 @@ class ResourcesNamespace(APINamespace):
         Removes a target worker node from the master scheduler
         """
         ...
-    def find_cluster(self, name: str, /) -> SchedulerTarget[Cluster]:
+    def find_cluster(self, name: str, /) -> SchedulerTarget_Cluster_:
         """
         Finds a cluster with a given name.
         """
@@ -411,7 +411,7 @@ class ResourcesNamespace(APINamespace):
         (i.e., all variables not in the internal list of known variable names).
         """
         ...
-    def update_node_lane(self, name: str, /, lane: str) -> SchedulerTarget[Node]:
+    def update_node_lane(self, name: str, /, lane: str) -> SchedulerTarget_Node_:
         """
         Changes the lane on the given target (assumed to exist). Target type must
         match lane type.
@@ -429,7 +429,7 @@ class ResourcesNamespace(APINamespace):
         command
         """
         ...
-    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]) -> SchedulerTarget_Cluster_:
         """
         Changes the custom cluster variables on the given target (assumed to exist)
         """
@@ -2016,7 +2016,7 @@ class ProjectsNamespace(APINamespace):
         Claims ownership of all projects in instance. Call when upgrading from an older CryoSPARC version that did not support project locks.
         """
         ...
-    def archive(self, project_uid: str, /) -> Project:
+    def archive(self, project_uid: str, /) -> Any:
         """
         Archives a project. This means that the project can no longer be modified
         and jobs cannot be created or run. Once archived, the project directory may

cryosparc/model_registry.py

@@ -18,6 +18,7 @@
     license,
     notification,
     params,
+    preview,
     project,
     scheduler_lane,
     scheduler_target,
@@ -34,33 +35,34 @@
 )
 from .registry import register_model_module
 
-register_model_module(job)
-register_model_module(scheduler_target)
-register_model_module(gpu)
-register_model_module(api_request)
-register_model_module(session)
-register_model_module(user)
-register_model_module(api_response)
-register_model_module(job_spec)
-register_model_module(exposure)
-register_model_module(event)
-register_model_module(session_params)
-register_model_module(external)
-register_model_module(project)
-register_model_module(asset)
-register_model_module(signature)
-register_model_module(instance)
-register_model_module(workspace)
-register_model_module(job_register)
-register_model_module(when)
-register_model_module(params)
-register_model_module(license)
-register_model_module(services)
-register_model_module(notification)
-register_model_module(diagnostics)
-register_model_module(scheduler_lane)
-register_model_module(session_spec)
-register_model_module(session_config_profile)
-register_model_module(config)
-register_model_module(tag)
-register_model_module(auth)
+register_model_module(job, include_literals=True)
+register_model_module(scheduler_target, include_literals=True)
+register_model_module(gpu, include_literals=True)
+register_model_module(api_request, include_literals=True)
+register_model_module(session, include_literals=True)
+register_model_module(user, include_literals=True)
+register_model_module(api_response, include_literals=True)
+register_model_module(job_spec, include_literals=True)
+register_model_module(exposure, include_literals=True)
+register_model_module(event, include_literals=True)
+register_model_module(preview, include_literals=True)
+register_model_module(session_params, include_literals=True)
+register_model_module(external, include_literals=True)
+register_model_module(project, include_literals=True)
+register_model_module(asset, include_literals=True)
+register_model_module(signature, include_literals=True)
+register_model_module(instance, include_literals=True)
+register_model_module(workspace, include_literals=True)
+register_model_module(job_register, include_literals=True)
+register_model_module(when, include_literals=True)
+register_model_module(params, include_literals=True)
+register_model_module(license, include_literals=True)
+register_model_module(services, include_literals=True)
+register_model_module(notification, include_literals=True)
+register_model_module(diagnostics, include_literals=True)
+register_model_module(scheduler_lane, include_literals=True)
+register_model_module(session_spec, include_literals=True)
+register_model_module(session_config_profile, include_literals=True)
+register_model_module(config, include_literals=True)
+register_model_module(tag, include_literals=True)
+register_model_module(auth, include_literals=True)

cryosparc/models/api_response.py

@@ -24,30 +24,6 @@ class BrowseFileResponse(BaseModel):
     type: str
 
 
-class DeleteJobPreview(BaseModel):
-    project_uid: str
-    uid: str
-    workspace_uids: List[str]
-    status: str
-    title: str
-    type: str
-
-
-class DeleteProjectWorkspacePreview(BaseModel):
-    project_uid: str
-    uid: str
-    title: Optional[str]
-
-
-class DeleteProjectPreview(BaseModel):
-    jobs: List[DeleteJobPreview]
-    workspaces: List[DeleteProjectWorkspacePreview]
-
-
-class DeleteWorkspacePreview(BaseModel):
-    jobs: List[DeleteJobPreview]
-
-
 class GetFinalResultsResponse(BaseModel):
     final_results: List[str]
     ancestors_of_final_results: List[str]

cryosparc/models/job.py

@@ -98,7 +98,6 @@ class Job(BaseModel):
     queued_to_lane: Optional[str] = None
     queued_to_hostname: Optional[str] = None
     queued_to_gpu: Optional[List[int]] = None
-    queue_index: Optional[int] = None
     queue_status: Optional[
         Literal[
             "waiting_inputs",

cryosparc/models/preview.py

@@ -0,0 +1,54 @@
+# THIS FILE IS AUTO-GENERATED, DO NOT EDIT DIRECTLY
+# SEE dev/api_generate_models.py
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel
+
+
+class DeleteJobPreview(BaseModel):
+    project_uid: str
+    uid: str
+    workspace_uids: List[str]
+    status: str
+    title: str
+    type: str
+
+
+class DeleteProjectWorkspacePreview(BaseModel):
+    project_uid: str
+    uid: str
+    title: Optional[str]
+
+
+class DeleteProjectPreview(BaseModel):
+    jobs: List[DeleteJobPreview]
+    workspaces: List[DeleteProjectWorkspacePreview]
+
+
+class KeepJobPreview(BaseModel):
+    """
+    Job from a delete request that cannot be deleted and the reasons for it.
+    """
+
+    project_uid: str
+    uid: str
+    workspace_uids: List[str]
+    status: str
+    title: str
+    type: str
+    reason: Literal["final", "descendants"]
+    descendant_job_uids: List[str] = []
+    descendant_workspace_uids: List[str] = []
+
+
+class DeleteWorkspacePreview(BaseModel):
+    """
+    Preview of a workspace delete operation, including jobs that will be deleted
+    or unlinked and those that will be kept. If there any kept jobs, the
+    workspace will not be marked as deleted.
+    """
+
+    delete: List[DeleteJobPreview]
+    unlink: List[DeleteJobPreview]
+    keep: List[KeepJobPreview]
+    jobs: List[DeleteJobPreview]