rename to _instances

Author: maartenbreddels

python/ipywidgets/ipywidgets/embed.py

@@ -130,7 +130,7 @@ def _get_recursive_state(widget, store=None, drop_defaults=False):
 
 def add_resolved_links(store, drop_defaults):
     """Adds the state of any link models between two models in store"""
-    for widget_id, widget in ipywidgets.widgets.widget.instances.items(): # go over all widgets
+    for widget_id, widget in ipywidgets.widgets.widget._instances.items(): # go over all widgets
         if isinstance(widget, Link) and widget_id not in store:
             if widget.source[0].model_id in store and widget.target[0].model_id in store:
                 store[widget.model_id] = widget._get_embed_state(drop_defaults=drop_defaults)
@@ -208,7 +208,7 @@ def embed_data(views, drop_defaults=True, state=None):
         view_specs: a list of widget view specs
     """
     if views is None:
-        views = [w for w in ipywidgets.widgets.widget.instances.values() if isinstance(w, DOMWidget)]
+        views = [w for w in ipywidgets.widgets.widget._instances.values() if isinstance(w, DOMWidget)]
     else:
         try:
             views[0]

python/ipywidgets/ipywidgets/tests/test_embed.py

@@ -30,7 +30,7 @@ class CaseWidget(Widget):
 class TestEmbed:
 
     def teardown(self):
-        for w in tuple(ipywidgets.widgets.widget.instances.values()):
+        for w in tuple(ipywidgets.widgets.widget._instances.values()):
             w.close()
 
     def test_embed_data_simple(self):

python/ipywidgets/ipywidgets/widgets/tests/test_widget.py

@@ -50,19 +50,19 @@ def test_close_all():
     # create a couple of widgets
     widgets = [Button() for i in range(10)]
 
-    assert len(widget.instances) > 0, "expect active widgets"
+    assert len(widget._instances) > 0, "expect active widgets"
 
     # close all the widgets
     Widget.close_all()
 
-    assert len(widget.instances) == 0, "active widgets should be cleared"
+    assert len(widget._instances) == 0, "active widgets should be cleared"
 
 
 def test_compatibility():
     button = Button()
     assert button in widget.Widget.widgets.values()
-    assert widget.instances is widget.Widget.widgets
-    assert widget.instances is widget.Widget._active_widgets
+    assert widget._instances is widget.Widget.widgets
+    assert widget._instances is widget.Widget._active_widgets
     Widget.close_all()
     assert not widget.Widget.widgets
     assert not widget.Widget._active_widgets

python/ipywidgets/ipywidgets/widgets/widget.py

@@ -38,7 +38,7 @@ def envset(name, default):
 JUPYTER_WIDGETS_ECHO = envset('JUPYTER_WIDGETS_ECHO', default=True)
 # we keep a strong reference for every widget created, for a discussion on using weak references see:
 #  https://github.com/jupyter-widgets/ipywidgets/issues/1345
-instances : typing.MutableMapping[str, "Widget"] = {}
+_instances : typing.MutableMapping[str, "Widget"] = {}
 
 def _widget_to_json(x, obj):
     if isinstance(x, dict):
@@ -55,8 +55,8 @@ def _json_to_widget(x, obj):
         return {k: _json_to_widget(v, obj) for k, v in x.items()}
     elif isinstance(x, (list, tuple)):
         return [_json_to_widget(v, obj) for v in x]
-    elif isinstance(x, str) and x.startswith('IPY_MODEL_') and x[10:] in instances:
-        return instances[x[10:]]
+    elif isinstance(x, str) and x.startswith('IPY_MODEL_') and x[10:] in _instances:
+        return _instances[x[10:]]
     else:
         return x
 
@@ -302,13 +302,13 @@ class Widget(LoggingHasTraits):
 
     @_staticproperty
     def widgets():
-        warnings.warn("Widget.widgets is deprecated, use ipywidgets.widgets.widget.instances", DeprecationWarning)
-        return instances
+        warnings.warn("Widget.widgets is deprecated, use ipywidgets.widgets.widget._instances", DeprecationWarning)
+        return _instances
 
     @_staticproperty
     def _active_widgets():
-        warnings.warn("Widget._active_widgets is deprecated, use ipywidgets.widgets.widget.instances", DeprecationWarning)
-        return instances
+        warnings.warn("Widget._active_widgets is deprecated, use ipywidgets.widgets.widget._instances", DeprecationWarning)
+        return _instances
 
     @_staticproperty
     def _widget_types():
@@ -322,7 +322,7 @@ def widget_types():
 
     @classmethod
     def close_all(cls):
-        for widget in list(instances.values()):
+        for widget in list(_instances.values()):
             widget.close()
 
     @staticmethod
@@ -364,7 +364,7 @@ def _handle_control_comm_msg(cls, msg):
         if method == 'request_states':
             # Send back the full widgets state
             cls.get_manager_state()
-            widgets = instances.values()
+            widgets = _instances.values()
             full_state = {}
             drop_defaults = False
             for widget in widgets:
@@ -415,7 +415,7 @@ def get_manager_state(drop_defaults=False, widgets=None):
         """
         state = {}
         if widgets is None:
-            widgets = instances.values()
+            widgets = _instances.values()
         for widget in widgets:
             state[widget.model_id] = widget._get_embed_state(drop_defaults=drop_defaults)
         return {'version_major': 2, 'version_minor': 0, 'state': state}
@@ -511,7 +511,7 @@ def _comm_changed(self, change):
         self._model_id = self.model_id
 
         self.comm.on_msg(self._handle_msg)
-        instances[self.model_id] = self
+        _instances[self.model_id] = self
 
     @property
     def model_id(self):
@@ -531,7 +531,7 @@ def close(self):
         When the comm is closed, all of the widget views are automatically
         removed from the front-end."""
         if self.comm is not None:
-            instances.pop(self.model_id, None)
+            _instances.pop(self.model_id, None)
             self.comm.close()
             self.comm = None
             self._repr_mimebundle_ = None