Add FigureWidget import support back

Author: jonmmease

packages/python/plotly/codegen/__init__.py

@@ -1,4 +1,5 @@
 import json
+import os
 import os.path as opath
 import shutil
 import subprocess
@@ -264,25 +265,33 @@ def perform_codegen():
     for dep_clas in DEPRECATED_DATATYPES:
         root_datatype_imports.append(f"._deprecations.{dep_clas}")
 
-    root_alls = []
-
-    # TODO: come back to FigureWidget
-    optional_figure_widget_import = """
-from .._validate import validate
+    validate_import = "from .._validate import validate\n"
+    optional_figure_widget_import = f"""
+if sys.version_info < (3, 7):
+    try:
+        import ipywidgets
+        from distutils.version import LooseVersion
+        if LooseVersion(ipywidgets.__version__) >= LooseVersion('7.0.0'):
+            from ..graph_objs._figurewidget import FigureWidget
+        del LooseVersion
+        del ipywidgets
+    except ImportError:
+        pass
+else:
+    orig_getattr = __getattr__
+    def __getattr__(import_name):
+        if import_name == "FigureWidget":
+            try:
+                import ipywidgets
+                from distutils.version import LooseVersion
+                if LooseVersion(ipywidgets.__version__) >= LooseVersion('7.0.0'):
+                    from ..graph_objs._figurewidget import FigureWidget
+                    return FigureWidget
+            except ImportError:
+                    pass
+        
+        return orig_getattr(import_name)
 """
-#     optional_figure_widget_import = f"""
-#
-# try:
-#     import ipywidgets
-#     from distutils.version import LooseVersion
-#     if LooseVersion(ipywidgets.__version__) >= LooseVersion('7.0.0'):
-#         from ._figurewidget import FigureWidget
-#         __all__.append("FigureWidget")
-#     del LooseVersion
-#     del ipywidgets
-# except ImportError:
-#     pass
-# """
     # ### __all__ ###
     for path_parts, class_names in alls.items():
         if path_parts and class_names:
@@ -296,7 +305,7 @@ def perform_codegen():
         rel_classes = datatype_rel_class_imports[path_parts]
         rel_modules = datatype_rel_module_imports.get(path_parts, [])
         if path_parts == ():
-            init_extra = optional_figure_widget_import
+            init_extra = validate_import + optional_figure_widget_import
         else:
             init_extra = ""
         write_init_py(graph_objs_pkg, path_parts, rel_modules, rel_classes, init_extra)
@@ -312,9 +321,10 @@ def perform_codegen():
     ]
 
     graph_objects_init_source = build_from_imports_py(
-        graph_objects_rel_modules, graph_objects_rel_classes,
+        graph_objects_rel_modules, graph_objects_rel_classes, init_extra=optional_figure_widget_import
     )
-    graph_objects_path = opath.join(outdir, "graph_objects.py")
+    graph_objects_path = opath.join(outdir, "graph_objects", "__init__.py")
+    os.makedirs(opath.join(outdir, "graph_objects"), exist_ok=True)
     with open(graph_objects_path, "wt") as f:
         f.write(graph_objects_init_source)
 

packages/python/plotly/codegen/datatypes.py

@@ -155,13 +155,13 @@ def _subplot_re_match(self, prop):
 
     child_datatype_nodes = node.child_datatypes
     subtype_nodes = child_datatype_nodes
-    valid_props = sorted([node.name_property for node in subtype_nodes + literal_nodes])
+    valid_props_list = sorted([node.name_property for node in subtype_nodes + literal_nodes])
     buffer.write(f"""
     # class properties
     # --------------------
     _parent_path_str = '{node.parent_path_str}'
     _path_str = '{node.path_str}'
-    _valid_props = {{"{'", "'.join(valid_props)}"}}
+    _valid_props = {{"{'", "'.join(valid_props_list)}"}}
 """)
 
     # ### Property definitions ###
