Merge pull request #2455 from grisaitis/issue/markdown-syntax-updating-figures

nicolaskruchten · web-flow · commit 200d534f4087 · 2020-05-10T13:12:33.000-04:00
Fix markdown syntax, typo in docs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.7.1] - 2020-05-08
+
+### Fixed
+
+ - Fix `AttributeError: module 'plotly.graph_objs' has no attribute 'FigureWidget'` exception on `from plotly.graph_objs import *` when `ipywidgets` is not installed. Error also occurred when importing `plotly.figure_factor`. It is now possible to import `plotly.graph_objs.FigureWidget` when `ipywidgets` is not installed, and an informative `ImportError` exception will be raised in the `FigureWidget` constructor ([#2443](https://github.com/plotly/plotly.py/issues/2443), [#1111](https://github.com/plotly/plotly.py/issues/1111)).
+ - Fix `TypeError: unhashable type: 'Template'` during `Figure` construction when `plotly.io.templates.default` is set to a `Template` object rather than a string.
+
+
 ## [4.7.0] - 2020-05-06
 
 ### Updated
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@
 
 ## Quickstart
 
-`pip install plotly==4.7.0`
+`pip install plotly==4.7.1`
 
 Inside [Jupyter notebook](https://jupyter.org/install) (installable with `pip install "notebook>=5.3" "ipywidgets>=7.2"`):
 
@@ -82,13 +82,13 @@ Built on top of [plotly.js](https://github.com/plotly/plotly.js), `plotly.py` is
 plotly.py may be installed using pip...
 
 ```
-pip install plotly==4.7.0
+pip install plotly==4.7.1
 ```
 
 or conda.
 
 ```
-conda install -c plotly plotly=4.7.0
+conda install -c plotly plotly=4.7.1
 ```
 
 ### Jupyter Notebook Support
@@ -125,10 +125,10 @@ Then run the following commands to install the required JupyterLab extensions (n
 
 ```
 # Basic JupyterLab renderer support
-jupyter labextension install jupyterlab-plotly@4.7.0
+jupyter labextension install jupyterlab-plotly@4.7.1
 
 # OPTIONAL: Jupyter widgets extension for FigureWidget support
-jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.7.0
+jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.7.1
 ```
 
 Please check out our [Troubleshooting guide](https://plotly.com/python/troubleshooting/) if you run into any problems with JupyterLab.
diff --git a/doc/python/creating-and-updating-figures.md b/doc/python/creating-and-updating-figures.md
@@ -613,20 +613,22 @@ There are also `for_each_xaxis()` and `for_each_yaxis()` methods that are analog
 ### Other Update Methods
 
 Figures created with the plotly.py graphing library also support:
-    - the `update_layout_images()` method in order to [update background layout images](/python/images/), 
-    - `update_annotations()` in order to [update annotations](/python/text-and-annotations/#multiple-annotations), 
-    - and `update-shapes()` in order to [update shapes](/python/shapes/).
+
+  - the `update_layout_images()` method in order to [update background layout images](/python/images/), 
+  - `update_annotations()` in order to [update annotations](/python/text-and-annotations/#multiple-annotations), 
+  - and `update_shapes()` in order to [update shapes](/python/shapes/).
 
 #### Chaining Figure Operations
 
 All of the figure update operations described above are methods that return a reference to the figure being modified. This makes it possible the chain multiple figure modification operations together into a single expression.
 
 Here is an example of a chained expression that creates:
-    - a faceted scatter plot with OLS trend lines using Plotly Express, 
-    - sets the title font size using `update_layout()`, 
-    - disables vertical grid lines using `update_xaxes()`, 
-    - updates the width and dash pattern of the trend lines using `update_traces()`, 
-    - and then displays the figure using `show()`.
+
+  - a faceted scatter plot with OLS trend lines using Plotly Express, 
+  - sets the title font size using `update_layout()`, 
+  - disables vertical grid lines using `update_xaxes()`, 
+  - updates the width and dash pattern of the trend lines using `update_traces()`, 
+  - and then displays the figure using `show()`.
 
 ```python
 import plotly.express as px
diff --git a/doc/python/getting-started.md b/doc/python/getting-started.md
@@ -49,13 +49,13 @@ Thanks to deep integration with the [orca](https://github.com/plotly/orca) image
 plotly.py may be installed using pip...
 
 ```
-$ pip install plotly==4.7.0
+$ pip install plotly==4.7.1
 ```
 
 or conda.
 
 ```
-$ conda install -c plotly plotly=4.7.0
+$ conda install -c plotly plotly=4.7.1
 ```
 
 This package contains everything you need to write figures to standalone HTML files.
@@ -134,10 +134,10 @@ Then run the following commands to install the required JupyterLab extensions (n
 
 ```
 # JupyterLab renderer support
-jupyter labextension install jupyterlab-plotly@4.7.0
+jupyter labextension install jupyterlab-plotly@4.7.1
 
 # OPTIONAL: Jupyter widgets extension
-jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.7.0
+jupyter labextension install @jupyter-widgets/jupyterlab-manager plotlywidget@4.7.1
 ```
 
 These packages contain everything you need to run JupyterLab...
diff --git a/packages/javascript/jupyterlab-plotly/package-lock.json b/packages/javascript/jupyterlab-plotly/package-lock.json
diff --git a/packages/javascript/jupyterlab-plotly/package.json b/packages/javascript/jupyterlab-plotly/package.json
@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-plotly",
-  "version": "4.7.0",
+  "version": "4.7.1",
   "description": "The plotly JupyterLab extension",
   "author": "The plotly.py team",
   "license": "MIT",
diff --git a/packages/javascript/plotlywidget/package-lock.json b/packages/javascript/plotlywidget/package-lock.json
diff --git a/packages/javascript/plotlywidget/package.json b/packages/javascript/plotlywidget/package.json
@@ -1,6 +1,6 @@
 {
   "name": "plotlywidget",
-  "version": "4.7.0",
+  "version": "4.7.1",
   "description": "The plotly JupyterLab extension",
   "author": "The plotly.py team",
   "license": "MIT",
diff --git a/packages/python/plotly/codegen/__init__.py b/packages/python/plotly/codegen/__init__.py
@@ -269,14 +269,14 @@ def perform_codegen():
     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'):
+        import ipywidgets as _ipywidgets
+        from distutils.version import LooseVersion as _LooseVersion
+        if _LooseVersion(_ipywidgets.__version__) >= _LooseVersion("7.0.0"):
             from ..graph_objs._figurewidget import FigureWidget
-        del LooseVersion
-        del ipywidgets
-    except ImportError:
-        pass
+        else:
+            raise ImportError()
+    except Exception:
+        from ..missing_ipywidgets import FigureWidget
 else:
     __all__.append("FigureWidget")
     orig_getattr = __getattr__
@@ -285,12 +285,17 @@ def __getattr__(import_name):
             try:
                 import ipywidgets
                 from distutils.version import LooseVersion
-                if LooseVersion(ipywidgets.__version__) >= LooseVersion('7.0.0'):
+
+                if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
                     from ..graph_objs._figurewidget import FigureWidget
+
                     return FigureWidget
-            except ImportError:
-                    pass
-        
+                else:
+                    raise ImportError()
+            except Exception:
+                from ..missing_ipywidgets import FigureWidget
+                return FigureWidget
+
         return orig_getattr(import_name)
 """
     # ### __all__ ###
diff --git a/packages/python/plotly/plotly/_widget_version.py b/packages/python/plotly/plotly/_widget_version.py
@@ -2,4 +2,4 @@
 # for automated dev builds
 #
 # It is edited by hand prior to official releases
-__frontend_version__ = "4.7.0"
+__frontend_version__ = "4.7.1"
diff --git a/packages/python/plotly/plotly/basedatatypes.py b/packages/python/plotly/plotly/basedatatypes.py
@@ -1951,8 +1951,14 @@ def _initialize_layout_template(self):
                 if self._allow_disable_validation:
                     self._layout_obj._validate = False
                 try:
-                    template_dict = pio.templates[pio.templates.default]
-                    self._layout_obj.template = template_dict
+                    if isinstance(pio.templates.default, BasePlotlyType):
+                        # Template object. Don't want to actually import `Template`
+                        # here for performance so we check against `BasePlotlyType`
+                        template_object = pio.templates.default
+                    else:
+                        # Name of registered template object
+                        template_object = pio.templates[pio.templates.default]
+                    self._layout_obj.template = template_object
                 finally:
                     self._layout_obj._validate = self._validate
 
diff --git a/packages/python/plotly/plotly/graph_objects/__init__.py b/packages/python/plotly/plotly/graph_objects/__init__.py
@@ -261,15 +261,15 @@
 
 if sys.version_info < (3, 7):
     try:
-        import ipywidgets
-        from distutils.version import LooseVersion
+        import ipywidgets as _ipywidgets
+        from distutils.version import LooseVersion as _LooseVersion
 
-        if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
+        if _LooseVersion(_ipywidgets.__version__) >= _LooseVersion("7.0.0"):
             from ..graph_objs._figurewidget import FigureWidget
-        del LooseVersion
-        del ipywidgets
-    except ImportError:
-        pass
+        else:
+            raise ImportError()
+    except Exception:
+        from ..missing_ipywidgets import FigureWidget
 else:
     __all__.append("FigureWidget")
     orig_getattr = __getattr__
@@ -284,7 +284,11 @@ def __getattr__(import_name):
                     from ..graph_objs._figurewidget import FigureWidget
 
                     return FigureWidget
-            except ImportError:
-                pass
+                else:
+                    raise ImportError()
+            except Exception:
+                from ..missing_ipywidgets import FigureWidget
+
+                return FigureWidget
 
         return orig_getattr(import_name)
diff --git a/packages/python/plotly/plotly/graph_objs/__init__.py b/packages/python/plotly/plotly/graph_objs/__init__.py
@@ -261,15 +261,15 @@
 
 if sys.version_info < (3, 7):
     try:
-        import ipywidgets
-        from distutils.version import LooseVersion
+        import ipywidgets as _ipywidgets
+        from distutils.version import LooseVersion as _LooseVersion
 
-        if LooseVersion(ipywidgets.__version__) >= LooseVersion("7.0.0"):
+        if _LooseVersion(_ipywidgets.__version__) >= _LooseVersion("7.0.0"):
             from ..graph_objs._figurewidget import FigureWidget
-        del LooseVersion
-        del ipywidgets
-    except ImportError:
-        pass
+        else:
+            raise ImportError()
+    except Exception:
+        from ..missing_ipywidgets import FigureWidget
 else:
     __all__.append("FigureWidget")
     orig_getattr = __getattr__
@@ -284,7 +284,11 @@ def __getattr__(import_name):
                     from ..graph_objs._figurewidget import FigureWidget
 
                     return FigureWidget
-            except ImportError:
-                pass
+                else:
+                    raise ImportError()
+            except Exception:
+                from ..missing_ipywidgets import FigureWidget
+
+                return FigureWidget
 
         return orig_getattr(import_name)
diff --git a/packages/python/plotly/plotly/missing_ipywidgets.py b/packages/python/plotly/plotly/missing_ipywidgets.py
@@ -0,0 +1,15 @@
+from .basedatatypes import BaseFigure
+
+
+class FigureWidget(BaseFigure):
+    """
+    FigureWidget stand-in for use when ipywidgets is not installed. The only purpose
+    of this class is to provide something to import as
+    `plotly.graph_objs.FigureWidget` when ipywidgets is not installed. This class
+    simply raises an informative error message when the constructor is called
+    """
+
+    def __init__(self, *args, **kwargs):
+        raise ImportError(
+            "Please install ipywidgets>=7.0.0 to use the FigureWidget class"
+        )
diff --git a/packages/python/plotly/plotly/tests/test_core/test_figure_widget_backend/test_missing_ipywigets.py b/packages/python/plotly/plotly/tests/test_core/test_figure_widget_backend/test_missing_ipywigets.py
@@ -0,0 +1,38 @@
+import pytest
+
+# Use wildcard import to make sure FigureWidget is always included
+from plotly.graph_objects import *
+from plotly.missing_ipywidgets import FigureWidget as FigureWidgetMissingIPywidgets
+
+try:
+    import ipywidgets as _ipywidgets
+    from distutils.version import LooseVersion as _LooseVersion
+
+    if _LooseVersion(_ipywidgets.__version__) >= _LooseVersion("7.0.0"):
+        missing_ipywidgets = False
+    else:
+        raise ImportError()
+except Exception:
+    missing_ipywidgets = True
+
+
+if missing_ipywidgets:
+
+    def test_import_figurewidget_without_ipywidgets():
+        assert FigureWidget is FigureWidgetMissingIPywidgets
+
+        with pytest.raises(ImportError):
+            # ipywidgets import error raised on construction, not import
+            FigureWidget()
+
+
+else:
+
+    def test_import_figurewidget_with_ipywidgets():
+        from plotly.graph_objs._figurewidget import (
+            FigureWidget as FigureWidgetWithIPywidgets,
+        )
+
+        assert FigureWidget is FigureWidgetWithIPywidgets
+        fig = FigureWidget()
+        assert isinstance(fig, FigureWidgetWithIPywidgets)
diff --git a/packages/python/plotly/plotly/tests/test_core/test_figure_widget_backend/test_validate_no_frames.py b/packages/python/plotly/plotly/tests/test_core/test_figure_widget_backend/test_validate_no_frames.py
@@ -2,9 +2,15 @@
 import plotly.graph_objs as go
 import pytest
 
+try:
+    go.FigureWidget()
+    figure_widget_available = True
+except ImportError:
+    figure_widget_available = False
+
 
 class TestNoFrames(TestCase):
-    if "FigureWidget" in go.__dict__.keys():
+    if figure_widget_available:
 
         def test_no_frames_in_constructor_kwarg(self):
             with pytest.raises(ValueError):
diff --git a/packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_template.py b/packages/python/plotly/plotly/tests/test_core/test_graph_objs/test_template.py
@@ -175,6 +175,12 @@ def test_template_in(self):
     def test_template_iter(self):
         self.assertIn("test_template", set(pio.templates))
 
+    def test_template_default_as_object(self):
+        template = go.layout.Template({"layout": {"font": {"family": "Rockwell"}}})
+        pio.templates.default = template
+        fig = go.Figure()
+        self.assertEqual(fig.layout.template, template)
+
 
 class TestToTemplated(TestCaseNoTemplate):
     def test_move_layout_nested_properties(self):
diff --git a/packages/python/plotly/plotlywidget/static/index.js b/packages/python/plotly/plotlywidget/static/index.js
@@ -94,7 +94,7 @@ module.exports = g;
 /* 1 */
 /***/ (function(module, exports) {
 
-module.exports = {"name":"plotlywidget","version":"4.7.0","description":"The plotly JupyterLab extension","author":"The plotly.py team","license":"MIT","main":"src/index.js","repository":{"type":"git","url":"https://github.com/plotly/plotly.py"},"keywords":["jupyter","widgets","ipython","ipywidgets","plotly"],"files":["src/**/*.js","dist/*.js","style/*.*"],"scripts":{"build":"webpack","clean":"rimraf dist/ && rimraf  ../../python/plotly/plotlywidget/static'","test":"echo \"Error: no test specified\" && exit 1"},"devDependencies":{"webpack":"^3.10.0","rimraf":"^2.6.1","ify-loader":"^1.1.0","typescript":"~3.1.1"},"dependencies":{"plotly.js":"^1.54.1","@jupyter-widgets/base":"^2.0.0 || ^3.0.0","lodash":"^4.17.4"},"jupyterlab":{"extension":"src/jupyterlab-plugin.js"}}
+module.exports = {"name":"plotlywidget","version":"4.7.1","description":"The plotly JupyterLab extension","author":"The plotly.py team","license":"MIT","main":"src/index.js","repository":{"type":"git","url":"https://github.com/plotly/plotly.py"},"keywords":["jupyter","widgets","ipython","ipywidgets","plotly"],"files":["src/**/*.js","dist/*.js","style/*.*"],"scripts":{"build":"webpack","clean":"rimraf dist/ && rimraf  ../../python/plotly/plotlywidget/static'","test":"echo \"Error: no test specified\" && exit 1"},"devDependencies":{"webpack":"^3.10.0","rimraf":"^2.6.1","ify-loader":"^1.1.0","typescript":"~3.1.1"},"dependencies":{"plotly.js":"^1.54.1","@jupyter-widgets/base":"^2.0.0 || ^3.0.0","lodash":"^4.17.4"},"jupyterlab":{"extension":"src/jupyterlab-plugin.js"}}
 
 /***/ }),
 /* 2 */

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jupyterlab-plotly",`
`3`		`- "version": "4.7.0",`
	`3`	`+ "version": "4.7.1",`
`4`	`4`	`"description": "The plotly JupyterLab extension",`
`5`	`5`	`"author": "The plotly.py team",`
`6`	`6`	`"license": "MIT",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "plotlywidget",`
`3`		`- "version": "4.7.0",`
	`3`	`+ "version": "4.7.1",`
`4`	`4`	`"description": "The plotly JupyterLab extension",`
`5`	`5`	`"author": "The plotly.py team",`
`6`	`6`	`"license": "MIT",`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`	`# for automated dev builds`
`3`	`3`	`#`
`4`	`4`	`# It is edited by hand prior to official releases`
`5`		`-__frontend_version__ = "4.7.0"`
	`5`	`+__frontend_version__ = "4.7.1"`