Reformat for pre-commit checks

Author: ChristianZaccaria

src/codeflare_sdk.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

src/codeflare_sdk/cluster/cluster.py

@@ -870,10 +870,12 @@ def _map_to_ray_cluster(rc) -> Optional[RayCluster]:
         worker_mem_requests=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"][
             "containers"
         ][0]["resources"]["requests"]["memory"],
-        worker_cpu_requests=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"]["containers"][0]["resources"]["requests"]["cpu"],
-        worker_cpu_limits=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"]["containers"][
-            0
-        ]["resources"]["limits"]["cpu"],
+        worker_cpu_requests=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"][
+            "containers"
+        ][0]["resources"]["requests"]["cpu"],
+        worker_cpu_limits=rc["spec"]["workerGroupSpecs"][0]["template"]["spec"][
+            "containers"
+        ][0]["resources"]["limits"]["cpu"],
         worker_extended_resources=worker_extended_resources,
         namespace=rc["metadata"]["namespace"],
         head_cpu_requests=rc["spec"]["headGroupSpec"]["template"]["spec"]["containers"][

src/codeflare_sdk/cluster/widgets.py

@@ -107,10 +107,13 @@ def view_clusters(namespace: str = None):
     view_clusters function will display existing clusters with their specs, and handle user interactions.
     """
     if not is_notebook():
-        warnings.warn("view_clusters can only be used in a Jupyter Notebook environment.")
-        return # Exit function if not in Jupyter Notebook
+        warnings.warn(
+            "view_clusters can only be used in a Jupyter Notebook environment."
+        )
+        return  # Exit function if not in Jupyter Notebook
 
     from .cluster import get_current_namespace
+
     if not namespace:
         namespace = get_current_namespace()
 
@@ -124,42 +127,76 @@ def view_clusters(namespace: str = None):
         return
 
     classification_widget = widgets.ToggleButtons(
-        options=ray_clusters_df["Name"].tolist(), value=ray_clusters_df["Name"].tolist()[0],
-        description='Select an existing cluster:',
+        options=ray_clusters_df["Name"].tolist(),
+        value=ray_clusters_df["Name"].tolist()[0],
+        description="Select an existing cluster:",
     )
     # Setting the initial value to trigger the event handler to display the cluster details.
     initial_value = classification_widget.value
-    _on_cluster_click({"new": initial_value}, raycluster_data_output, namespace, classification_widget)
-    classification_widget.observe(lambda selection_change: _on_cluster_click(selection_change, raycluster_data_output, namespace, classification_widget), names="value")
+    _on_cluster_click(
+        {"new": initial_value}, raycluster_data_output, namespace, classification_widget
+    )
+    classification_widget.observe(
+        lambda selection_change: _on_cluster_click(
+            selection_change, raycluster_data_output, namespace, classification_widget
+        ),
+        names="value",
+    )
 
     # UI table buttons
     delete_button = widgets.Button(
-                description='Delete Cluster',
-                icon='trash',
-                tooltip="Delete the selected cluster"
-            )
-    delete_button.on_click(lambda b: _on_delete_button_click(b, classification_widget, ray_clusters_df, raycluster_data_output, user_output, delete_button, list_jobs_button, ray_dashboard_button))
+        description="Delete Cluster",
+        icon="trash",
+        tooltip="Delete the selected cluster",
+    )
+    delete_button.on_click(
+        lambda b: _on_delete_button_click(
+            b,
+            classification_widget,
+            ray_clusters_df,
+            raycluster_data_output,
+            user_output,
+            delete_button,
+            list_jobs_button,
+            ray_dashboard_button,
+        )
+    )
 
     list_jobs_button = widgets.Button(
-                description='View Jobs',
-                icon='suitcase',
-                tooltip="Open the Ray Job Dashboard"
-            )
-    list_jobs_button.on_click(lambda b: _on_list_jobs_button_click(b, classification_widget, ray_clusters_df, user_output, url_output))
+        description="View Jobs", icon="suitcase", tooltip="Open the Ray Job Dashboard"
+    )
+    list_jobs_button.on_click(
+        lambda b: _on_list_jobs_button_click(
+            b, classification_widget, ray_clusters_df, user_output, url_output
+        )
+    )
 
     ray_dashboard_button = widgets.Button(
-                description='Open Ray Dashboard',
-                icon='dashboard',
-                tooltip="Open the Ray Dashboard in a new tab",
-                layout=widgets.Layout(width='auto'),
-            )
-    ray_dashboard_button.on_click(lambda b: _on_ray_dashboard_button_click(b, classification_widget, ray_clusters_df, user_output, url_output))
+        description="Open Ray Dashboard",
+        icon="dashboard",
+        tooltip="Open the Ray Dashboard in a new tab",
+        layout=widgets.Layout(width="auto"),
+    )
+    ray_dashboard_button.on_click(
+        lambda b: _on_ray_dashboard_button_click(
+            b, classification_widget, ray_clusters_df, user_output, url_output
+        )
+    )
 
     display(widgets.VBox([classification_widget, raycluster_data_output]))
-    display(widgets.HBox([delete_button, list_jobs_button, ray_dashboard_button]), url_output, user_output)
+    display(
+        widgets.HBox([delete_button, list_jobs_button, ray_dashboard_button]),
+        url_output,
+        user_output,
+    )
 
 
-def _on_cluster_click(selection_change, raycluster_data_output: widgets.Output, namespace: str, classification_widget: widgets.ToggleButtons):
+def _on_cluster_click(
+    selection_change,
+    raycluster_data_output: widgets.Output,
+    namespace: str,
+    classification_widget: widgets.ToggleButtons,
+):
     """
     _on_cluster_click handles the event when a cluster is selected from the toggle buttons, updating the output with cluster details.
     """
@@ -168,21 +205,51 @@ def _on_cluster_click(selection_change, raycluster_data_output: widgets.Output,
     ray_clusters_df = _fetch_cluster_data(namespace)
     classification_widget.options = ray_clusters_df["Name"].tolist()
     with raycluster_data_output:
-        display(HTML(ray_clusters_df[ray_clusters_df["Name"]==new_value][["Name", "Namespace", "Num Workers", "Head GPUs", "Head CPU Req~Lim", "Head Memory Req~Lim", "Worker GPUs", "Worker CPU Req~Lim", "Worker Memory Req~Lim", "status"]].to_html(escape=False, index=False, border=2)))
-
-
-def _on_delete_button_click(b, classification_widget: widgets.ToggleButtons, ray_clusters_df: pd.DataFrame, raycluster_data_output: widgets.Output, user_output: widgets.Output, delete_button: widgets.Button, list_jobs_button: widgets.Button, ray_dashboard_button: widgets.Button):
+        display(
+            HTML(
+                ray_clusters_df[ray_clusters_df["Name"] == new_value][
+                    [
+                        "Name",
+                        "Namespace",
+                        "Num Workers",
+                        "Head GPUs",
+                        "Head CPU Req~Lim",
+                        "Head Memory Req~Lim",
+                        "Worker GPUs",
+                        "Worker CPU Req~Lim",
+                        "Worker Memory Req~Lim",
+                        "status",
+                    ]
+                ].to_html(escape=False, index=False, border=2)
+            )
+        )
+
+
+def _on_delete_button_click(
+    b,
+    classification_widget: widgets.ToggleButtons,
+    ray_clusters_df: pd.DataFrame,
+    raycluster_data_output: widgets.Output,
+    user_output: widgets.Output,
+    delete_button: widgets.Button,
+    list_jobs_button: widgets.Button,
+    ray_dashboard_button: widgets.Button,
+):
     """
     _on_delete_button_click handles the event when the Delete Button is clicked, deleting the selected cluster.
     """
     cluster_name = classification_widget.value
-    namespace = ray_clusters_df[ray_clusters_df["Name"]==classification_widget.value]["Namespace"].values[0]
+    namespace = ray_clusters_df[ray_clusters_df["Name"] == classification_widget.value][
+        "Namespace"
+    ].values[0]
 
     _delete_cluster(cluster_name, namespace)
 
     with user_output:
         user_output.clear_output()
-        print(f"Cluster {cluster_name} in the {namespace} namespace was deleted successfully.")
+        print(
+            f"Cluster {cluster_name} in the {namespace} namespace was deleted successfully."
+        )
 
     # Refresh the dataframe
     new_df = _fetch_cluster_data(namespace)
@@ -197,16 +264,28 @@ def _on_delete_button_click(b, classification_widget: widgets.ToggleButtons, ray
     else:
         classification_widget.options = new_df["Name"].tolist()
 
-def _on_ray_dashboard_button_click(b, classification_widget: widgets.ToggleButtons, ray_clusters_df: pd.DataFrame, user_output: widgets.Output, url_output: widgets.Output):
+
+def _on_ray_dashboard_button_click(
+    b,
+    classification_widget: widgets.ToggleButtons,
+    ray_clusters_df: pd.DataFrame,
+    user_output: widgets.Output,
+    url_output: widgets.Output,
+):
     """
     _on_ray_dashboard_button_click handles the event when the Open Ray Dashboard button is clicked, opening the Ray Dashboard in a new tab
     """
     from codeflare_sdk.cluster import Cluster
+
     cluster_name = classification_widget.value
-    namespace = ray_clusters_df[ray_clusters_df["Name"]==classification_widget.value]["Namespace"].values[0]
+    namespace = ray_clusters_df[ray_clusters_df["Name"] == classification_widget.value][
+        "Namespace"
+    ].values[0]
 
     # Suppress from Cluster Object initialisation widgets and outputs
-    with widgets.Output(), contextlib.redirect_stdout(io.StringIO()), contextlib.redirect_stderr(io.StringIO()):
+    with widgets.Output(), contextlib.redirect_stdout(
+        io.StringIO()
+    ), contextlib.redirect_stderr(io.StringIO()):
         cluster = Cluster(ClusterConfiguration(cluster_name, namespace))
     dashboard_url = cluster.cluster_dashboard_uri()
 
@@ -216,22 +295,36 @@ def _on_ray_dashboard_button_click(b, classification_widget: widgets.ToggleButto
     with url_output:
         display(Javascript(f'window.open("{dashboard_url}", "_blank");'))
 
-def _on_list_jobs_button_click(b, classification_widget: widgets.ToggleButtons, ray_clusters_df: pd.DataFrame, user_output: widgets.Output, url_output: widgets.Output):
+
+def _on_list_jobs_button_click(
+    b,
+    classification_widget: widgets.ToggleButtons,
+    ray_clusters_df: pd.DataFrame,
+    user_output: widgets.Output,
+    url_output: widgets.Output,
+):
     """
     _on_list_jobs_button_click handles the event when the View Jobs button is clicked, opening the Ray Jobs Dashboard in a new tab
     """
     from codeflare_sdk.cluster import Cluster
+
     cluster_name = classification_widget.value
-    namespace = ray_clusters_df[ray_clusters_df["Name"]==classification_widget.value]["Namespace"].values[0]
+    namespace = ray_clusters_df[ray_clusters_df["Name"] == classification_widget.value][
+        "Namespace"
+    ].values[0]
 
     # Suppress from Cluster Object initialisation widgets and outputs
-    with widgets.Output(), contextlib.redirect_stdout(io.StringIO()), contextlib.redirect_stderr(io.StringIO()):
+    with widgets.Output(), contextlib.redirect_stdout(
+        io.StringIO()
+    ), contextlib.redirect_stderr(io.StringIO()):
         cluster = Cluster(ClusterConfiguration(cluster_name, namespace))
     dashboard_url = cluster.cluster_dashboard_uri()
 
     with user_output:
         user_output.clear_output()
-        print(f"Opening Ray Jobs Dashboard for {cluster_name} cluster:\n{dashboard_url}/#/jobs")
+        print(
+            f"Opening Ray Jobs Dashboard for {cluster_name} cluster:\n{dashboard_url}/#/jobs"
+        )
     with url_output:
         display(Javascript(f'window.open("{dashboard_url}/#/jobs", "_blank");'))
 
@@ -289,12 +382,14 @@ def _delete_cluster(
                 time.sleep(interval)
                 timeout -= interval
                 if timeout <= 0:
-                    raise TimeoutError(f"Timeout waiting for {cluster_name} to be deleted.")
+                    raise TimeoutError(
+                        f"Timeout waiting for {cluster_name} to be deleted."
+                    )
             except ApiException as e:
                 # Resource is deleted
                 if e.status == 404:
                     break
-    except Exception as e:
+    except Exception as e:  # pragma: no cover
         return _kube_api_error_handling(e)
 
 
@@ -303,6 +398,7 @@ def _fetch_cluster_data(namespace):
     _fetch_cluster_data function fetches all clusters and their spec in a given namespace and returns a DataFrame.
     """
     from .cluster import list_all_clusters
+
     rayclusters = list_all_clusters(namespace, False)
     if not rayclusters:
         return pd.DataFrame()
@@ -311,26 +407,58 @@ def _fetch_cluster_data(namespace):
     num_workers = [item.num_workers for item in rayclusters]
     head_extended_resources = [
         f"{list(item.head_extended_resources.keys())[0]}: {list(item.head_extended_resources.values())[0]}"
-        if item.head_extended_resources else "0"
+        if item.head_extended_resources
+        else "0"
         for item in rayclusters
     ]
     worker_extended_resources = [
         f"{list(item.worker_extended_resources.keys())[0]}: {list(item.worker_extended_resources.values())[0]}"
-        if item.worker_extended_resources else "0"
+        if item.worker_extended_resources
+        else "0"
+        for item in rayclusters
+    ]
+    head_cpu_requests = [
+        item.head_cpu_requests if item.head_cpu_requests else 0 for item in rayclusters
+    ]
+    head_cpu_limits = [
+        item.head_cpu_limits if item.head_cpu_limits else 0 for item in rayclusters
+    ]
+    head_cpu_rl = [
+        f"{requests}~{limits}"
+        for requests, limits in zip(head_cpu_requests, head_cpu_limits)
+    ]
+    head_mem_requests = [
+        item.head_mem_requests if item.head_mem_requests else 0 for item in rayclusters
+    ]
+    head_mem_limits = [
+        item.head_mem_limits if item.head_mem_limits else 0 for item in rayclusters
+    ]
+    head_mem_rl = [
+        f"{requests}~{limits}"
+        for requests, limits in zip(head_mem_requests, head_mem_limits)
+    ]
+    worker_cpu_requests = [
+        item.worker_cpu_requests if item.worker_cpu_requests else 0
+        for item in rayclusters
+    ]
+    worker_cpu_limits = [
+        item.worker_cpu_limits if item.worker_cpu_limits else 0 for item in rayclusters
+    ]
+    worker_cpu_rl = [
+        f"{requests}~{limits}"
+        for requests, limits in zip(worker_cpu_requests, worker_cpu_limits)
+    ]
+    worker_mem_requests = [
+        item.worker_mem_requests if item.worker_mem_requests else 0
         for item in rayclusters
     ]
-    head_cpu_requests = [item.head_cpu_requests if item.head_cpu_requests else 0 for item in rayclusters]
-    head_cpu_limits = [item.head_cpu_limits if item.head_cpu_limits else 0 for item in rayclusters]
-    head_cpu_rl = [f"{requests}~{limits}" for requests, limits in zip(head_cpu_requests, head_cpu_limits)]
-    head_mem_requests = [item.head_mem_requests if item.head_mem_requests else 0 for item in rayclusters]
-    head_mem_limits = [item.head_mem_limits if item.head_mem_limits else 0 for item in rayclusters]
-    head_mem_rl = [f"{requests}~{limits}" for requests, limits in zip(head_mem_requests, head_mem_limits)]
-    worker_cpu_requests = [item.worker_cpu_requests if item.worker_cpu_requests else 0 for item in rayclusters]
-    worker_cpu_limits = [item.worker_cpu_limits if item.worker_cpu_limits else 0 for item in rayclusters]
-    worker_cpu_rl = [f"{requests}~{limits}" for requests, limits in zip(worker_cpu_requests, worker_cpu_limits)]
-    worker_mem_requests = [item.worker_mem_requests if item.worker_mem_requests else 0 for item in rayclusters]
-    worker_mem_limits = [item.worker_mem_limits if item.worker_mem_limits else 0 for item in rayclusters]
-    worker_mem_rl = [f"{requests}~{limits}" for requests, limits in zip(worker_mem_requests, worker_mem_limits)]
+    worker_mem_limits = [
+        item.worker_mem_limits if item.worker_mem_limits else 0 for item in rayclusters
+    ]
+    worker_mem_rl = [
+        f"{requests}~{limits}"
+        for requests, limits in zip(worker_mem_requests, worker_mem_limits)
+    ]
     status = [item.status.name for item in rayclusters]
 
     status = [_format_status(item.status) for item in rayclusters]
@@ -345,7 +473,7 @@ def _fetch_cluster_data(namespace):
         "Head Memory Req~Lim": head_mem_rl,
         "Worker CPU Req~Lim": worker_cpu_rl,
         "Worker Memory Req~Lim": worker_mem_rl,
-        "status": status
+        "status": status,
     }
     return pd.DataFrame(data)
 
@@ -359,6 +487,6 @@ def _format_status(status):
         RayClusterStatus.SUSPENDED: '<span style="color: #007BFF;">Suspended ❄️</span>',
         RayClusterStatus.FAILED: '<span style="color: red;">Failed ✗</span>',
         RayClusterStatus.UNHEALTHY: '<span style="color: purple;">Unhealthy</span>',
-        RayClusterStatus.UNKNOWN: '<span style="color: purple;">Unknown</span>'
+        RayClusterStatus.UNKNOWN: '<span style="color: purple;">Unknown</span>',
     }
     return status_map.get(status, status)