@@ -319,7 +319,7 @@ def __init__(self"""
         buffer.write(f"""
         # Override _valid_props for instance so that instance can mutate set
         # to support subplot properties (e.g. xaxis2)
-        self._valid_props = {{"{'", "'.join(valid_props)}"}}
+        self._valid_props = {{"{'", "'.join(valid_props_list)}"}}
 """)
 
     buffer.write(f"""

packages/python/plotly/plotly/basedatatypes.py

@@ -1937,7 +1937,8 @@ def _initialize_layout_template(self):
         if self._layout_obj._props.get('template', None) is None:
             if pio.templates.default is not None:
                 with validate(False):
-                    template_dict = pio.templates[pio.templates.default].to_plotly_json()
+                    # Assume default template is already validated
+                    template_dict = pio.templates[pio.templates.default]
                     self._layout_obj.template = template_dict
             else:
                 self._layout_obj.template = None
@@ -3460,7 +3461,6 @@ def __setitem__(self, prop, value):
             prop = prop[0]
 
             if validate._should_validate:
-                # ### Validate prop ###
                 if prop not in self._valid_props:
                     self._raise_on_invalid_property_error(prop)
 
@@ -3481,8 +3481,18 @@ def __setitem__(self, prop, value):
             else:
                 # Make sure properties dict is initialized
                 self._init_props()
+                if isinstance(value, BasePlotlyType):
+                    # Extract json from graph objects
+                    value = value.to_plotly_json()
+
                 self._props[prop] = value
 
+                # Remove any already constructed graph object so that it will be
+                # reconstructed on property access
+                self._compound_props.pop(prop, None)
+                self._compound_array_props.pop(prop, None)
+
+
         # Handle non-scalar case
         # ----------------------
         # e.g. ('foo', 1), ()

packages/python/plotly/plotly/graph_objects.py renamed to packages/python/plotly/plotly/graph_objects/__init__.py

@@ -257,3 +257,33 @@
             "..graph_objs.Histogram2dcontour",
         ],
     )
+
+
+if sys.version_info < (3, 7):
+    try:
+        import ipywidgets
+        from distutils.version import LooseVersion
+
+        if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
+            from ..graph_objs._figurewidget import FigureWidget
+        del LooseVersion
+        del ipywidgets
+    except ImportError:
+        pass
+else:
+    orig_getattr = __getattr__
+
+    def __getattr__(import_name):
+        if import_name == "FigureWidget":
+            try:
+                import ipywidgets
+                from distutils.version import LooseVersion
+
+                if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
+                    from ..graph_objs._figurewidget import FigureWidget
+
+                    return FigureWidget
+            except ImportError:
+                pass
+
+        return orig_getattr(import_name)

packages/python/plotly/plotly/graph_objs/__init__.py

@@ -258,5 +258,33 @@
         ],
     )
 
-
 from .._validate import validate
+
+if sys.version_info < (3, 7):
+    try:
+        import ipywidgets
+        from distutils.version import LooseVersion
+
+        if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
+            from ..graph_objs._figurewidget import FigureWidget
+        del LooseVersion
+        del ipywidgets
+    except ImportError:
+        pass
+else:
+    orig_getattr = __getattr__
+
+    def __getattr__(import_name):
+        if import_name == "FigureWidget":
+            try:
+                import ipywidgets
+                from distutils.version import LooseVersion
+
+                if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
+                    from ..graph_objs._figurewidget import FigureWidget
+
+                    return FigureWidget
+            except ImportError:
+                pass
+
+        return orig_getattr(import_name)

packages/python/plotly/plotly/graph_objs/_layout.py

