refactor: more verbose method names

Author: tamirse

datacrunch/containers/containers.py

@@ -63,13 +63,13 @@ class EntrypointOverridesSettings:
 class EnvVar:
     name: str
     value_or_reference_to_secret: str
-    type: EnvVarType  # "plain" or "secret"
+    type: EnvVarType
 
 
 @dataclass_json
 @dataclass
 class VolumeMount:
-    type: VolumeMountType  # "scratch" or "secret"
+    type: VolumeMountType
     mount_path: str
 
 
@@ -220,7 +220,7 @@ def __init__(self, http_client) -> None:
         """
         self.client = http_client
 
-    def get(self) -> List[Deployment]:
+    def get_deployments(self) -> List[Deployment]:
         """Get all deployments
 
         :return: list of deployments
@@ -229,7 +229,7 @@ def get(self) -> List[Deployment]:
         response = self.client.get(CONTAINER_DEPLOYMENTS_ENDPOINT)
         return [Deployment.from_dict(deployment, infer_missing=True) for deployment in response.json()]
 
-    def get_by_name(self, deployment_name: str) -> Deployment:
+    def get_deployment_by_name(self, deployment_name: str) -> Deployment:
         """Get a deployment by name
 
         :param deployment_name: name of the deployment
@@ -241,7 +241,7 @@ def get_by_name(self, deployment_name: str) -> Deployment:
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}")
         return Deployment.from_dict(response.json(), infer_missing=True)
 
-    def create(
+    def create_deployment(
         self,
         deployment: Deployment
     ) -> Deployment:
@@ -258,7 +258,7 @@ def create(
         )
         return Deployment.from_dict(response.json(), infer_missing=True)
 
-    def update(self, deployment_name: str, deployment: Deployment) -> Deployment:
+    def update_deployment(self, deployment_name: str, deployment: Deployment) -> Deployment:
         """Update an existing deployment
 
         :param deployment_name: name of the deployment to update
@@ -274,7 +274,7 @@ def update(self, deployment_name: str, deployment: Deployment) -> Deployment:
         )
         return Deployment.from_dict(response.json(), infer_missing=True)
 
-    def delete(self, deployment_name: str) -> None:
+    def delete_deployment(self, deployment_name: str) -> None:
         """Delete a deployment
 
         :param deployment_name: name of the deployment to delete
@@ -283,7 +283,7 @@ def delete(self, deployment_name: str) -> None:
         self.client.delete(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}")
 
-    def get_status(self, deployment_name: str) -> ContainerDeploymentStatus:
+    def get_deployment_status(self, deployment_name: str) -> ContainerDeploymentStatus:
         """Get deployment status
 
         :param deployment_name: name of the deployment
@@ -295,7 +295,7 @@ def get_status(self, deployment_name: str) -> ContainerDeploymentStatus:
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/status")
         return ContainerDeploymentStatus(response.json()["status"])
 
-    def restart(self, deployment_name: str) -> None:
+    def restart_deployment(self, deployment_name: str) -> None:
         """Restart a deployment
 
         :param deployment_name: name of the deployment to restart
@@ -304,7 +304,7 @@ def restart(self, deployment_name: str) -> None:
         self.client.post(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/restart")
 
-    def get_scaling_options(self, deployment_name: str) -> ScalingOptions:
+    def get_deployment_scaling_options(self, deployment_name: str) -> ScalingOptions:
         """Get deployment scaling options
 
         :param deployment_name: name of the deployment
@@ -316,7 +316,7 @@ def get_scaling_options(self, deployment_name: str) -> ScalingOptions:
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/scaling")
         return ScalingOptions.from_dict(response.json())
 
-    def update_scaling_options(self, deployment_name: str, scaling_options: ScalingOptions) -> ScalingOptions:
+    def update_deployment_scaling_options(self, deployment_name: str, scaling_options: ScalingOptions) -> ScalingOptions:
         """Update deployment scaling options
 
         :param deployment_name: name of the deployment
@@ -332,7 +332,7 @@ def update_scaling_options(self, deployment_name: str, scaling_options: ScalingO
         )
         return ScalingOptions.from_dict(response.json())
 
-    def get_replicas(self, deployment_name: str) -> Dict:
+    def get_deployment_replicas(self, deployment_name: str) -> Dict:
         """Get deployment replicas
 
         :param deployment_name: name of the deployment
@@ -344,7 +344,7 @@ def get_replicas(self, deployment_name: str) -> Dict:
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/replicas")
         return response.json()
 
