Merge branch 'master' into shape-drawing-doc

Author: emmanuelle

.circleci/create_conda_optional_env.sh

@@ -16,7 +16,7 @@ if [ ! -d $HOME/miniconda/envs/circle_optional ]; then
     # Create environment
     # PYTHON_VERSION=2.7 or 3.5
     $HOME/miniconda/bin/conda create -n circle_optional --yes python=$PYTHON_VERSION \
-requests nbformat six retrying psutil pandas decorator pytest mock nose poppler xarray scikit-image ipython jupyter ipykernel ipywidgets
+requests nbformat six retrying psutil pandas decorator pytest mock nose poppler xarray scikit-image ipython jupyter ipykernel ipywidgets statsmodels
 
     # Install orca into environment
     $HOME/miniconda/bin/conda install --yes -n circle_optional -c plotly plotly-orca==1.3.1

CHANGELOG.md

@@ -16,6 +16,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   makes it possible to skip hover information for some arguments or to change  
   the formatting of hover informatiom [#2377](https://github.com/plotly/plotly.py/pull/2377).
 
+### Performance
+This version includes several performance improvements ([#2368](https://github.com/plotly/plotly.py/pull/2368), [#2403](https://github.com/plotly/plotly.py/pull/2403)).
+ 
+ - Child graph objects (e.g. `figure.layout.xaxis`) are no longer created eagerly during graph object construction. Instead, they are created lazily the first time the property is accessed.
+ - Property validation is now disabled for select internal operations.
+ - When used with Python 3.7 and above, ploty.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily.  This dramatically improves import times.
+
 ## [4.6] - 2020-03-31
 
 ### Updated

doc/apidoc/Makefile

@@ -18,9 +18,15 @@ help:
 # For sphinx-apidoc the first positional path is the module to document
 # then all the other ones are paths to exclude for the doc generation
 %: Makefile
+	sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*.py
+	sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*.py
+	sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*.py
+	sed -i 's/:class:`plotly.graph_objects/:class:`plotly.graph_objs/g' ../../packages/python/plotly/plotly/graph_objs/*/*/*/*.py
 	sphinx-apidoc -o generated ../../packages/python/plotly/plotly ../../packages/python/plotly/plotly/validators ../../packages/python/plotly/plotly/tests ../../packages/python/plotly/plotly/matplotlylib/ ../../packages/python/plotly/plotly/offline ../../packages/python/plotly/plotly/api
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	git checkout -- ../../packages/python/plotly/plotly/graph_objs
 	rename 's/graph_objs/graph_objects/' _build/html/*.html _build/html/generated/*.html
+	mv _build/html/generated/plotly.graph_objs.html _build/html/generated/plotly.graph_objects.html
 	sed -i 's/graph_objs/graph_objects/g' _build/html/*.html 
 	sed -i 's/graph_objs/graph_objects/g' _build/html/*.inv 
 	sed -i 's/graph_objs/graph_objects/g' _build/html/*.js 

doc/apidoc/_templates/trace.rst

@@ -15,9 +15,9 @@
 
 .. autosummary::
 
-   plotly.graph_objects.{{ objname.lower() }}
+   plotly.graph_objs.{{ objname.lower() }}
 
-.. automodule:: plotly.graph_objects.{{ objname.lower() }}
+.. automodule:: plotly.graph_objs.{{ objname.lower() }}
    :members:
    :undoc-members:
 

doc/python/animations.md

@@ -261,18 +261,6 @@ fig_dict = {
 fig_dict["layout"]["xaxis"] = {"range": [30, 85], "title": "Life Expectancy"}
 fig_dict["layout"]["yaxis"] = {"title": "GDP per Capita", "type": "log"}
 fig_dict["layout"]["hovermode"] = "closest"
-fig_dict["layout"]["sliders"] = {
-    "args": [
-        "transition", {
-            "duration": 400,
-            "easing": "cubic-in-out"
-        }
-    ],
-    "initialValue": "1952",
-    "plotlycommand": "animate",
-    "values": years,
-    "visible": True
-}
 fig_dict["layout"]["updatemenus"] = [
     {
         "buttons": [

doc/python/datashader.md

@@ -36,7 +36,7 @@ jupyter:
 
 [datashader](https://datashader.org/) creates rasterized representations of large datasets for easier visualization, with a pipeline approach consisting of several steps: projecting the data on a regular grid, creating a color representation of the grid, etc.
 
-### Passing datashader rasters as a mabox image layer
+### Passing datashader rasters as a mapbox image layer
 
 We visualize here the spatial distribution of taxi rides in New York City. A higher density
 is observed on major avenues. For more details about mapbox charts, see [the mapbox layers tutorial](/python/mapbox-layers). No mapbox token is needed here.

doc/python/hover-text-and-formatting.md

@@ -170,8 +170,10 @@ fig.show()
 ### Customizing hover text with a hovertemplate
 
 To customize the tooltip on your graph you can use the [hovertemplate](https://plotly.com/python/reference/#pie-hovertemplate) attribute of `graph_objects` tracces, which is a template string used for rendering the information that appear on hoverbox.
-This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format).
-Hovertemplate customize the tooltip text vs. [texttemplate](https://plotly.com/python/reference/#pie-texttemplate) which customizes the text that appears on your chart. <br>
+This template string can include `variables` in %{variable} format, `numbers` in [d3-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_forma), and `date` in [d3-time-format's syntax](https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format). In the example below, the empty `<extra></extra>` tag removes the part of the hover where the trace name is usually displayed in a contrasting color. The `<extra>` tag can be used to display other parts of the hovertemplate, it is not reserved for the trace name.
+
+Note that a hovertemplate customizes the tooltip text, while a [texttemplate](https://plotly.com/python/reference/#pie-texttemplate) customizes the text that appears on your chart. <br>
+
 Set the horizontal alignment of the text within tooltip with [hoverlabel.align](https://plotly.com/python/reference/#layout-hoverlabel-align).
 
 ```python

doc/python/imshow.md

@@ -6,7 +6,7 @@ jupyter:
       extension: .md
       format_name: markdown
       format_version: '1.2'
-      jupytext_version: 1.3.0
+      jupytext_version: 1.4.2
   kernelspec:
     display_name: Python 3
     language: python

doc/python/legend.md

@@ -159,7 +159,7 @@ fig.add_trace(go.Scatter(
     name="Decreasing"
 ))
 
-fig.update_layout(legend_title='<b> Trend </b>')
+fig.update_layout(legend_title_text='Trend')
 fig.show()
 ```
 

doc/python/sliders.md

@@ -33,8 +33,8 @@ jupyter:
     thumbnail: thumbnail/slider2017.gif
 ---
 
-#### Simple Slider Control
-Sliders can now be used in Plotly to change the data displayed or style of a plot!
+### Simple Slider Control
+Sliders can be used in Plotly to change the data displayed or style of a plot. 
 
 ```python
 import plotly.graph_objects as go
@@ -60,10 +60,11 @@ fig.data[10].visible = True
 steps = []
 for i in range(len(fig.data)):
     step = dict(
-        method="restyle",
-        args=["visible", [False] * len(fig.data)],
+        method="update",
+        args=[{"visible": [False] * len(fig.data)},
+              {"title": "Slider switched to step: " + str(i)}],  # layout attribute
     )
-    step["args"][1][i] = True  # Toggle i'th trace to "visible"
+    step["args"][0]["visible"][i] = True  # Toggle i'th trace to "visible"
     steps.append(step)
 
 sliders = [dict(
@@ -80,5 +81,27 @@ fig.update_layout(
 fig.show()
 ```
 
+#### Methods
+The method determines which [plotly.js function](https://plot.ly/javascript/plotlyjs-function-reference/) will be used to update the chart. Plotly can use several [updatemenu](https://plot.ly/python/reference/#layout-updatemenus-items-updatemenu-buttons-items-button-method) methods to add the slider:
+- `"restyle"`: modify **data** attributes
+- `"relayout"`: modify **layout** attributes
+- `"update"`: modify **data and layout** attributes
+- `"animate"`: start or pause an animation
+
+### Sliders in Plotly Express
+Plotly Express provide sliders, but with implicit animation. The animation can be ommited by removing `updatemenus` in the `layout`:
+
+```python
+import plotly.express as px
+
+df = px.data.gapminder()
+fig = px.scatter(df, x="gdpPercap", y="lifeExp", animation_frame="year", animation_group="country",
+           size="pop", color="continent", hover_name="country",
+           log_x=True, size_max=55, range_x=[100,100000], range_y=[25,90])
+
+fig["layout"].pop("updatemenus") # optional, drop animation buttons
+fig.show()
+```
+
 #### Reference
 Check out https://plotly.com/python/reference/#layout-updatemenus for more information!

doc/python/sunburst-charts.md

@@ -196,7 +196,7 @@ fig.show()
 
 With branchvalues "total", the value of the parent represents the width of its wedge. In the example below, "Enoch" is 4 and "Awan" is 6 and so Enoch's width is 4/6ths of Awans. With branchvalues "remainder", the parent's width is determined by its own value plus those of its children. So, Enoch's width is 4/10ths of Awan's (4 / (6 + 4)).
 
-Note that this means that the sum of the values of the children cannot exceed the value of their parent when branchvalues "total". When branchvalues "relative" (the default), children will not take up all of the space below their parent (unless the parent is the root and it has a value of 0).
+Note that this means that the sum of the values of the children cannot exceed the value of their parent when branchvalues is set to "total". When branchvalues is set to "remainder" (the default), children will not take up all of the space below their parent (unless the parent is the root and it has a value of 0).
 
 ```python
 import plotly.graph_objects as go