Generalize SerializableBaseModelList

Author: NickCao

packages/jumpstarter-cli-admin/jumpstarter_cli_admin/print.py

@@ -9,8 +9,8 @@
     V1Alpha1Client,
     V1Alpha1Exporter,
     V1Alpha1Lease,
-    V1Alpha1List,
 )
+from jumpstarter.common.pydantic import SerializableBaseModelList
 
 CLIENT_COLUMNS = ["NAME", "ENDPOINT", "AGE"]
 
@@ -30,7 +30,7 @@ def print_client(client: V1Alpha1Client, output: OutputType):
         click.echo(make_table(CLIENT_COLUMNS, [make_client_row(client)]))
 
 
-def print_clients(clients: V1Alpha1List[V1Alpha1Client], namespace: str, output: OutputType):
+def print_clients(clients: SerializableBaseModelList[V1Alpha1Client], namespace: str, output: OutputType):
     if output:
         echo(clients.dump(output))
     else:
@@ -86,7 +86,9 @@ def print_exporter(exporter: V1Alpha1Exporter, devices: bool, output: OutputType
             click.echo(make_table(EXPORTER_COLUMNS, [make_exporter_row(exporter)]))
 
 
-def print_exporters(exporters: V1Alpha1List[V1Alpha1Exporter], namespace: str, devices: bool, output: OutputType):
+def print_exporters(
+    exporters: SerializableBaseModelList[V1Alpha1Exporter], namespace: str, devices: bool, output: OutputType
+):
     if output:
         echo(exporters.dump(output))
     else:
@@ -144,7 +146,7 @@ def print_lease(lease: V1Alpha1Lease, output: OutputType):
         click.echo(make_table(LEASE_COLUMNS, [make_lease_row(lease)]))
 
 
-def print_leases(leases: V1Alpha1List[V1Alpha1Lease], namespace: str, output: OutputType):
+def print_leases(leases: SerializableBaseModelList[V1Alpha1Lease], namespace: str, output: OutputType):
     if output:
         echo(leases.dump(output))
     else:

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/__init__.py

@@ -15,7 +15,6 @@
     V1Alpha1LeaseSpec,
     V1Alpha1LeaseStatus,
 )
-from .list import V1Alpha1List
 
 __all__ = [
     "ClientsV1Alpha1Api",
@@ -33,7 +32,6 @@
     "V1Alpha1LeaseList",
     "V1Alpha1LeaseSelector",
     "V1Alpha1LeaseSpec",
-    "V1Alpha1List",
     "get_ip_address",
     "helm_installed",
     "install_helm_chart",

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/clients.py

@@ -7,9 +7,9 @@
 from pydantic import Field
 
 from .json import JsonBaseModel
-from .list import V1Alpha1List
 from .serialize import SerializeV1ObjectMeta, SerializeV1ObjectReference
 from .util import AbstractAsyncCustomObjectApi
+from jumpstarter.common.pydantic import SerializableBaseModelList
 from jumpstarter.config import ClientConfigV1Alpha1, ClientConfigV1Alpha1Drivers, ObjectMeta
 
 logger = logging.getLogger(__name__)
@@ -53,7 +53,7 @@ def from_dict(dict: dict):
         )
 
 
-class V1Alpha1ClientList(V1Alpha1List[V1Alpha1Client]):
+class V1Alpha1ClientList(SerializableBaseModelList[V1Alpha1Client]):
     kind: Literal["ClientList"] = Field(default="ClientList")
 
     @staticmethod
