compose-api-client 0.1.8__tar.gz → 0.2.0__tar.gz

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compose-api-client
-Version: 0.1.8
+Version: 0.2.0
 Summary: Add your description here
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

compose_api_client-0.2.0/compose_api_client/api/results/get_simulations_status_batch.py

@@ -0,0 +1,168 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.hpc_run import HpcRun
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: list[int],
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/results/simulations/status/batch",
+    }
+
+    _kwargs["json"] = body
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[HTTPValidationError, list["HpcRun"]]]:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in _response_200:
+            response_200_item = HpcRun.from_dict(response_200_item_data)
+
+            response_200.append(response_200_item)
+
+        return response_200
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[HTTPValidationError, list["HpcRun"]]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: list[int],
+) -> Response[Union[HTTPValidationError, list["HpcRun"]]]:
+    """Get simulation status records for a list of IDs
+
+    Args:
+        body (list[int]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, list['HpcRun']]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: list[int],
+) -> Optional[Union[HTTPValidationError, list["HpcRun"]]]:
+    """Get simulation status records for a list of IDs
+
+    Args:
+        body (list[int]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, list['HpcRun']]
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: list[int],
+) -> Response[Union[HTTPValidationError, list["HpcRun"]]]:
+    """Get simulation status records for a list of IDs
+
+    Args:
+        body (list[int]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[HTTPValidationError, list['HpcRun']]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: list[int],
+) -> Optional[Union[HTTPValidationError, list["HpcRun"]]]:
+    """Get simulation status records for a list of IDs
+
+    Args:
+        body (list[int]):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[HTTPValidationError, list['HpcRun']]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/compose_api_client/api/simulation/run_simulation.py

@@ -15,6 +15,7 @@ def _get_kwargs(
     *,
     body: BodyRunSimulation,
     interval_time: Union[Unset, float] = 1.0,
+    batch_submission: Union[Unset, bool] = False,
 ) -> dict[str, Any]:
     headers: dict[str, Any] = {}
 