@@ -5520,88 +5520,88 @@ def __init__(
         # Override _valid_props for instance so that instance can mutate set
         # to support subplot properties (e.g. xaxis2)
         self._valid_props = {
-            "sliders",
-            "colorway",
-            "title",
-            "ternary",
-            "margin",
-            "extendsunburstcolors",
-            "modebar",
-            "mapbox",
-            "updatemenus",
-            "treemapcolorway",
-            "updatemenudefaults",
-            "annotationdefaults",
-            "images",
-            "dragmode",
-            "geo",
-            "spikedistance",
-            "waterfallgroupgap",
-            "separators",
-            "scene",
-            "hoverlabel",
-            "funnelgap",
-            "titlefont",
-            "uniformtext",
-            "autosize",
-            "paper_bgcolor",
-            "hoverdistance",
-            "violinmode",
-            "width",
-            "extendfunnelareacolors",
-            "sliderdefaults",
-            "funnelgroupgap",
-            "waterfallgap",
-            "datarevision",
             "angularaxis",
-            "legend",
-            "plot_bgcolor",
-            "sunburstcolorway",
+            "annotationdefaults",
             "annotations",
-            "metasrc",
-            "font",
-            "barmode",
-            "yaxis",
+            "autosize",
             "bargap",
-            "orientation",
-            "hidesources",
-            "extendpiecolors",
-            "violingap",
-            "template",
-            "hovermode",
-            "violingroupgap",
-            "xaxis",
-            "uirevision",
-            "extendtreemapcolors",
-            "transition",
-            "polar",
-            "editrevision",
-            "boxgroupgap",
-            "grid",
+            "bargroupgap",
+            "barmode",
             "barnorm",
-            "funnelareacolorway",
-            "imagedefaults",
-            "piecolorway",
-            "shapes",
-            "clickmode",
+            "boxgap",
+            "boxgroupgap",
             "boxmode",
-            "showlegend",
-            "direction",
             "calendar",
+            "clickmode",
+            "coloraxis",
+            "colorscale",
+            "colorway",
+            "datarevision",
+            "direction",
+            "dragmode",
+            "editrevision",
+            "extendfunnelareacolors",
+            "extendpiecolors",
+            "extendsunburstcolors",
+            "extendtreemapcolors",
+            "font",
+            "funnelareacolorway",
+            "funnelgap",
+            "funnelgroupgap",
+            "funnelmode",
+            "geo",
+            "grid",
+            "height",
+            "hiddenlabels",
             "hiddenlabelssrc",
+            "hidesources",
+            "hoverdistance",
+            "hoverlabel",
+            "hovermode",
+            "imagedefaults",
+            "images",
+            "legend",
+            "mapbox",
+            "margin",
             "meta",
-            "waterfallmode",
+            "metasrc",
+            "modebar",
+            "orientation",
+            "paper_bgcolor",
+            "piecolorway",
+            "plot_bgcolor",
+            "polar",
+            "radialaxis",
+            "scene",
             "selectdirection",
-            "boxgap",
             "selectionrevision",
-            "coloraxis",
-            "radialaxis",
-            "height",
-            "colorscale",
-            "hiddenlabels",
+            "separators",
             "shapedefaults",
-            "bargroupgap",
-            "funnelmode",
+            "shapes",
+            "showlegend",
+            "sliderdefaults",
+            "sliders",
+            "spikedistance",
+            "sunburstcolorway",
+            "template",
+            "ternary",
+            "title",
+            "titlefont",
+            "transition",
+            "treemapcolorway",
+            "uirevision",
+            "uniformtext",
+            "updatemenudefaults",
+            "updatemenus",
+            "violingap",
+            "violingroupgap",
+            "violinmode",
+            "waterfallgap",
+            "waterfallgroupgap",
+            "waterfallmode",
+            "width",
+            "xaxis",
+            "yaxis",
         }
 
         # Validate arg

packages/python/plotly/setup.py

@@ -475,6 +475,7 @@ def run(self):
         "plotly.figure_factory",
         "plotly.data",
         "plotly.express",
+        "plotly.graph_objects",
         "_plotly_utils",
         "_plotly_utils.colors",
         "_plotly_future_",