Create util for display jupyter version warnings and update imports

plotly · marthacryan · Nov 12, 2024 · Jul 14, 2024 · Sep 12, 2024 · Sep 13, 2024
commit dc87b3cc1e84114a9eb60a645f17f4e825cbd22c
diff --git a/packages/python/plotly/plotly/basewidget.py b/packages/python/plotly/plotly/basewidget.py
@@ -1,6 +1,6 @@
 import pathlib
-import ipywidgets as widgets
-from traitlets import List, Unicode, Dict, observe, Integer
+from traitlets import List, Dict, observe, Integer
+from plotly.io._utils import display_jupyter_version_warnings

 from .basedatatypes import BaseFigure, BasePlotlyType
 from .callbacks import BoxSelector, LassoSelector, InputDeviceState, Points
@@ -725,6 +725,7 @@ def _repr_mimebundle_(self, include=None, exclude=None, validate=True, **kwargs)
        """
        Return mimebundle corresponding to default renderer.
        """
+        display_jupyter_version_warnings()
        return {
            "application/vnd.jupyter.widget-view+json": {
                "version_major": 2,

diff --git a/packages/python/plotly/plotly/io/_renderers.py b/packages/python/plotly/plotly/io/_renderers.py
@@ -2,8 +2,6 @@
 from copy import copy

 import os
-import warnings
-import psutil
 from packaging.version import Version

 from plotly import optional_imports
@@ -28,13 +26,14 @@
    CoCalcRenderer,
    DatabricksRenderer,
 )
-from plotly.io._utils import validate_coerce_fig_to_dict
+from plotly.io._utils import (
+    validate_coerce_fig_to_dict,
+    display_jupyter_version_warnings,
+)

 ipython = optional_imports.get_module("IPython")
 ipython_display = optional_imports.get_module("IPython.display")
 nbformat = optional_imports.get_module("nbformat")
-jupyter_notebook = optional_imports.get_module("notebook")
-jupyter_lab = optional_imports.get_module("jupyterlab")

 # Renderer configuration class
 # -----------------------------
@@ -398,18 +397,7 @@ def show(fig, renderer=None, validate=True, **kwargs):
                "Mime type rendering requires nbformat>=4.2.0 but it is not installed"
            )

-        parent_process = psutil.Process().parent().cmdline()[-1]
-
-        if "jupyter-notebook" in parent_process and jupyter_notebook.__version__ < "7":
-            # Add warning about upgrading notebook
-            warnings.warn(
-                f"Plotly version >= 6 requires Jupyter Notebook >= 7 but you have {jupyter_notebook.__version__} installed.\n To upgrade Jupyter Notebook, please run `pip install notebook --upgrade`."
-            )
-        elif "jupyter-lab" in parent_process and jupyter_lab.__version__ < "3":
-            # Add warning about upgrading jupyterlab
-            warnings.warn(
-                f"Plotly version >= 6 requires JupyterLab >= 3 but you have {jupyter_lab.__version__} installed. To upgrade JupyterLab, please run `pip install jupyterlab --upgrade`."
-            )
+        display_jupyter_version_warnings()

        ipython_display.display(bundle, raw=True)


diff --git a/packages/python/plotly/plotly/io/_utils.py b/packages/python/plotly/plotly/io/_utils.py
@@ -1,6 +1,29 @@
 import plotly
 import plotly.graph_objs as go
 from plotly.offline import get_plotlyjs_version
+from plotly import optional_imports
+
+import warnings
+import psutil
+
+jupyter_notebook = optional_imports.get_module("notebook")
+jupyter_lab = optional_imports.get_module("jupyterlab")
+
+
+def display_jupyter_version_warnings():
+
+    parent_process = psutil.Process().parent().cmdline()[-1]
+
+    if "jupyter-notebook" in parent_process and jupyter_notebook.__version__ < "7":
+        # Add warning about upgrading notebook
+        warnings.warn(
+            f"Plotly version >= 6 requires Jupyter Notebook >= 7 but you have {jupyter_notebook.__version__} installed.\n To upgrade Jupyter Notebook, please run `pip install notebook --upgrade`."
+        )
+    elif "jupyter-lab" in parent_process and jupyter_lab.__version__ < "3":
+        # Add warning about upgrading jupyterlab
+        warnings.warn(
+            f"Plotly version >= 6 requires JupyterLab >= 3 but you have {jupyter_lab.__version__} installed. To upgrade JupyterLab, please run `pip install jupyterlab --upgrade`."
+        )


 def validate_coerce_fig_to_dict(fig, validate):

