[Feature]: Allow listing available key resources such as gpu, region, and backends #2142 (WIP)

Minor refactoring

Author: peterschmidt85

src/dstack/_internal/cli/commands/gpu.py

@@ -76,7 +76,7 @@ def _command(self, args: argparse.Namespace):
             status = contextlib.nullcontext()
 
         with status:
-            gpu_response = self.api.client.gpus.get_gpus(
+            gpu_response = self.api.client.gpus.list_gpus(
                 self.api.project,
                 run_spec,
                 group_by=args.group_by,

src/dstack/_internal/server/routers/gpus.py

@@ -5,9 +5,9 @@
 
 from dstack._internal.server.db import get_session
 from dstack._internal.server.models import ProjectModel, UserModel
-from dstack._internal.server.schemas.gpus import GetRunGpusRequest, RunGpusResponse
+from dstack._internal.server.schemas.gpus import ListGpusRequest, ListGpusResponse
 from dstack._internal.server.security.permissions import ProjectMember
-from dstack._internal.server.services.gpus import get_run_gpus_grouped
+from dstack._internal.server.services.gpus import list_gpus_grouped
 from dstack._internal.server.utils.routers import get_base_api_additional_responses
 
 project_router = APIRouter(
@@ -17,13 +17,13 @@
 )
 
 
-@project_router.post("/list", response_model=RunGpusResponse, response_model_exclude_none=True)
-async def get_run_gpus(
-    body: GetRunGpusRequest,
+@project_router.post("/list", response_model=ListGpusResponse, response_model_exclude_none=True)
+async def list_gpus(
+    body: ListGpusRequest,
     session: AsyncSession = Depends(get_session),
     user_project: Tuple[UserModel, ProjectModel] = Depends(ProjectMember()),
-) -> RunGpusResponse:
+) -> ListGpusResponse:
     _, project = user_project
-    return await get_run_gpus_grouped(
+    return await list_gpus_grouped(
         session=session, project=project, run_spec=body.run_spec, group_by=body.group_by
     )

src/dstack/_internal/server/schemas/gpus.py

@@ -30,8 +30,8 @@ class BackendGpus(CoreModel):
     regions: List[str]
 
 
-class GetRunGpusRequest(CoreModel):
-    """Request for getting run GPUs with optional grouping."""
+class ListGpusRequest(CoreModel):
+    """Request for listing GPUs with optional grouping."""
 
     run_spec: RunSpec
     group_by: Optional[List[Literal["backend", "region", "count"]]] = Field(
@@ -56,7 +56,7 @@ class GpuGroup(CoreModel):
     region: Optional[str] = None
 
 
-class RunGpusResponse(CoreModel):
+class ListGpusResponse(CoreModel):
     """Response containing GPU specifications."""
 
     gpus: List[GpuGroup] = Field(

src/dstack/_internal/server/services/gpus.py

@@ -12,7 +12,7 @@
     BackendGpu,
     BackendGpus,
     GpuGroup,
-    RunGpusResponse,
+    ListGpusResponse,
 )
 from dstack._internal.server.services.offers import get_offers_by_requirements
 
@@ -354,12 +354,12 @@ def _get_gpus_grouped_by_backend_region_and_count(
     )
 
 
-async def get_run_gpus_grouped(
+async def list_gpus_grouped(
     session: AsyncSession,
     project: ProjectModel,
     run_spec: RunSpec,
     group_by: Optional[List[Literal["backend", "region", "count"]]] = None,
-) -> RunGpusResponse:
+) -> ListGpusResponse:
     """Retrieves available GPU specifications based on a run spec, with optional grouping."""
     offers = await _get_gpu_offers(session, project, run_spec)
     backend_gpus = _process_offers_into_backend_gpus(offers)
@@ -383,4 +383,4 @@ async def get_run_gpus_grouped(
     else:
         gpus = _get_gpus_with_no_grouping(backend_gpus)
 
-    return RunGpusResponse(gpus=gpus)
+    return ListGpusResponse(gpus=gpus)

src/dstack/api/server/_gpus.py

@@ -3,20 +3,20 @@
 from pydantic import parse_obj_as
 
 from dstack._internal.core.models.runs import RunSpec
-from dstack._internal.server.schemas.gpus import GetRunGpusRequest, RunGpusResponse
+from dstack._internal.server.schemas.gpus import ListGpusRequest, ListGpusResponse
 from dstack.api.server._group import APIClientGroup
 
 
 class GpusAPIClient(APIClientGroup):
-    def get_gpus(
+    def list_gpus(
         self,
         project_name: str,
         run_spec: RunSpec,
         group_by: Optional[List[str]] = None,
-    ) -> RunGpusResponse:
-        body = GetRunGpusRequest(run_spec=run_spec, group_by=group_by)
+    ) -> ListGpusResponse:
+        body = ListGpusRequest(run_spec=run_spec, group_by=group_by)
         resp = self._request(
             f"/api/project/{project_name}/gpus/list",
             body=body.json(),
         )
-        return parse_obj_as(RunGpusResponse, resp.json())
+        return parse_obj_as(ListGpusResponse, resp.json())

src/tests/_internal/server/routers/test_gpus.py

@@ -109,7 +109,7 @@ async def call_gpus_api(
     )
 
 
-class TestGetRunGpus:
+class TestListGpus:
     @pytest.mark.asyncio
     @pytest.mark.parametrize("test_db", ["sqlite", "postgres"], indirect=True)
     async def test_returns_403_if_not_project_member(