-    def purge_queue(self, deployment_name: str) -> None:
+    def purge_deployment_queue(self, deployment_name: str) -> None:
         """Purge deployment queue
 
         :param deployment_name: name of the deployment
@@ -353,7 +353,7 @@ def purge_queue(self, deployment_name: str) -> None:
         self.client.post(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/purge-queue")
 
-    def pause(self, deployment_name: str) -> None:
+    def pause_deployment(self, deployment_name: str) -> None:
         """Pause a deployment
 
         :param deployment_name: name of the deployment to pause
@@ -362,7 +362,7 @@ def pause(self, deployment_name: str) -> None:
         self.client.post(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/pause")
 
-    def resume(self, deployment_name: str) -> None:
+    def resume_deployment(self, deployment_name: str) -> None:
         """Resume a deployment
 
         :param deployment_name: name of the deployment to resume
@@ -371,7 +371,7 @@ def resume(self, deployment_name: str) -> None:
         self.client.post(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/resume")
 
-    def get_environment_variables(self, deployment_name: str) -> Dict:
+    def get_deployment_environment_variables(self, deployment_name: str) -> Dict:
         """Get deployment environment variables
 
         :param deployment_name: name of the deployment
@@ -383,7 +383,7 @@ def get_environment_variables(self, deployment_name: str) -> Dict:
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables")
         return response.json()
 
-    def add_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[Dict]) -> Dict:
+    def add_deployment_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[Dict]) -> Dict:
         """Add environment variables to a container
 
         :param deployment_name: name of the deployment
@@ -401,7 +401,7 @@ def add_environment_variables(self, deployment_name: str, container_name: str, e
         )
         return response.json()
 
-    def update_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[Dict]) -> Dict:
+    def update_deployment_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[Dict]) -> Dict:
         """Update environment variables of a container
 
         :param deployment_name: name of the deployment
@@ -419,7 +419,7 @@ def update_environment_variables(self, deployment_name: str, container_name: str
         )
         return response.json()
 
-    def delete_environment_variables(self, deployment_name: str, container_name: str, env_var_names: List[str]) -> Dict:
+    def delete_deployment_environment_variables(self, deployment_name: str, container_name: str, env_var_names: List[str]) -> Dict:
         """Delete environment variables from a container
 
         :param deployment_name: name of the deployment

examples/containers/container_deployments.py

@@ -52,7 +52,7 @@ def wait_for_deployment_health(client: DataCrunchClient, deployment_name: str, m
     """
     for attempt in range(max_attempts):
         try:
-            status = client.containers.get_status(deployment_name)
+            status = client.containers.get_deployment_status(deployment_name)
             print(f"Deployment status: {status}")
             if status == ContainerDeploymentStatus.HEALTHY:
                 return True