@@ -22,6 +23,8 @@ def _get_kwargs(
 
     params["interval_time"] = interval_time
 
+    params["batch_submission"] = batch_submission
+
     params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
 
     _kwargs: dict[str, Any] = {
@@ -69,11 +72,13 @@ def sync_detailed(
     client: Union[AuthenticatedClient, Client],
     body: BodyRunSimulation,
     interval_time: Union[Unset, float] = 1.0,
+    batch_submission: Union[Unset, bool] = False,
 ) -> Response[Union[HTTPValidationError, SimulationExperiment]]:
     """Run a simulation
 
     Args:
         interval_time (Union[Unset, float]):  Default: 1.0.
+        batch_submission (Union[Unset, bool]):  Default: False.
         body (BodyRunSimulation):
 
     Raises:
@@ -87,6 +92,7 @@ def sync_detailed(
     kwargs = _get_kwargs(
         body=body,
         interval_time=interval_time,
+        batch_submission=batch_submission,
     )
 
     response = client.get_httpx_client().request(
@@ -101,11 +107,13 @@ def sync(
     client: Union[AuthenticatedClient, Client],
     body: BodyRunSimulation,
     interval_time: Union[Unset, float] = 1.0,
+    batch_submission: Union[Unset, bool] = False,
 ) -> Optional[Union[HTTPValidationError, SimulationExperiment]]:
     """Run a simulation
 
     Args:
         interval_time (Union[Unset, float]):  Default: 1.0.
+        batch_submission (Union[Unset, bool]):  Default: False.
         body (BodyRunSimulation):
 
     Raises:
@@ -120,6 +128,7 @@ def sync(
         client=client,
         body=body,
         interval_time=interval_time,
+        batch_submission=batch_submission,
     ).parsed
 
 
@@ -128,11 +137,13 @@ async def asyncio_detailed(
     client: Union[AuthenticatedClient, Client],
     body: BodyRunSimulation,
     interval_time: Union[Unset, float] = 1.0,
+    batch_submission: Union[Unset, bool] = False,
 ) -> Response[Union[HTTPValidationError, SimulationExperiment]]:
     """Run a simulation
 
     Args:
         interval_time (Union[Unset, float]):  Default: 1.0.
+        batch_submission (Union[Unset, bool]):  Default: False.
         body (BodyRunSimulation):
 
     Raises:
@@ -146,6 +157,7 @@ async def asyncio_detailed(
     kwargs = _get_kwargs(
         body=body,
         interval_time=interval_time,
+        batch_submission=batch_submission,
     )
 
     response = await client.get_async_httpx_client().request(**kwargs)
@@ -158,11 +170,13 @@ async def asyncio(
     client: Union[AuthenticatedClient, Client],
     body: BodyRunSimulation,
     interval_time: Union[Unset, float] = 1.0,
+    batch_submission: Union[Unset, bool] = False,
 ) -> Optional[Union[HTTPValidationError, SimulationExperiment]]:
     """Run a simulation
 
     Args:
         interval_time (Union[Unset, float]):  Default: 1.0.
+        batch_submission (Union[Unset, bool]):  Default: False.
         body (BodyRunSimulation):
 
     Raises:
@@ -178,5 +192,6 @@ async def asyncio(
             client=client,
             body=body,
             interval_time=interval_time,
+            batch_submission=batch_submission,
         )
     ).parsed

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/compose_api_client/models/job_status.py

@@ -2,11 +2,16 @@ from enum import Enum
 
 
 class JobStatus(str, Enum):
+    CANCELLED = "cancelled"
     COMPLETED = "completed"
     FAILED = "failed"
+    OUT_OF_MEMORY = "out_of_memory"
     PENDING = "pending"
     QUEUED = "queued"
     RUNNING = "running"
+    SUSPENDED = "suspended"
+    TIMEOUT = "timeout"
+    UNKNOWN = "unknown"
     WAITING = "waiting"
 
     def __str__(self) -> str:

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/compose_api_client/utils/run_simulation_and_wait.py

@@ -1,5 +1,5 @@
 import asyncio
-from typing import Any, Tuple
+from typing import Tuple
 
 from compose_api_client import Client
 from compose_api_client.api.results import (
@@ -57,7 +57,9 @@ async def async_call(
     while current_status is None and num_loops < loops_to_wait:
         print("Waiting for simulation to be submitted to slurm.")
         await asyncio.sleep(sleep_interval)
-        current_status = await _get_current_status(client, sim_experiment.simulation_database_id)
+        current_status = await _get_current_status(
+            client, sim_experiment.simulation_database_id
+        )
         num_loops += 1
 
     if current_status is None:
@@ -74,8 +76,14 @@ async def async_call(
         )
         num_loops += 1
 
-        if current_status.status == JobStatus.FAILED:
-            raise RuntimeError(f"Simulation failed: {current_status}")
+        incomplete_statuses = {
+            JobStatus.FAILED,
+            JobStatus.CANCELLED,
+            JobStatus.TIMEOUT,
+            JobStatus.OUT_OF_MEMORY,
+        }
+        if current_status.status in incomplete_statuses:
+            raise RuntimeError(f"Simulation stopped with status: {current_status}")
 
         print(
             f"Waited {num_loops * sleep_interval} seconds for simulation to complete. Current status: {current_status}"
@@ -93,7 +101,7 @@ async def async_call(
         client=client, simulation_id=sim_experiment.simulation_database_id
     )
 
-    print(f"Simulation has completed.")
+    print("Simulation has completed.")
 
     if results.status_code != 200:
         raise RuntimeError(f"Could not get simulation results: {results}")

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/compose_api_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compose-api-client
-Version: 0.1.8
+Version: 0.2.0
 Summary: Add your description here
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/compose_api_client.egg-info/SOURCES.txt

@@ -23,6 +23,7 @@ compose_api_client/api/curated/run_tellurium.py
 compose_api_client/api/results/__init__.py
 compose_api_client/api/results/get_simulation_results_file.py
 compose_api_client/api/results/get_simulation_status.py
+compose_api_client/api/results/get_simulations_status_batch.py
 compose_api_client/api/results/get_simulator_build_status.py
 compose_api_client/api/simulation/__init__.py
 compose_api_client/api/simulation/run_simulation.py

{compose_api_client-0.1.8 → compose_api_client-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "compose-api-client"
-version = "0.1.8"
+version = "0.2.0"
 description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -14,4 +14,6 @@ dependencies = [
 dev = [
     "deptry>=0.23.0,<0.24",
     "pre-commit>=3.4.0,<4",
+    "pytest",
+    "pytest-asyncio"
 ]