diff --git a/packages/python/plotly/test_requirements/requirements_312_np2_optional.txt b/packages/python/plotly/test_requirements/requirements_312_np2_optional.txt
@@ -18,4 +18,5 @@ matplotlib==3.9.2
 scikit-image==0.24.0
 psutil==5.9.7
 kaleido
-orjson==3.9.10
+orjson==3.9.10
+anywidget==0.9.13
-Original file line number
+Diff line change
@@ -1,6 +1,29 @@
     import plotly
     import plotly.graph_objs as go
     from plotly.offline import get_plotlyjs_version
+    from plotly import optional_imports
+    import warnings
+    import psutil
+    jupyter_notebook = optional_imports.get_module("notebook")
+    jupyter_lab = optional_imports.get_module("jupyterlab")
+    def display_jupyter_version_warnings():
+        parent_process = psutil.Process().parent().cmdline()[-1]
             Copy link

  
      
    
  

  
      

  
    Collaborator


      

  

  
    
      

      
            alexcjohnson
  

      

      

      


        Nov 8, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      IDK how this would happen in practice, but in principle .parent() can return None which would make this fail. In that case I guess we aren't in a jupyter context so we can short-circuit the rest of this.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



    
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Collaborator


      

  Author


  

  
    
      

      
            marthacryan
  

      

      

      


        Nov 8, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      I added some code to address this! Let me know if you think there's a better approach than a try/except
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
+        if "jupyter-notebook" in parent_process and jupyter_notebook.__version__ < "7":
             Copy link

  
      
    
  

  
      

  
    Collaborator


      

  

  
    
      

      
            alexcjohnson
  

      

      

      


        Nov 8, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Can we move the optional_imports.get_module calls inside these conditionals? Something like:
if "jupyter-notebook" in parent_process:
    jupyter_notebook = optional_imports.get_module("notebook")
    if jupyter_notebook.__version__ < "7":
and similar for jupyterlab. Those imports can be slow (particularly jupyterlab, it's nearly a second on my computer), no need to increase everyone's startup time (for example Dash apps). And calling optional_imports.get_module on an already-loaded module or a nonexistent module you've previously asked for is very fast.
I wonder about the existing optional import calls in _renderers.py as well - looks like IPython and IPython.display are automatically imported when you're in an IPython or jupyter environment, so I bet we could just add should_load=False to those calls. nbformat is not automatically loaded, so it would need to move into the show method where it's called, like I'm suggesting here.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
            cardinalgeo reacted with hooray emoji
      
        
            
    All reactions
  


          
              
                🎉
                  1 reaction
              
          
        
      
    

    



    
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Collaborator


      

  Author


  

  
    
      

      
            marthacryan
  

      

      

      


        Nov 8, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Good point! I moved them into the if statements. I'm not sure about the other optional calls in that file but I can make an issue to investigate that more
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



    
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
    Collaborator


      

  Author


  

  
    
      

      
            marthacryan
  

      

      

      


        Nov 8, 2024


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Just made this issue: #4856
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
+            # Add warning about upgrading notebook
+            warnings.warn(
+                f"Plotly version >= 6 requires Jupyter Notebook >= 7 but you have {jupyter_notebook.__version__} installed.\n To upgrade Jupyter Notebook, please run `pip install notebook --upgrade`."
+            )
+        elif "jupyter-lab" in parent_process and jupyter_lab.__version__ < "3":
+            # Add warning about upgrading jupyterlab
+            warnings.warn(
+                f"Plotly version >= 6 requires JupyterLab >= 3 but you have {jupyter_lab.__version__} installed. To upgrade JupyterLab, please run `pip install jupyterlab --upgrade`."
+            )
     def validate_coerce_fig_to_dict(fig, validate):
-          Expand Down