Refactor: widgets module

Author: ChristianZaccaria

src/codeflare_sdk/__init__.py

@@ -12,7 +12,7 @@
     RayJobClient,
 )
 
-from .cluster import view_clusters
+from .common.widgets import view_clusters
 
 from .common import (
     Authentication,

src/codeflare_sdk/cluster/__init__.py renamed to src/codeflare_sdk/common/widgets/__init__.py

@@ -26,10 +26,10 @@
 import ipywidgets as widgets
 from IPython.display import display, HTML, Javascript
 import pandas as pd
-from ..ray.cluster.config import ClusterConfiguration
-from ..ray.cluster.status import RayClusterStatus
-from ..common import _kube_api_error_handling
-from ..common.kubernetes_cluster.auth import (
+from ...ray.cluster.config import ClusterConfiguration
+from ...ray.cluster.status import RayClusterStatus
+from ..kubernetes_cluster import _kube_api_error_handling
+from ..kubernetes_cluster.auth import (
     config_check,
     get_api_client,
 )
@@ -58,7 +58,7 @@ def cluster_up_down_buttons(
         icon="trash",
     )
 
-    wait_ready_check = wait_ready_check_box()
+    wait_ready_check = _wait_ready_check_box()
     output = widgets.Output()
 
     # Display the buttons in an HBox wrapped in a VBox which includes the wait_ready Checkbox
@@ -83,7 +83,7 @@ def on_down_button_clicked(b):  # Handle the down button click event
     delete_button.on_click(on_down_button_clicked)
 
 
-def wait_ready_check_box():
+def _wait_ready_check_box():
     """
     The wait_ready_check_box function will return a checkbox widget used for waiting for the resource to be in the state READY.
     """
@@ -117,7 +117,7 @@ def view_clusters(namespace: str = None):
         )
         return  # Exit function if not in Jupyter Notebook
 
-    from ..ray.cluster.cluster import get_current_namespace
+    from ...ray.cluster.cluster import get_current_namespace
 
     if not namespace:
         namespace = get_current_namespace()
@@ -280,7 +280,7 @@ def _on_ray_dashboard_button_click(
     """
     _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.ray.cluster import Cluster
+    from codeflare_sdk import Cluster
 
     cluster_name = classification_widget.value
     namespace = ray_clusters_df[ray_clusters_df["Name"] == classification_widget.value][
@@ -311,7 +311,7 @@ def _on_list_jobs_button_click(
     """
     _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.ray.cluster import Cluster
+    from codeflare_sdk import Cluster
 
     cluster_name = classification_widget.value
     namespace = ray_clusters_df[ray_clusters_df["Name"] == classification_widget.value][
@@ -344,7 +344,7 @@ def _delete_cluster(
     _delete_cluster function deletes the cluster with the given name and namespace.
     It optionally waits for the cluster to be deleted.
     """
-    from ..ray.cluster.cluster import _check_aw_exists
+    from ...ray.cluster.cluster import _check_aw_exists
 
     try:
         config_check()
@@ -402,7 +402,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 ..ray.cluster.cluster import list_all_clusters
+    from ...ray.cluster.cluster import list_all_clusters
 
     rayclusters = list_all_clusters(namespace, False)
     if not rayclusters:

src/codeflare_sdk/cluster/widgets.py renamed to src/codeflare_sdk/common/widgets/widgets.py

@@ -1,4 +1,4 @@
-# Copyright 2022 IBM, Red Hat
+# Copyright 2024 IBM, Red Hat
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -45,7 +45,7 @@
     AppWrapper,
     AppWrapperStatus,
 )
-from ...cluster.widgets import (
+from ...common.widgets.widgets import (
     cluster_up_down_buttons,
     is_notebook,
 )

src/codeflare_sdk/ray/cluster/cluster.py

@@ -1,4 +1,4 @@
-# Copyright 2022 IBM, Red Hat
+# Copyright 2024 IBM, Red Hat
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -79,7 +79,7 @@
     is_openshift_cluster,
 )
 
-import codeflare_sdk.cluster.widgets as cf_widgets
+import codeflare_sdk.common.widgets.widgets as cf_widgets
 import pandas as pd
 
 import openshift
@@ -2959,24 +2959,20 @@ def test_cluster_up_down_buttons(mocker):
 
 @patch.dict("os.environ", {}, clear=True)  # Mock environment with no variables
 def test_is_notebook_false():
-    from codeflare_sdk.cluster.widgets import is_notebook
-
-    assert is_notebook() is False
+    assert cf_widgets.is_notebook() is False
 
 
 @patch.dict(
     "os.environ", {"JPY_SESSION_NAME": "example-test"}
 )  # Mock Jupyter environment variable
 def test_is_notebook_true():
-    from codeflare_sdk.cluster.widgets import is_notebook
-
-    assert is_notebook() is True
+    assert cf_widgets.is_notebook() is True
 
 
 def test_view_clusters(mocker, capsys):
     from kubernetes.client.rest import ApiException
 
-    mocker.patch("codeflare_sdk.cluster.widgets.is_notebook", return_value=False)
+    mocker.patch("codeflare_sdk.common.widgets.widgets.is_notebook", return_value=False)
     with pytest.warns(
         UserWarning,
         match="view_clusters can only be used in a Jupyter Notebook environment.",
@@ -2985,7 +2981,7 @@ def test_view_clusters(mocker, capsys):
         # Assert the function returns None when not in a notebook environment
         assert result is None
 
-    mocker.patch("codeflare_sdk.cluster.widgets.is_notebook", return_value=True)
+    mocker.patch("codeflare_sdk.common.widgets.widgets.is_notebook", return_value=True)
 
     # Mock Kubernetes API responses
     mocker.patch("kubernetes.client.ApisApi.get_api_versions")
@@ -3030,7 +3026,7 @@ def test_view_clusters(mocker, capsys):
 
     # Mock the _fetch_cluster_data function to return a test DataFrame
     mocker.patch(
-        "codeflare_sdk.cluster.widgets._fetch_cluster_data", return_value=test_df
+        "codeflare_sdk.common.widgets.widgets._fetch_cluster_data", return_value=test_df
     )
 
     # Mock the Cluster class and related methods
@@ -3048,7 +3044,7 @@ def test_view_clusters(mocker, capsys):
     ) as mock_display, patch(
         "IPython.display.HTML"
     ), patch(
-        "codeflare_sdk.cluster.widgets.Javascript"
+        "codeflare_sdk.common.widgets.widgets.Javascript"
     ) as mock_javascript:
         # Create mock widget instances
         mock_toggle = MagicMock()