@@ -71,7 +71,7 @@ def cleanup_resources(client: DataCrunchClient) -> None:
     """
     try:
         # Delete deployment
-        client.containers.delete(DEPLOYMENT_NAME)
+        client.containers.delete_deployment(DEPLOYMENT_NAME)
         print("Deployment deleted")
     except APIException as e:
         print(f"Error during cleanup: {e}")
@@ -145,7 +145,8 @@ def main() -> None:
         )
 
         # Create the deployment
-        created_deployment = datacrunch_client.containers.create(deployment)
+        created_deployment = datacrunch_client.containers.create_deployment(
+            deployment)
         print(f"Created deployment: {created_deployment.name}")
 
         # Wait for deployment to be healthy
@@ -156,7 +157,7 @@ def main() -> None:
 
         # Update scaling configuration
         try:
-            deployment = datacrunch_client.containers.get_by_name(
+            deployment = datacrunch_client.containers.get_deployment_by_name(
                 DEPLOYMENT_NAME)
             # Create new scaling options with increased replica counts
             deployment.scaling = ScalingOptions(
@@ -178,7 +179,7 @@ def main() -> None:
                     )
                 )
             )
-            updated_deployment = datacrunch_client.containers.update(
+            updated_deployment = datacrunch_client.containers.update_deployment(
                 DEPLOYMENT_NAME, deployment)
             print(f"Updated deployment scaling: {updated_deployment.name}")
         except APIException as e:
@@ -187,20 +188,21 @@ def main() -> None:
         # Demonstrate deployment operations
         try:
             # Pause deployment
-            datacrunch_client.containers.pause(DEPLOYMENT_NAME)
+            datacrunch_client.containers.pause_deployment(DEPLOYMENT_NAME)
             print("Deployment paused")
             time.sleep(60)
 
             # Resume deployment
-            datacrunch_client.containers.resume(DEPLOYMENT_NAME)
+            datacrunch_client.containers.resume_deployment(DEPLOYMENT_NAME)
             print("Deployment resumed")
 
             # Restart deployment
-            datacrunch_client.containers.restart(DEPLOYMENT_NAME)
+            datacrunch_client.containers.restart_deployment(DEPLOYMENT_NAME)
             print("Deployment restarted")
 
             # Purge queue
-            datacrunch_client.containers.purge_queue(DEPLOYMENT_NAME)
+            datacrunch_client.containers.purge_deployment_queue(
+                DEPLOYMENT_NAME)
             print("Queue purged")
         except APIException as e:
             print(f"Error in deployment operations: {e}")

examples/containers/registry_credentials_example.py

@@ -54,10 +54,10 @@
 datacrunch_client.containers.add_registry_credentials(
     name="my-aws-ecr-creds",
     registry_type=ContainerRegistryType.AWS_ECR,
-    access_key_id="your-aws-access-key-id",
-    secret_access_key="your-aws-secret-access-key",
-    region="us-west-2",
-    ecr_repo="123456789012.dkr.ecr.us-west-2.amazonaws.com"
+    access_key_id="AKIAEXAMPLE123456",
+    secret_access_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+    region="eu-north-1",
+    ecr_repo="887841266746.dkr.ecr.eu-north-1.amazonaws.com"
 )
 print("Created AWS ECR credentials")
 

examples/containers/sglang_deployment.py

@@ -47,7 +47,7 @@
 datacrunch_client = None
 
 
-def wait_for_deployment_health(client: DataCrunchClient, deployment_name: str, max_attempts: int = 20, delay: int = 30) -> bool:
+def wait_for_deployment_health(datacrunch_client: DataCrunchClient, deployment_name: str, max_attempts: int = 20, delay: int = 30) -> bool:
     """Wait for deployment to reach healthy status.
 
     Args:
@@ -62,7 +62,8 @@ def wait_for_deployment_health(client: DataCrunchClient, deployment_name: str, m
     print(f"Waiting for deployment to be healthy (may take several minutes to download model)...")
     for attempt in range(max_attempts):
         try:
-            status = client.containers.get_status(deployment_name)
+            status = datacrunch_client.containers.get_deployment_status(
+                deployment_name)
             print(
                 f"Attempt {attempt+1}/{max_attempts} - Deployment status: {status}")
             if status == ContainerDeploymentStatus.HEALTHY:
@@ -74,15 +75,15 @@ def wait_for_deployment_health(client: DataCrunchClient, deployment_name: str, m
     return False
 
 
-def cleanup_resources(client: DataCrunchClient) -> None:
+def cleanup_resources(datacrunch_client: DataCrunchClient) -> None:
     """Clean up all created resources.
 
     Args:
         client: DataCrunchAPI client
     """
     try:
         # Delete deployment
-        client.containers.delete(DEPLOYMENT_NAME)
+        datacrunch_client.containers.delete_deployment(DEPLOYMENT_NAME)
         print("Deployment deleted")
     except APIException as e:
         print(f"Error during cleanup: {e}")

examples/containers/update_deployment_scaling.py

@@ -34,7 +34,7 @@ def check_deployment_exists(client: DataCrunchClient, deployment_name: str) -> b
         bool: True if deployment exists, False otherwise
     """
     try:
-        client.containers.get_by_name(deployment_name)
+        client.containers.get_deployment_by_name(deployment_name)
         return True
     except APIException as e:
         print(f"Error: {e}")
@@ -71,7 +71,7 @@ def update_deployment_scaling(client: DataCrunchClient, deployment_name: str) ->
         )
 
         # Update scaling options
-        updated_options = client.containers.update_scaling_options(
+        updated_options = client.containers.update_deployment_scaling_options(
             deployment_name, scaling_options)
         print(f"Updated deployment scaling options")
         print(f"New min replicas: {updated_options.min_replica_count}")
@@ -106,7 +106,7 @@ def main() -> None:
         update_deployment_scaling(datacrunch_client, DEPLOYMENT_NAME)
 
         # Get current scaling options
-        scaling_options = datacrunch_client.containers.get_scaling_options(
+        scaling_options = datacrunch_client.containers.get_deployment_scaling_options(
             DEPLOYMENT_NAME)
         print(f"\nCurrent scaling configuration:")
         print(f"Min replicas: {scaling_options.min_replica_count}")