removed custom instance str func, wait for provisioning status on create

Author: tamirse

datacrunch/instances/instances.py

@@ -1,8 +1,8 @@
+import time
 from typing import List, Union, Optional, Dict, Literal
 from dataclasses import dataclass
 from dataclasses_json import dataclass_json
-from datacrunch.helpers import stringify_class_object_properties
-from datacrunch.constants import Locations
+from datacrunch.constants import Locations, InstanceStatus
 
 INSTANCES_ENDPOINT = '/instances'
 
@@ -21,16 +21,16 @@ class Instance:
         price_per_hour: Cost per hour of running the instance.
         hostname: Network hostname of the instance.
         description: Human-readable description of the instance.
-        ip: IP address assigned to the instance.
         status: Current operational status of the instance.
         created_at: Timestamp of instance creation.
         ssh_key_ids: List of SSH key IDs associated with the instance.
         cpu: CPU configuration details.
         gpu: GPU configuration details.
         memory: Memory configuration details.
         storage: Storage configuration details.
-        os_volume_id: ID of the operating system volume.
         gpu_memory: GPU memory configuration details.
+        ip: IP address assigned to the instance.
+        os_volume_id: ID of the operating system volume.
         location: Datacenter location code (default: Locations.FIN_01).
         image: Image ID or type used for the instance.
         startup_script_id: ID of the startup script to run.
@@ -44,31 +44,25 @@ class Instance:
     price_per_hour: float
     hostname: str
     description: str
-    ip: str
     status: str
     created_at: str
     ssh_key_ids: List[str]
     cpu: dict
     gpu: dict
     memory: dict
     storage: dict
-    os_volume_id: str
     gpu_memory: dict
+    # Can be None if instance is still not provisioned
+    ip: Optional[str] = None
+    # Can be None if instance is still not provisioned
+    os_volume_id: Optional[str] = None
     location: str = Locations.FIN_01
     image: Optional[str] = None
     startup_script_id: Optional[str] = None
     is_spot: bool = False
     contract: Optional[Contract] = None
     pricing: Optional[Pricing] = None
 
-    def __str__(self) -> str:
-        """Returns a JSON string representation of the instance.
-
-        Returns:
-            JSON string containing all instance properties.
-        """
-        return stringify_class_object_properties(self)
-
 
 class InstancesService:
     """Service for managing cloud instances through the API.
@@ -173,7 +167,22 @@ def create(self,
         if pricing:
             payload['pricing'] = pricing
         id = self._http_client.post(INSTANCES_ENDPOINT, json=payload).text
-        return self.get_by_id(id)
+
+        # Wait for instance to enter provisioning state with timeout
+        MAX_WAIT_TIME = 60  # Maximum wait time in seconds
+        POLL_INTERVAL = 0.5  # Time between status checks
+
+        start_time = time.time()
+        while True:
+            instance = self.get_by_id(id)
+            if instance.status == InstanceStatus.PROVISIONING:
+                return instance
+
+            if time.time() - start_time > MAX_WAIT_TIME:
+                raise TimeoutError(
+                    f"Instance {id} did not enter provisioning state within {MAX_WAIT_TIME} seconds")
+
+            time.sleep(POLL_INTERVAL)
 
     def action(self, id_list: Union[List[str], str], action: str, volume_ids: Optional[List[str]] = None) -> None:
         """Performs an action on one or more instances.

examples/simple_create_instance.py

@@ -1,5 +1,7 @@
+import time
 import os
 from datacrunch import DataCrunchClient
+from datacrunch.constants import Locations, InstanceStatus
 
 # Get client secret and id from environment variables
 DATACRUNCH_CLIENT_ID = os.environ.get('DATACRUNCH_CLIENT_ID')
@@ -14,11 +16,19 @@
 
 # Create a new instance
 instance = datacrunch.instances.create(instance_type='1V100.6V',
-                                       image='ubuntu-24.04-cuda-12.8-open-docker',
+                                       image='ubuntu-22.04-cuda-12.0-docker',
+                                       location=Locations.FIN_01,
                                        ssh_key_ids=ssh_keys_ids,
                                        hostname='example',
                                        description='example instance')
 
+# Wait for instance to enter running state
+while instance.status != InstanceStatus.RUNNING:
+    time.sleep(0.5)
+    instance = datacrunch.instances.get_by_id(instance.id)
+
+print(instance)
+
 # Delete instance
 datacrunch.instances.action(
     instance.id, datacrunch.constants.instance_actions.DELETE)