Fix unnecessary deprecation warnings when the widget class is initialized

Because deprecated attributes of the Widget class are static attributes, they will be accessed when initializing this class by traitlets. In that case, since a user did not explicitly try to use these attributes, we do not want to throw a deprecation warning. So we check if the thing calling these static properties is one of the known initialization functions in traitlets.

Author: jasongrout

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

@@ -6,11 +6,14 @@
 from IPython.core.interactiveshell import InteractiveShell
 from IPython.display import display
 from IPython.utils.capture import capture_output
+import inspect
+import pytest
 
 from .. import widget
 from ..widget import Widget
 from ..widget_button import Button
 
+PYTEST_PATH = inspect.getfile(pytest.Function)
 
 def test_no_widget_view():
     # ensure IPython shell is instantiated
@@ -51,7 +54,7 @@ def test_close_all():
     widgets = [Button() for i in range(10)]
 
     assert len(widget._instances) > 0, "expect active widgets"
-
+    assert widget._instances[widgets[0].model_id] is widgets[0]
     # close all the widgets
     Widget.close_all()
 
@@ -60,12 +63,15 @@ def test_close_all():
 
 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
-    Widget.close_all()
-    assert not widget.Widget.widgets
-    assert not widget.Widget._active_widgets
-
-    assert widget.Widget.widget_types is widget._registry
-    assert widget.Widget._widget_types is widget._registry
+    assert widget._instances[button.model_id] is button
+    with pytest.deprecated_call() as record:
+        assert widget._instances is widget.Widget.widgets
+        assert widget._instances is widget.Widget._active_widgets
+        assert widget._registry is widget.Widget.widget_types
+        assert widget._registry is widget.Widget._widget_types
+
+        Widget.close_all()
+        assert not widget.Widget.widgets
+        assert not widget.Widget._active_widgets
+    assert all(x.filename == PYTEST_PATH for x in record)
+    assert len(record) == 6

python/ipywidgets/ipywidgets/widgets/utils.py

@@ -6,6 +6,19 @@
 import inspect
 import warnings
 
+def _get_frame(level):
+    """Get the frame at the given stack level."""
+    # sys._getframe is much faster than inspect.stack, but isn't guaranteed to
+    # exist in all python implementations, so we fall back to inspect.stack()
+
+    # We need to add one to level to account for this get_frame call.
+    if hasattr(sys, '_getframe'):
+        frame = sys._getframe(level+1)
+    else:
+        frame = inspect.stack(context=0)[level+1].frame
+    return frame
+
+
 # This function is from https://github.com/python/cpython/issues/67998
 # (https://bugs.python.org/file39550/deprecated_module_stacklevel.diff) and
 # calculates the appropriate stacklevel for deprecations to target the
@@ -21,13 +34,7 @@ def _external_stacklevel(internal):
     """
     # Get the level of my caller's caller
     level = 2
-
-    # sys._getframe is much faster than inspect.stack, but isn't guaranteed to
-    # exist in all python implementations, so we fall back to inspect.stack()
-    if hasattr(sys, '_getframe'):
-        frame = sys._getframe(level)
-    else:
-        frame = inspect.stack(context=0)[level].frame
+    frame = _get_frame(level)
 
     # Normalize the path separators:
     normalized_internal = [str(Path(s)) for s in internal]

python/ipywidgets/ipywidgets/widgets/widget.py

@@ -9,7 +9,6 @@
 import typing
 from contextlib import contextmanager
 from collections.abc import Iterable
-import warnings
 from IPython import get_ipython
 from ipykernel.comm import Comm
 from traitlets import (
@@ -19,8 +18,13 @@
 
 from base64 import standard_b64encode
 
+from .utils import deprecation, _get_frame
+
 from .._version import __protocol_version__, __control_protocol_version__, __jupyter_widgets_base_version__
 
+import inspect
+TRAITLETS_FILE = inspect.getfile(HasTraits)
+
 # Based on jupyter_core.paths.envset
 def envset(name, default):
     """Return True if the given environment variable is turned on, otherwise False
@@ -302,22 +306,42 @@ class Widget(LoggingHasTraits):
 
     @_staticproperty
     def widgets():
-        warnings.warn("Widget.widgets is deprecated.", DeprecationWarning)
+        # Because this is a static attribute, it will be accessed when initializing this class. In that case, since a user
+        # did not explicitly try to use this attribute, we do not want to throw a deprecation warning.
+        # So we check if the thing calling this static property is one of the known initialization functions in traitlets.
+        frame = _get_frame(2)
+        if not (frame.f_code.co_filename == TRAITLETS_FILE and (frame.f_code.co_name in ('getmembers', 'setup_instance'))):
+            deprecation("Widget.widgets is deprecated.")
         return _instances
 
     @_staticproperty
     def _active_widgets():
-        warnings.warn("Widget._active_widgets is deprecated.", DeprecationWarning)
+        # Because this is a static attribute, it will be accessed when initializing this class. In that case, since a user
+        # did not explicitly try to use this attribute, we do not want to throw a deprecation warning.
+        # So we check if the thing calling this static property is one of the known initialization functions in traitlets.
+        frame = _get_frame(2)
+        if not (frame.f_code.co_filename == TRAITLETS_FILE and (frame.f_code.co_name in ('getmembers', 'setup_instance'))):
+            deprecation("Widget._active_widgets is deprecated.")
         return _instances
 
     @_staticproperty
     def _widget_types():
-        warnings.warn("Widget._widget_types is deprecated.", DeprecationWarning)
+        # Because this is a static attribute, it will be accessed when initializing this class. In that case, since a user
+        # did not explicitly try to use this attribute, we do not want to throw a deprecation warning.
+        # So we check if the thing calling this static property is one of the known initialization functions in traitlets.
+        frame = _get_frame(2)
+        if not (frame.f_code.co_filename == TRAITLETS_FILE and (frame.f_code.co_name in ('getmembers', 'setup_instance'))):
+            deprecation("Widget._widget_types is deprecated.")
         return _registry
 
     @_staticproperty
     def widget_types():
-        warnings.warn("Widget.widget_types is deprecated.", DeprecationWarning)
+        # Because this is a static attribute, it will be accessed when initializing this class. In that case, since a user
+        # did not explicitly try to use this attribute, we do not want to throw a deprecation warning.
+        # So we check if the thing calling this static property is one of the known initialization functions in traitlets.
+        frame = _get_frame(2)
+        if not (frame.f_code.co_filename == TRAITLETS_FILE and (frame.f_code.co_name in ('getmembers', 'setup_instance'))):
+            deprecation("Widget.widget_types is deprecated.")
         return _registry
 
     @classmethod