Merge branch 'compose_figs' of github.com:predict-idlab/plotly-resampler into compose_figs

Author: jonasvdd

plotly_resampler/figure_resampler/figure_resampler.py

@@ -42,7 +42,7 @@ def __init__(
         verbose: bool = False,
     ):
         # Parse the figure input before calling `super`
-        if is_figure(figure) and not is_fr(figure):
+        if is_figure(figure) and not is_fr(figure):  # go.Figure
             # Base case, the figure does not need to be adjusted
             f = figure
         else:
@@ -51,7 +51,7 @@ def __init__(
             f = go.Figure()
             f._data_validator.set_uid = False
 
-            if isinstance(figure, BaseFigure):
+            if isinstance(figure, BaseFigure):  # go.FigureWidget or AbstractFigureAggregator
                 # A base figure object, we first copy the layout and grid ref
                 f.layout = figure.layout
                 f._grid_ref = figure._grid_ref

plotly_resampler/figure_resampler/figure_resampler_interface.py

@@ -675,7 +675,7 @@ def _construct_hf_data_dict(
         max_n_samples: int | None,
         offset=0,
     ) -> dict:
-        """Create the `hf_data` dict item which will be put in the `_hf_data` property.
+        """Create the `hf_data` dict which will be put in the `_hf_data` property.
 
         Parameters
         ----------
@@ -695,7 +695,6 @@ def _construct_hf_data_dict(
         """
         # We will re-create this each time as hf_x and hf_y withholds
         # high-frequency data
-        # index = pd.Index(hf_x, copy=False, name="timestamp")
         hf_series = self._to_hf_series(x=dc.x, y=dc.y)
 
         # Checking this now avoids less interpretable `KeyError` when resampling
@@ -856,7 +855,7 @@ def add_trace(
             trace = self._data_validator.validate_coerce(trace)[0]
 
         # First add an UUID, as each (even the non-hf_data traces), must contain this
-        # key for comparison, if the trace already has an UUID, we will keep it.
+        # key for comparison. If the trace already has an UUID, we will keep it.
         uuid_str = str(uuid4()) if trace.uid is None else trace.uid
         trace.uid = uuid_str
 
@@ -976,7 +975,7 @@ def add_traces(
         ]
 
         # First add an UUID, as each (even the non-hf_data traces), must contain this
-        # key for comparison, if the trace already has an UUID, we will keep it.
+        # key for comparison. If the trace already has an UUID, we will keep it.
         for trace in data:
             uuid_str = str(uuid4()) if trace.uid is None else trace.uid
             trace.uid = uuid_str

plotly_resampler/figure_resampler/figurewidget_resampler.py

@@ -13,10 +13,10 @@
 from typing import Tuple
 
 import plotly.graph_objects as go
+from plotly.basedatatypes import BaseFigure
 
-from .figure_resampler_interface import AbstractFigureAggregator
 from ..aggregation import AbstractSeriesAggregator, EfficientLTTB
-from plotly.basedatatypes import BaseFigure
+from .figure_resampler_interface import AbstractFigureAggregator
 
 
 class _FigureWidgetResamplerM(type(AbstractFigureAggregator), type(go.FigureWidget)):
@@ -51,16 +51,14 @@ def __init__(
         show_mean_aggregation_size: bool = True,
         verbose: bool = False,
     ):
-
         # Parse the figure input before calling `super`
         f = go.FigureWidget()
         f._data_validator.set_uid = False
 
-        if isinstance(figure, BaseFigure):
+        if isinstance(figure, BaseFigure):  # go.Figure or go.FigureWidget or AbstractFigureAggregator
             # A base figure object, we first copy the layout and grid ref
             f.layout = figure.layout
             f._grid_ref = figure._grid_ref
-
             f.add_traces(figure.data)
         elif isinstance(figure, (dict, list)):
             # A single trace dict or a list of traces

plotly_resampler/figure_resampler/utils.py

@@ -12,7 +12,7 @@
 
 
 def is_figure(figure: Any) -> bool:
-    """Check if the figure is a plotly go.Figure.
+    """Check if the figure is a plotly go.Figure or a FigureResampler.
 
     .. Note::
         This method does not use isinstance(figure, go.Figure) as this will not work
@@ -27,18 +27,18 @@ def is_figure(figure: Any) -> bool:
     Returns
     -------
     bool
-        True if the figure is a plotly go.Figure.
+        True if the figure is a plotly go.Figure or a FigureResampler.
     """
 
     return isinstance(figure, BaseFigure) and (not isinstance(figure, BaseFigureWidget))
 
 
-def is_fr(figure: Any) -> bool:
-    """Check if the figure is a plotly FigureResampler.
+def is_figurewidget(figure: Any):
+    """Check if the figure is a plotly go.FigureWidget or a FigureWidgetResampler.
 
     .. Note::
-        This method does not use isinstance(figure, go.Figure) as this will not work
-        when go.Figure is decorated (after executing the
+        This method does not use isinstance(figure, go.FigureWidget) as this will not
+        work when go.FigureWidget is decorated (after executing the
         ``register_plotly_resampler`` function).
 
     Parameters
@@ -49,20 +49,16 @@ def is_fr(figure: Any) -> bool:
     Returns
     -------
     bool
-        True if the figure is a plotly go.Figure.
+        True if the figure is a plotly go.FigureWidget or a FigureWidgetResampler.
     """
-    from plotly_resampler import FigureResampler
-
-    return isinstance(figure, FigureResampler)
+    return isinstance(figure, BaseFigureWidget)
 
 
-def is_fwr(figure: Any) -> bool:
-    """Check if the figure is a plotly FigureWidgetResampler.
+def is_fr(figure: Any) -> bool:
+    """Check if the figure is a FigureResampler.
 
     .. Note::
-        This method does not use isinstance(figure, go.Figure) as this will not work
-        when go.Figure is decorated (after executing the
-        ``register_plotly_resampler`` function).
+        This method will not return True if the figure is a plotly go.Figure.
 
     Parameters
     ----------
@@ -72,20 +68,18 @@ def is_fwr(figure: Any) -> bool:
     Returns
     -------
     bool
-        True if the figure is a plotly go.Figure.
+        True if the figure is a FigureResampler.
     """
-    from plotly_resampler import FigureWidgetResampler
+    from plotly_resampler import FigureResampler
 
-    return isinstance(figure, FigureWidgetResampler)
+    return isinstance(figure, FigureResampler)
 
 
-def is_figurewidget(figure: Any):
-    """Check if the figure is a plotly go.FigureWidget.
+def is_fwr(figure: Any) -> bool:
+    """Check if the figure is a FigureWidgetResampler.
 
     .. Note::
-        This method does not use isinstance(figure, go.FigureWidget) as this will not
-        work when go.FigureWidget is decorated (after executing the
-        ``register_plotly_resampler`` function).
+        This method will not return True if the figure is a plotly go.FigureWidget.
 
     Parameters
     ----------
@@ -95,9 +89,11 @@ def is_figurewidget(figure: Any):
     Returns
     -------
     bool
-        True if the figure is a plotly go.FigureWidget.
+        True if the figure is a FigureWidgetResampler.
     """
-    return isinstance(figure, BaseFigureWidget)
+    from plotly_resampler import FigureWidgetResampler
+
+    return isinstance(figure, FigureWidgetResampler)
 
 
 ### Rounding functions for bin size

tests/test_figure_resampler.py

@@ -574,7 +574,7 @@ def test_multiple_tz_no_tz_series_slicing():
         t_start = t_start.tz_localize(cs[(i + 1) % len(cs)].index.tz)
         t_stop = t_stop.tz_localize(cs[(i + 2) % len(cs)].index.tz)
 
-        # Now the assumption cannot be made that s ahd the same time-zone as the
+        # Now the assumption cannot be made that s has the same time-zone as the
         # timestamps -> AssertionError will be raised.
         with pytest.raises(AssertionError):
             fig._slice_time(s.tz_localize(None), t_start, t_stop)

tests/test_figurewidget_resampler.py

@@ -578,7 +578,7 @@ def test_multiple_tz_no_tz_series_slicing():
         t_start = t_start.tz_localize(cs[(i + 1) % len(cs)].index.tz)
         t_stop = t_stop.tz_localize(cs[(i + 2) % len(cs)].index.tz)
 
-        # Now the assumption cannot be made that s ahd the same time-zone as the
+        # Now the assumption cannot be made that s has the same time-zone as the
         # timestamps -> AssertionError will be raised.
         with pytest.raises(AssertionError):
             fig._slice_time(s.tz_localize(None), t_start, t_stop)

tests/test_utils.py

@@ -3,6 +3,8 @@
 from plotly_resampler.figure_resampler.utils import (
     is_figure,
     is_figurewidget,
+    is_fr,
+    is_fwr,
     timedelta_to_str,
     round_td_str,
     round_number_str,
@@ -24,6 +26,20 @@ def test_is_figure():
     assert not is_figure(FigureWidgetResampler(fig_dict))
 
 
+def test_is_fr():
+    fig_dict = {"type": "scatter", "y": [1, 2, 3]}
+    assert is_fr(FigureResampler())
+    assert is_fr(FigureResampler(fig_dict))
+    assert not is_fr(go.Figure())
+    assert not is_fr(go.Figure(fig_dict))
+    assert not is_fr(go.FigureWidget())
+    assert not is_fr(None)
+    assert not is_fr(fig_dict)
+    assert not is_fr(go.Scatter(y=[1, 2, 3]))
+    assert not is_fr(FigureWidgetResampler())
+    assert not is_fr(FigureWidgetResampler(fig_dict))
+
+
 def test_is_figurewidget():
     fig_dict = {"type": "scatter", "y": [1, 2, 3]}
     assert is_figurewidget(go.FigureWidget())
@@ -38,6 +54,20 @@ def test_is_figurewidget():
     assert not is_figurewidget(FigureResampler(fig_dict))
 
 
+def test_is_fwr():
+    fig_dict = {"type": "scatter", "y": [1, 2, 3]}
+    assert is_fwr(FigureWidgetResampler())
+    assert is_fwr(FigureWidgetResampler(fig_dict))
+    assert not is_fwr(go.FigureWidget())
+    assert not is_fwr(go.FigureWidget(fig_dict))
+    assert not is_fwr(go.Figure())
+    assert not is_fwr(None)
+    assert not is_fwr(fig_dict)
+    assert not is_fwr(go.Scatter(y=[1, 2, 3]))
+    assert not is_fwr(FigureResampler())
+    assert not is_fwr(FigureResampler(fig_dict))
+
+
 def test_timedelta_to_str():
     assert (round_td_str(pd.Timedelta("1W"))) == "7D"
     assert (timedelta_to_str(pd.Timedelta("1W"))) == "7D"