pfund-plot 0.0.1__py3-none-any.whl

pfund_plot/plots/line/bokeh.py

@@ -0,0 +1,137 @@
+# pyright: reportUnusedParameter=false, reportArgumentType=false
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, Literal
+
+if TYPE_CHECKING:
+    from holoviews.core.overlay import NdOverlay
+
+import narwhals as nw
+
+from pfund_plot.enums import PlottingBackend
+
+__all__ = ["control", "plot", "style"]
+
+
+DEFAULT_COLOR = "steelblue"
+DEFAULT_HEIGHT = 280
+
+
+def style(
+    title: str = "",
+    xlabel: str = "",
+    ylabel: str = "",
+    color: str = DEFAULT_COLOR,
+    bg_color: str = "",  # empty string by default because Panel will automatically use the theme color
+    grid: bool = False,
+    total_height: int | None = None,
+    height: int = DEFAULT_HEIGHT,
+    width: int | None = None,
+):
+    """
+    Args:
+        title: the title of the plot
+        xlabel: the label of the x-axis
+        ylabel: the label of the y-axis
+        color: the color of the plot, hex code is supported, only used when there is only one line
+        bg_color: the background color of the plot, hex code is supported
+        total_height: the height of the component (including the figure + widgets)
+            Default is None, when it is None, Panel will automatically adjust its height
+        height: the height of the figure
+        width: the width of the plot, since the plot is responsive, this is only used in panel layout
+        grid: whether to show the grid
+    """
+    return locals()
+
+
+def control(
+    num_data: int | None = None,
+    max_data: int | None = None,
+    slider_step: int | None = None,
+    widgets: bool = True,
+    linked_axes: bool = True,
+    update_interval: int = 5000,  # ms
+    incremental_update: bool = True,
+    datetime_precision: Literal["d", "s", "ms"] = "s",
+):
+    """
+    Args:
+        num_data: (DatetimeRangeWidget) initial number of most recent data points to display.
+        max_data: (streaming) maximum number of data points kept in memory.
+            If None, data will continue to grow unbounded.
+        slider_step: (DatetimeRangeWidget) step size in ms for the datetime range slider.
+            If None, derived from data resolution.
+        widgets: whether to show widgets. default is True.
+            For granular control, use remove_widgets() to remove specific widget classes.
+        linked_axes: whether to link axes across plots in a layout (plt.layout(...)).
+        incremental_update: (streaming) whether to update even when the bar is incomplete. default is True.
+        update_interval: (streaming) interval in ms to update the plot. default is 5000 ms.
+        datetime_precision: the precision of datetime formatting on the hover tooltip.
+            "d" for days (%Y-%m-%d), "s" for seconds (default, %Y-%m-%d %H:%M:%S), "ms" for milliseconds (%Y-%m-%d %H:%M:%S.%3N).
+    """
+    return locals()
+
+
+def plot(
+    df: nw.DataFrame[Any],
+    style: dict[str, Any],
+    control: dict[str, Any],
+    x: str | None = None,
+    y: str | list[str] | None = None,
+    **kwargs: Any,
+) -> NdOverlay:
+    import hvplot
+    from bokeh.models import CrosshairTool
+
+    from pfund_plot.plots.line import Line
+    from pfund_plot.utils.bokeh import (
+        create_bundled_hover_tool,
+        create_vline_hover_opts,
+    )
+
+    _ = hvplot.extension(PlottingBackend.bokeh)
+
+    # resolve y column names
+    x_col = x
+    y_cols = Line._derive_y_cols(df, x, y)
+    datetime_precision = control["datetime_precision"]
+
+    is_single = len(y_cols) == 1
+    crosshair_tool = CrosshairTool(
+        dimensions="height", line_color="gray", line_alpha=0.3
+    )
+    if is_single:
+        tools = [
+            create_bundled_hover_tool(df, x_col, y_cols, datetime_precision),
+            crosshair_tool,
+        ]
+    else:
+        tools = [crosshair_tool]
+
+    if is_single:
+        kwargs["color"] = style["color"]
+    else:
+        kwargs["hover_cols"] = y_cols
+
+    plot = (
+        df.to_native()
+        .hvplot.line(
+            x=x,
+            y=y,
+            tools=tools,
+            grid=style["grid"],
+            bgcolor=style["bg_color"],
+            responsive=True,
+            **kwargs,
+        )
+        .opts(
+            title=style["title"],
+            xlabel=style["xlabel"],
+            ylabel=style["ylabel"],
+            height=style["height"],
+        )
+    )
+    if not is_single:
+        plot = plot.opts(create_vline_hover_opts(df, x_col, y_cols, datetime_precision))
+
+    return plot

pfund_plot/plots/matplotlib.py

@@ -0,0 +1,32 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any, ClassVar, Literal
+
+if TYPE_CHECKING:
+    from matplotlib.figure import Figure as MatplotlibFigure
+
+from pfund_plot.enums import PlottingBackend
+from pfund_plot.plots.plot import BasePlot
+
+
+class Matplotlib(BasePlot):
+    SUPPORTED_BACKENDS: ClassVar[list[Literal[PlottingBackend.matplotlib]]] = [
+        PlottingBackend.matplotlib
+    ]
+    REQUIRED_DATA: ClassVar[bool] = False
+
+    def __init__(
+        self, fig: MatplotlibFigure, sizing_mode: str | None = None, **pane_kwargs: Any
+    ):
+        """
+        Args:
+            fig: A Matplotlib Figure object.
+            sizing_mode: Panel sizing mode: e.g. "stretch_width", "stretch_height", or "stretch_both".
+            **pane_kwargs: Additional keyword arguments passed to pn.pane.Matplotlib,
+                e.g. height, width, max_width, margin.
+        """
+        super().__init__(data=None)
+        self._plot: MatplotlibFigure = fig
+        self._pane_kwargs = pane_kwargs
+        if sizing_mode is not None:
+            self._pane_kwargs["sizing_mode"] = sizing_mode