Merge branch 'main' into orjson_werkzeug

Author: jonasvdd

.github/workflows/deploy-docs.yml

@@ -18,8 +18,8 @@ jobs:
         python-version: 3.8
 
     - run: sudo apt-get install python3-sphinx 
-    - name: Install poetry
-      uses: Gr1N/setup-poetry@v4
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
     - name: Cache poetry
       id: cached-poetry-dependencies
       uses: actions/cache@v2

CONTRIBUTING.md

@@ -84,7 +84,7 @@ poetry build  # build the underlying C code
 You can run the test with the following code:
 
 ```sh
-poetry run pytest --cov-report term-missing --cov=plotly-resampler tests
+poetry run pytest --cov-report term-missing --cov=plotly_resampler tests
 ```
 
 To get the selenium tests working you should have Google Chrome installed.

plotly_resampler/figure_resampler/figure_resampler_interface.py

@@ -800,6 +800,23 @@ def _construct_hf_data_dict(
             "hovertext": dc.hovertext,
         }
 
+    @staticmethod
+    def _add_trace_to_add_traces_kwargs(kwargs: dict) -> dict:
+        """Convert the `add_trace` kwargs to the `add_traces` kwargs."""
+        # The keywords that need to be converted to a list
+        convert_keywords = ["row", "col", "secondary_y"]
+
+        updated_kwargs = {}  # The updated kwargs (from `add_trace` to `add_traces`)
+        for keyword in convert_keywords:
+            value = kwargs.pop(keyword, None)
+            if value is not None:
+                updated_kwargs[f"{keyword}s"] = [value]
+            else:
+                updated_kwargs[f"{keyword}s"] = None
+    
+        return {**kwargs, **updated_kwargs}
+
+
     def add_trace(
         self,
         trace: Union[BaseTraceType, dict],
@@ -961,17 +978,22 @@ def add_trace(
                 # Hence, you first downsample the trace.
                 trace = self._check_update_trace_data(trace)
                 assert trace is not None
-                return super(self._figure_class, self).add_trace(trace, **trace_kwargs)
+                return super(AbstractFigureAggregator, self).add_traces(
+                    [trace], **self._add_trace_to_add_traces_kwargs(trace_kwargs)
+                )
             else:
                 self._print(f"[i] NOT resampling {trace['name']} - len={n_samples}")
                 # TODO: can be made more generic
                 trace.x = dc.x
                 trace.y = dc.y
                 trace.text = dc.text
                 trace.hovertext = dc.hovertext
-                return super(self._figure_class, self).add_trace(trace, **trace_kwargs)
-
-        return super(self._figure_class, self).add_trace(trace, **trace_kwargs)
+                return super(AbstractFigureAggregator, self).add_traces(
+                    [trace], **self._add_trace_to_add_traces_kwargs(trace_kwargs)
+                )
+        return super(AbstractFigureAggregator, self).add_traces(
+            [trace], **self._add_trace_to_add_traces_kwargs(trace_kwargs)
+        )
 
     def add_traces(
         self,
@@ -1158,7 +1180,8 @@ def replace(self, figure: go.Figure, convert_existing_traces: bool = True):
         )
 
     def construct_update_data(
-        self, relayout_data: dict
+        self,
+        relayout_data: dict,
     ) -> Union[List[dict], dash.no_update]:
         """Construct the to-be-updated front-end data, based on the layout change.
 

tests/test_figure_resampler.py

@@ -139,6 +139,18 @@ def test_various_dtypes(float_series):
                 limit_to_view=True,
             )
 
+def test_max_n_samples(float_series):
+    s = float_series[:5000]
+
+    fig = FigureResampler()
+    fig.add_trace(
+        go.Scattergl(name="test"), hf_x=s.index, hf_y=s, max_n_samples=len(s) + 1
+    )
+    # make sure that there is not hf_data
+    assert len(fig.hf_data) == 0
+    assert len(fig.data[0]["x"]) == len(s)
+
+
 def test_add_scatter_trace_no_data():
     fig = FigureResampler(default_n_shown_samples=1000)
 
@@ -1082,7 +1094,7 @@ def test_fr_update_layout_axes_range(driver):
         y=np.arange(nb_datapoints)
     )
 
-    def check_data(fr: FigureResampler, min_v=0, max_v=nb_datapoints-1):
+    def check_data(fr: FigureResampler, min_v=0, max_v=nb_datapoints - 1):
         # closure for n_shown and nb_datapoints
         assert len(fr.data[0]["y"]) == min(n_shown, nb_datapoints)
         assert len(fr.data[0]["x"]) == min(n_shown, nb_datapoints)
@@ -1158,7 +1170,7 @@ def check_data(fr: FigureResampler, min_v=0, max_v=nb_datapoints-1):
     finally:
         proc.terminate()
         f_pr.stop_server()
-    
+
 
 def test_fr_update_layout_axes_range_no_update(driver):
     nb_datapoints = 2_000
@@ -1170,7 +1182,7 @@ def test_fr_update_layout_axes_range_no_update(driver):
         y=np.arange(nb_datapoints)
     )
 
-    def check_data(fr: FigureResampler, min_v=0, max_v=nb_datapoints-1):
+    def check_data(fr: FigureResampler, min_v=0, max_v=nb_datapoints - 1):
         # closure for n_shown and nb_datapoints
         assert len(fr.data[0]["y"]) == min(n_shown, nb_datapoints)
         assert len(fr.data[0]["x"]) == min(n_shown, nb_datapoints)

tests/test_figure_resampler_selenium.py

@@ -657,3 +657,31 @@ def test_multi_trace_go_figure(driver, multi_trace_go_figure):
         raise e
     finally:
         proc.terminate()
+
+
+def test_multi_trace_go_figure_updated_xrange(driver, multi_trace_go_figure):
+    # This test checks that the xaxis range is updated when the xaxis range is set
+    # Notet hat this test just hits the .show_dash() method
+    from pytest_cov.embed import cleanup_on_sigterm
+
+    cleanup_on_sigterm()
+
+    multi_trace_go_figure.update_xaxes(range=[100, 200_000])
+
+    port = 9038
+    proc = multiprocessing.Process(
+        target=multi_trace_go_figure.show_dash,
+        kwargs=dict(mode="external", port=port),
+    )
+    proc.start()
+    try:
+        # Just hit the code of the .show_dash method when an x-range is set
+        time.sleep(1)
+        fr = FigureResamplerGUITests(driver, port=port)
+        time.sleep(1)
+        fr.go_to_page()
+
+    except Exception as e:
+        raise e
+    finally:
+        proc.terminate()