@@ -99,7 +99,7 @@ async def create_client(
             await asyncio.sleep(CREATE_CLIENT_DELAY)
         raise Exception("Timeout waiting for client credentials")
 
-    async def list_clients(self) -> V1Alpha1List[V1Alpha1Client]:
+    async def list_clients(self) -> SerializableBaseModelList[V1Alpha1Client]:
         """List the client objects in the cluster async"""
         res = await self.api.list_namespaced_custom_object(
             namespace=self.namespace, group="jumpstarter.dev", plural="clients", version="v1alpha1"

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/exporters.py

@@ -6,9 +6,9 @@
 from pydantic import Field
 
 from .json import JsonBaseModel
-from .list import V1Alpha1List
 from .serialize import SerializeV1ObjectMeta, SerializeV1ObjectReference
 from .util import AbstractAsyncCustomObjectApi
+from jumpstarter.common.pydantic import SerializableBaseModelList
 from jumpstarter.config import ExporterConfigV1Alpha1, ObjectMeta
 
 CREATE_EXPORTER_DELAY = 1
@@ -57,7 +57,7 @@ def from_dict(dict: dict):
         )
 
 
-class V1Alpha1ExporterList(V1Alpha1List[V1Alpha1Exporter]):
+class V1Alpha1ExporterList(SerializableBaseModelList[V1Alpha1Exporter]):
     kind: Literal["ExporterList"] = Field(default="ExporterList")
 
     @staticmethod
@@ -68,7 +68,7 @@ def from_dict(dict: dict):
 class ExportersV1Alpha1Api(AbstractAsyncCustomObjectApi):
     """Interact with the exporters custom resource API"""
 
-    async def list_exporters(self) -> V1Alpha1List[V1Alpha1Exporter]:
+    async def list_exporters(self) -> SerializableBaseModelList[V1Alpha1Exporter]:
         """List the exporter objects in the cluster"""
         res = await self.api.list_namespaced_custom_object(
             namespace=self.namespace, group="jumpstarter.dev", plural="exporters", version="v1alpha1"

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/leases.py

@@ -4,9 +4,9 @@
 from pydantic import Field
 
 from .json import JsonBaseModel
-from .list import V1Alpha1List
 from .serialize import SerializeV1Condition, SerializeV1ObjectMeta, SerializeV1ObjectReference
 from .util import AbstractAsyncCustomObjectApi
+from jumpstarter.common.pydantic import SerializableBaseModelList
 
 
 class V1Alpha1LeaseStatus(JsonBaseModel):
@@ -77,7 +77,7 @@ def from_dict(dict: dict):
         )
 
 
-class V1Alpha1LeaseList(V1Alpha1List[V1Alpha1Lease]):
+class V1Alpha1LeaseList(SerializableBaseModelList[V1Alpha1Lease]):
     kind: Literal["LeaseList"] = Field(default="LeaseList")
 
     @staticmethod
@@ -88,7 +88,7 @@ def from_dict(dict: dict):
 class LeasesV1Alpha1Api(AbstractAsyncCustomObjectApi):
     """Interact with the leases custom resource API"""
 
-    async def list_leases(self) -> V1Alpha1List[V1Alpha1Lease]:
+    async def list_leases(self) -> SerializableBaseModelList[V1Alpha1Lease]:
         """List the lease objects in the cluster async"""
         result = await self.api.list_namespaced_custom_object(
             namespace=self.namespace, group="jumpstarter.dev", plural="leases", version="v1alpha1"

packages/jumpstarter-kubernetes/jumpstarter_kubernetes/list.py

@@ -1,5 +1,9 @@
+from typing import Generic, Literal, TypeVar
+
 import yaml
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
+
+T = TypeVar("T")
 
 
 class OutputMode(str):
@@ -31,3 +35,15 @@ def dump_json(self) -> str:
 
     def dump_yaml(self) -> str:
         return yaml.safe_dump(self.model_dump(mode="json", by_alias=True), indent=2)
+
+
+class SerializableBaseModelList(SerializableBaseModel, Generic[T]):
+    api_version: Literal["jumpstarter.dev/v1alpha1"] = Field(
+        alias="apiVersion",
+        default="jumpstarter.dev/v1alpha1",
+    )
+    kind: Literal["List"] = Field(default="List")
+    items: list[T]
+
+    def dump_name(self):
+        return "".join(item.dump_name() for item in self.items)