🚲 add show_dash_kwargs to FigureResampler constructor

Author: jvdd

plotly_resampler/figure_resampler/figure_resampler.py

@@ -11,7 +11,7 @@
 __author__ = "Jonas Van Der Donckt, Jeroen Van Der Donckt, Emiel Deprost"
 
 import warnings
-from typing import Tuple
+from typing import Tuple, List
 
 import dash
 import plotly.graph_objects as go
@@ -41,6 +41,7 @@ def __init__(
         show_mean_aggregation_size: bool = True,
         convert_traces_kwargs: dict | None = None,
         verbose: bool = False,
+        show_dash_kwargs: dict | None = None,
     ):
         # `pr_props`` is a variable to store properties of a plotly-resampler figure
         # This variable will only be set when loading a pickled plotly-resampler figure
@@ -85,6 +86,8 @@ def __init__(
                 # A single trace dict or a list of traces
                 f.add_traces(figure)
 
+        self._show_dash_kwargs = show_dash_kwargs if show_dash_kwargs is not None else {}
+
         super().__init__(
             f,
             convert_existing_traces,
@@ -155,6 +158,8 @@ def show_dash(
             See more https://dash.plotly.com/dash-core-components/graph
         **kwargs: dict
             Additional app.run_server() kwargs. e.g.: port
+            Note that these kwargs take precedence over the ones passed to the
+            constructor via the ``show_dash_kwargs`` argument.
 
         """
         graph_properties = {} if graph_properties is None else graph_properties
@@ -184,6 +189,9 @@ def show_dash(
             fig_height = self.layout.height if self.layout.height is not None else 450
             kwargs["height"] = fig_height + 18
 
+        # kwargs take precedence over the show_dash_kwargs
+        kwargs = {**self._show_dash_kwargs, **kwargs}
+
         # Store the app information, so it can be killed
         self._app = app
         self._host = kwargs.get("host", "127.0.0.1")
@@ -241,5 +249,10 @@ def register_update_graph_callback(
             prevent_initial_call=True,
         )(self.construct_update_data)
 
+    def _get_pr_props_keys(self) -> List[str]:
+        # Add the additional plotly-resampler properties of this class
+        return super()._get_pr_props_keys() + ["_show_dash_kwargs"]
+
     def _ipython_display_(self):
-        return self.show_dash(mode="inline")
+        # To display the figure inline as a dash app
+        self.show_dash(mode="inline")

plotly_resampler/figure_resampler/figure_resampler_interface.py

@@ -1273,6 +1273,25 @@ def _re_matches(regex: re.Pattern, strings: Iterable[str]) -> List[str]:
         return sorted(matches)
 
     ## Magic methods (to use plotly.py words :grin:)
+
+    def _get_pr_props_keys(self) -> List[str]:
+        """Returns the keys (i.e., the names) of the plotly-resampler properties.
+
+        Note
+        ----
+        This method is used to serialize the object in the `__reduce__` method.
+
+        """
+        return [
+            "_hf_data",
+            "_global_n_shown_samples",
+            "_print_verbose",
+            "_show_mean_aggregation_size",
+            "_prefix",
+            "_suffix",
+            "_global_downsampler",
+        ]
+
     def __reduce__(self):
         """Overwrite the reduce method (which is used to support deep copying and
         pickling).
@@ -1288,15 +1307,6 @@ def __reduce__(self):
 
         # Add the plotly-resampler properties
         props["pr_props"] = {}
-        pr_keys = [
-            "_hf_data",
-            "_global_n_shown_samples",
-            "_print_verbose",
-            "_show_mean_aggregation_size",
-            "_prefix",
-            "_suffix",
-            "_global_downsampler",
-        ]
-        for k in pr_keys:
+        for k in self._get_pr_props_keys():
             props["pr_props"][k] = getattr(self, k)
         return (self.__class__, (props,))  # (props,) to comply with plotly magic

tests/test_serialization.py

@@ -1,3 +1,4 @@
+from hashlib import sha1
 import plotly.graph_objects as go
 import plotly.express as px
 import numpy as np
@@ -23,14 +24,16 @@ def test_pickle_figure_resampler(pickle_figure):
     nb_traces = 3
     nb_samples = 5_007
 
-    fig = FigureResampler(default_n_shown_samples=50)
+    fig = FigureResampler(default_n_shown_samples=50, show_dash_kwargs=dict(port=8051))
     for i in range(nb_traces):
         fig.add_trace(go.Scattergl(name=f"trace--{i}"), hf_y=np.arange(nb_samples))
+    assert fig._show_dash_kwargs["port"] == 8051
 
     pickle.dump(fig, open(pickle_figure, "wb"))
     fig_pickle = pickle.load(open(pickle_figure, "rb"))
 
     assert isinstance(fig_pickle, FigureResampler)
+    assert fig_pickle._show_dash_kwargs["port"] == 8051
     assert len(fig_pickle.data) == nb_traces
     assert len(fig_pickle.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -73,20 +76,22 @@ def test_pickle_figure_resampler_registered(registering_cleanup, pickle_figure):
     nb_traces = 4
     nb_samples = 5_043
 
-    register_plotly_resampler(mode="figure", default_n_shown_samples=50)
+    register_plotly_resampler(mode="figure", default_n_shown_samples=50, show_dash_kwargs=dict(port=8051))
 
     fig = go.Figure()
     for i in range(nb_traces):
         fig.add_trace(go.Scattergl(name=f"trace--{i}"), hf_y=np.arange(nb_samples))
     assert isinstance(fig, FigureResampler)
     assert not isinstance(fig, FigureWidgetResampler)
+    assert fig._show_dash_kwargs["port"] == 8051
 
     pickle.dump(fig, open(pickle_figure, "wb"))
 
     # Loading with PR registered
     assert isinstance(go.Figure(), FigureResampler)
     fig_pickle = pickle.load(open(pickle_figure, "rb"))
     assert isinstance(fig_pickle, FigureResampler)
+    assert fig_pickle._show_dash_kwargs["port"] == 8051
     assert len(fig_pickle.data) == nb_traces
     assert len(fig_pickle.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -104,6 +109,7 @@ def test_pickle_figure_resampler_registered(registering_cleanup, pickle_figure):
     assert not isinstance(go.Figure(), FigureResampler)
     fig_pickle = pickle.load(open(pickle_figure, "rb"))
     assert isinstance(fig_pickle, FigureResampler)
+    assert fig_pickle._show_dash_kwargs["port"] == 8051
     assert len(fig_pickle.data) == nb_traces
     assert len(fig_pickle.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -121,6 +127,7 @@ def test_pickle_figure_resampler_registered(registering_cleanup, pickle_figure):
     assert not isinstance(go.Figure(), FigureResampler)
     fig_pickle = pickle.load(open(pickle_figure, "rb"))
     assert isinstance(fig_pickle, FigureResampler)
+    assert fig_pickle._show_dash_kwargs["port"] == 8051
     assert len(fig_pickle.data) == nb_traces
     assert len(fig_pickle.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -138,6 +145,7 @@ def test_pickle_figure_resampler_registered(registering_cleanup, pickle_figure):
     pickle.dump(fig, open(pickle_figure, "wb"))
     fig_pickle = pickle.load(open(pickle_figure, "rb"))
     assert isinstance(fig_pickle, FigureResampler)
+    assert fig_pickle._show_dash_kwargs["port"] == 8051
     assert len(fig_pickle.data) == nb_traces
     assert len(fig_pickle.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -239,13 +247,15 @@ def test_copy_and_deepcopy_figure_resampler():
     nb_traces = 3
     nb_samples = 3_243
 
-    fig = FigureResampler(default_n_shown_samples=50)
+    fig = FigureResampler(default_n_shown_samples=50, show_dash_kwargs=dict(port=8051))
     for i in range(nb_traces):
         fig.add_trace(go.Scattergl(name=f"trace--{i}"), hf_y=np.arange(nb_samples))
+    assert fig._show_dash_kwargs["port"] == 8051
 
     fig_copy = copy.copy(fig)
 
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -260,6 +270,7 @@ def test_copy_and_deepcopy_figure_resampler():
     fig_copy = copy.deepcopy(fig)
 
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -314,18 +325,20 @@ def test_copy_figure_resampler_registered():
     nb_traces = 3
     nb_samples = 4_069
 
-    register_plotly_resampler(mode="figure", default_n_shown_samples=50)
+    register_plotly_resampler(mode="figure", default_n_shown_samples=50, show_dash_kwargs=dict(port=8051))
 
     fig = go.Figure()
     for i in range(nb_traces):
         fig.add_trace(go.Scattergl(name=f"trace--{i}"), hf_y=np.arange(nb_samples))
     assert isinstance(fig, FigureResampler)
     assert not isinstance(fig, FigureWidgetResampler)
+    assert fig._show_dash_kwargs["port"] == 8051
 
     # Copy with PR registered
     fig_copy = copy.copy(fig)
     assert isinstance(go.Figure(), FigureResampler)
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -343,6 +356,7 @@ def test_copy_figure_resampler_registered():
     assert not isinstance(go.Figure(), FigureResampler)
     fig_copy = copy.copy(fig)
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -360,6 +374,7 @@ def test_copy_figure_resampler_registered():
     assert not isinstance(go.Figure(), FigureResampler)
     fig_copy = copy.copy(fig)
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -376,18 +391,20 @@ def test_deepcopy_figure_resampler_registered():
     nb_traces = 4
     nb_samples = 3_169
 
-    register_plotly_resampler(mode="figure", default_n_shown_samples=50)
+    register_plotly_resampler(mode="figure", default_n_shown_samples=50, show_dash_kwargs=dict(port=8051))
 
     fig = go.Figure()
     for i in range(nb_traces):
         fig.add_trace(go.Scattergl(name=f"trace--{i}"), hf_y=np.arange(nb_samples))
     assert isinstance(fig, FigureResampler)
     assert not isinstance(fig, FigureWidgetResampler)
+    assert fig._show_dash_kwargs["port"] == 8051
 
     # Copy with PR registered
     fig_copy = copy.deepcopy(fig)
     assert isinstance(go.Figure(), FigureResampler)
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -405,6 +422,7 @@ def test_deepcopy_figure_resampler_registered():
     assert not isinstance(go.Figure(), FigureResampler)
     fig_copy = copy.deepcopy(fig)
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):
@@ -422,6 +440,7 @@ def test_deepcopy_figure_resampler_registered():
     assert not isinstance(go.Figure(), FigureResampler)
     fig_copy = copy.deepcopy(fig)
     assert isinstance(fig_copy, FigureResampler)
+    assert fig_copy._show_dash_kwargs["port"] == 8051
     assert len(fig_copy.data) == nb_traces
     assert len(fig_copy.hf_data) == nb_traces
     for i in range(nb_traces):