ipywidgets 8 compatibility (#6912)

Author: jrbourbeau

continuous_integration/environment-3.10.yaml

@@ -15,7 +15,7 @@ dependencies:
   - filesystem-spec  # overridden by git tip below
   - h5py
   - ipykernel
-  - ipywidgets <8  # FIXME https://github.com/dask/distributed/issues/6909
+  - ipywidgets
   - jinja2
   - locket >=1.0
   - msgpack-python

continuous_integration/environment-3.8.yaml

@@ -16,7 +16,7 @@ dependencies:
   - filesystem-spec
   - h5py
   - ipykernel
-  - ipywidgets <8  # FIXME https://github.com/dask/distributed/issues/6909
+  - ipywidgets
   - jinja2
   - locket >=1.0
   - msgpack-python

continuous_integration/environment-3.9.yaml

@@ -16,7 +16,7 @@ dependencies:
   - filesystem-spec
   - h5py
   - ipykernel
-  - ipywidgets <8  # FIXME https://github.com/dask/distributed/issues/6909
+  - ipywidgets
   - jinja2
   - locket >=1.0
   - lz4 >=0.23.1  # Only tested here

distributed/deploy/cluster.py

@@ -9,6 +9,7 @@
 from inspect import isawaitable
 from typing import Any
 
+from packaging.version import parse as parse_version
 from tornado.ioloop import IOLoop, PeriodicCallback
 
 import dask.config
@@ -493,14 +494,28 @@ def _repr_html_(self, cluster_status=None):
         )
 
     def _ipython_display_(self, **kwargs):
+        """Display the cluster rich IPython repr"""
+        # Note: it would be simpler to just implement _repr_mimebundle_,
+        # but we cannot do that until we drop ipywidgets 7 support, as
+        # it does not provide a public way to get the mimebundle for a
+        # widget. So instead we fall back on the more customizable _ipython_display_
+        # and display as a side-effect.
+        from IPython.display import display
+
         widget = self._widget()
-        if widget is not None:
-            return widget._ipython_display_(**kwargs)
+        if widget:
+            import ipywidgets
+
+            if parse_version(ipywidgets.__version__) >= parse_version("8.0.0"):
+                mimebundle = widget._repr_mimebundle_(**kwargs) or {}
+                mimebundle["text/plain"] = repr(self)
+                mimebundle["text/html"] = self._repr_html_()
+                display(mimebundle, raw=True)
+            else:
+                display(widget, **kwargs)
         else:
-            from IPython.display import display
-
-            data = {"text/plain": repr(self), "text/html": self._repr_html_()}
-            display(data, raw=True)
+            mimebundle = {"text/plain": repr(self), "text/html": self._repr_html_()}
+            display(mimebundle, raw=True)
 
     def __enter__(self):
         return self.sync(self.__aenter__)

distributed/diagnostics/progressbar.py

@@ -198,7 +198,9 @@ def __init__(
 
     def _ipython_display_(self, **kwargs):
         IOLoop.current().add_callback(self.listen)
-        return self.widget._ipython_display_(**kwargs)
+        from IPython.display import display
+
+        display(self.widget, **kwargs)
 
     def _draw_stop(self, remaining, status, exception=None, **kwargs):
         if status == "error":
@@ -379,7 +381,9 @@ def keyfunc(kv):
 
     def _ipython_display_(self, **kwargs):
         IOLoop.current().add_callback(self.listen)
-        return self.widget._ipython_display_(**kwargs)
+        from IPython.display import display
+
+        display(self.widget, **kwargs)
 
     def _draw_stop(self, remaining, status, exception=None, key=None, **kwargs):
         for k, v in remaining.items():

distributed/diagnostics/tests/test_widgets.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
 import pytest
+from packaging.version import parse as parse_version
 
-pytest.importorskip("ipywidgets")
+ipywidgets = pytest.importorskip("ipywidgets")
 
 from ipykernel.comm import Comm
 from ipywidgets import Widget
@@ -38,7 +39,11 @@ def close(self, *args, **kwargs):
 def setup():
     _widget_attrs["_comm_default"] = getattr(Widget, "_comm_default", undefined)
     Widget._comm_default = lambda self: DummyComm()
-    _widget_attrs["_ipython_display_"] = Widget._ipython_display_
+    if parse_version(ipywidgets.__version__) >= parse_version("8.0.0"):
+        display_attr = "_repr_mimebundle_"
+    else:
+        display_attr = "_ipython_display_"
+    _widget_attrs[display_attr] = getattr(Widget, display_attr)
 
     def raise_not_implemented(*args, **kwargs):
         raise NotImplementedError()