make clusters a public attribute

Author: minrk

ipyparallel/cluster/cluster.py

@@ -715,7 +715,7 @@ class ClusterManager(LoggingConfigurable):
     Wraps Cluster, adding lookup/list by cluster id
     """
 
-    _clusters = Dict(help="My cluster objects")
+    clusters = Dict(help="My cluster objects")
 
     @staticmethod
     def _cluster_key(cluster):
@@ -777,7 +777,7 @@ def load_clusters(
                 # totally unspecified, default to all
                 profile_dirs = _all_profile_dirs()
 
-        by_cluster_file = {c.cluster_file: c for c in self._clusters.values()}
+        by_cluster_file = {c.cluster_file: c for c in self.clusters.values()}
         for profile_dir in profile_dirs:
             cluster_files = self._cluster_files_in_profile_dir(profile_dir)
             # load default cluster for each profile
@@ -787,8 +787,8 @@ def load_clusters(
 
                 cluster = Cluster(profile_dir=profile_dir, cluster_id="")
                 cluster_key = self._cluster_key(cluster)
-                if cluster_key not in self._clusters:
-                    self._clusters[cluster_key] = cluster
+                if cluster_key not in self.clusters:
+                    self.clusters[cluster_key] = cluster
 
             for cluster_file in cluster_files:
                 if cluster_file in by_cluster_file:
@@ -802,31 +802,24 @@ def load_clusters(
                     continue
                 else:
                     cluster_key = self._cluster_key(cluster)
-                    self._clusters[cluster_key] = cluster
+                    self.clusters[cluster_key] = cluster
 
-        return self._clusters
-
-    def list_clusters(self):
-        """List current clusters"""
-        # TODO: what should we return?
-        # just cluster ids or the full dict?
-        # just cluster ids for now
-        return self._clusters.items()
+        return self.clusters
 
     def new_cluster(self, **kwargs):
         """Create a new cluster"""
         cluster = Cluster(parent=self, **kwargs)
         cluster_key = self._cluster_key(cluster)
-        if cluster_key in self._clusters:
+        if cluster_key in self.clusters:
             raise KeyError(f"Cluster {cluster_key} already exists!")
-        self._clusters[cluster_key] = cluster
+        self.clusters[cluster_key] = cluster
         return cluster_key, cluster
 
     def get_cluster(self, cluster_id):
         """Get a Cluster object by id"""
-        return self._clusters[cluster_id]
+        return self.clusters[cluster_id]
 
     def remove_cluster(self, cluster_id):
         """Delete a cluster by id"""
         # TODO: check running?
-        del self._clusters[cluster_id]
+        del self.clusters[cluster_id]

ipyparallel/nbextension/handlers.py

@@ -104,7 +104,7 @@ def post(self):
         if (
             'profile' in body
             and 'cluster_id' not in body
-            and f"{body['profile']}:" not in self.cluster_mananger._clusters
+            and f"{body['profile']}:" not in self.cluster_mananger.clusters
         ):
             # if no cluster exists for a profile,
             # default for no cluster id instead of random

ipyparallel/tests/test_cluster.py

@@ -216,19 +216,18 @@ async def test_cluster_repr(Cluster):
 
 async def test_cluster_manager():
     m = cluster.ClusterManager()
-    assert m.list_clusters() == []
-    c = m.new_cluster(profile_dir="/tmp")
+    assert m.clusters == {}
+    key, c = m.new_cluster(profile_dir="/tmp")
     assert c.profile_dir == "/tmp"
-    assert m.get_cluster(c.cluster_id) is c
+    assert m.get_cluster(key) is c
     with pytest.raises(KeyError):
         m.get_cluster("nosuchcluster")
 
     with pytest.raises(KeyError):
-        m.new_cluster(cluster_id=c.cluster_id)
+        m.new_cluster(cluster_id=c.cluster_id, profile_dir=c.profile_dir)
 
-    assert m.list_clusters() == [c.cluster_id]
-    m.remove_cluster(c.cluster_id)
-    assert m.list_clusters() == []
+    assert list(m.clusters) == [key]
+    m.remove_cluster(key)
     with pytest.raises(KeyError):
         m.remove_cluster("nosuchcluster")