openbb-charting 2.3.2__tar.gz → 2.4.0__tar.gz

{openbb_charting-2.3.2 → openbb_charting-2.4.0}/PKG-INFO

@@ -1,22 +1,22 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: openbb-charting
-Version: 2.3.2
+Version: 2.4.0
 Summary: Charting extension for OpenBB
 License: AGPL-3.0-only
 Author: OpenBB Team
 Author-email: hello@openbb.co
-Requires-Python: >=3.9,<3.13
+Requires-Python: >=3.9.21,<3.14
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Provides-Extra: pywry
 Requires-Dist: nbformat (>=5.10.0,<6.0.0)
-Requires-Dist: openbb-core (>=1.4.0,<2.0.0)
-Requires-Dist: pandas-ta-openbb (>=0.4.20,<0.5.0)
-Requires-Dist: plotly (>=5.24.1,<6.0.0)
+Requires-Dist: openbb-core (>=1.5.1,<2.0.0)
+Requires-Dist: pandas-ta-openbb (>=0.4.22,<0.5.0)
+Requires-Dist: plotly (>=6.3.1,<7.0.0)
 Requires-Dist: pywry (>=0.6.2,<0.7.0) ; extra == "pywry"
 Description-Content-Type: text/markdown
 

{openbb_charting-2.3.2 → openbb_charting-2.4.0}/openbb_charting/charting.py

@@ -18,6 +18,7 @@ from typing import (
 from warnings import warn
 
 from importlib_metadata import entry_points
+from openbb_core.app.model.abstract.error import OpenBBError
 from openbb_core.app.model.charts.chart import Chart
 from openbb_core.app.model.obbject import OBBject
 from openbb_core.provider.abstract.data import Data
@@ -122,8 +123,8 @@ class Charting:
 
         create_backend(self._charting_settings)
         backend = get_backend()
-        backend.start(debug=self._charting_settings.debug_mode)
-        return backend
+        backend.start(debug=self._charting_settings.debug_mode)  # type: ignore
+        return backend  # type: ignore
 
     def _get_chart_function(self, route: str) -> Callable:
         """Given a route, it returns the chart function. The module must contain the given route."""
@@ -178,9 +179,9 @@ class Charting:
             else None
         )
         data_as_df: DataFrame = (
-            basemodel_to_df(convert_to_basemodel(data), index=index)
+            basemodel_to_df(convert_to_basemodel(data), index=index)  # type: ignore
             if has_data
-            else self._obbject.to_dataframe(index=index)
+            else self._obbject.to_dataframe(index=index)  # type: ignore
         )
         if "date" in data_as_df.columns:
             data_as_df = data_as_df.set_index("date")
@@ -369,6 +370,65 @@ class Charting:
 
         return fig
 
+    def create_3d_surface(
+        self,
+        X: "Series",
+        Y: "Series",
+        Z: "Series",
+        xtitle: Optional[str] = "DTE",
+        ytitle: Optional[str] = "Strike",
+        ztitle: Optional[str] = "IV",
+        colorscale: Optional[Union[str, list]] = None,
+        title: Optional[str] = None,
+        layout_kwargs: Optional[dict[str, Any]] = None,
+        theme: Optional[Literal["dark", "light"]] = None,
+    ) -> Union["OpenBBFigure", "Figure"]:
+        """Create a 3D surface chart.
+
+        Parameters
+        ----------
+        X : pd.Series
+            The x-axis data.
+        Y : pd.Series
+            The y-axis data.
+        Z : pd.Series
+            The z-axis data.
+        xtitle : str, optional
+            The title for the x-axis, by default "DTE".
+        ytitle : str, optional
+            The title for the y-axis, by default "Strike".
+        ztitle : str, optional
+            The title for the z-axis, by default "IV".
+        colorscale : Union[str, list], optional
+            The colorscale to use for the surface, by default None.
+        title : str, optional
+            The title of the chart, by default None.
+        layout_kwargs : Optional[dict[str, Any]], optional
+            Additional keyword arguments to apply with figure.update_layout(), by default None.
+
+        Returns
+        -------
+        OpenBBFigure
+            The OpenBBFigure object.
+        """
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.charts.generic_charts import surface3d
+
+        fig = surface3d(
+            X=X,
+            Y=Y,
+            Z=Z,
+            xtitle=xtitle,
+            ytitle=ytitle,
+            ztitle=ztitle,
+            colorscale=colorscale,
+            title=title,
+            layout_kwargs=layout_kwargs,
+            theme=theme,
+        )
+        fig = self._set_chart_style(fig)
+        return fig
+
     def create_correlation_matrix(
         self,
         data: Union[
@@ -417,7 +477,6 @@ class Charting:
         fig = self._set_chart_style(fig)
         return fig
 
-    # pylint: disable=inconsistent-return-statements
     def show(self, render: bool = True, **kwargs):
         """Display chart and save it to the OBBject."""
         try:
@@ -435,24 +494,27 @@ class Charting:
             kwargs["provider"] = self._obbject.provider
             kwargs["extra"] = self._obbject.extra
             fig, content = charting_function(**kwargs)
-            fig = self._set_chart_style(fig)
-            content = fig.show(external=True, **kwargs).to_plotly_json()
             self._obbject.chart = Chart(fig=fig, content=content, format=self._format)
             if render:
                 fig.show(**kwargs)
+
+        except (RuntimeError, OpenBBError) as e:
+            raise e from e
+
         except Exception:  # pylint: disable=W0718
             try:
                 fig = self.create_line_chart(data=self._obbject.results, render=False, **kwargs)  # type: ignore
-                fig = self._set_chart_style(fig)
+                fig = self._set_chart_style(fig)  # type: ignore
                 content = fig.show(external=True, **kwargs).to_plotly_json()  # type: ignore
                 self._obbject.chart = Chart(
                     fig=fig, content=content, format=self._format
                 )
                 if render:
-                    return fig.show(**kwargs)  # type: ignore
+                    fig.show(**kwargs)  # type: ignore
             except Exception as e:
                 raise RuntimeError(
                     "Failed to automatically create a generic chart with the data provided."
+                    + f" -> {e} -> {e.args}"
                 ) from e
 
     # pylint: disable=too-many-locals,inconsistent-return-statements
@@ -556,7 +618,7 @@ class Charting:
         except Exception:  # pylint: disable=W0718
             try:
                 fig = self.create_line_chart(data=data_as_df, render=False, **kwargs)
-                fig = self._set_chart_style(fig)
+                fig = self._set_chart_style(fig)  # type: ignore
                 content = fig.show(external=True, **kwargs).to_plotly_json()  # type: ignore
                 self._obbject.chart = Chart(
                     fig=fig, content=content, format=self._format
@@ -590,11 +652,11 @@ class Charting:
         new = "light" if current == "dark" else "dark"
         self._charting_settings.chart_style = new
         figure = self._obbject.chart.fig  # type: ignore[union-attr]
-        updated_figure = self._set_chart_style(figure)
+        updated_figure = self._set_chart_style(figure)  # type: ignore[union-attr]
         self._obbject.chart.fig = updated_figure  # type: ignore[union-attr]
         self._obbject.chart.content = updated_figure.show(  # type: ignore[union-attr]
             external=True
-        ).to_plotly_json()
+        ).to_plotly_json()  # type: ignore[union-attr]
 
     @staticmethod
     def _convert_to_string(x):

{openbb_charting-2.3.2 → openbb_charting-2.4.0}/openbb_charting/charts/generic_charts.py

@@ -58,7 +58,7 @@ def line_chart(  # noqa: PLR0912
         raise ValueError("Error: Data is a required field.")
 
     auto_layout = False
-    index = (
+    index = (  # type: ignore
         data.index.name
         if isinstance(data, (DataFrame, Series))
         else index if index is not None else x if x is not None else "date"
@@ -88,11 +88,13 @@ def line_chart(  # noqa: PLR0912
             if found_index is False:
                 df.set_index(df.iloc[:, 0], inplace=True)
 
+    target = target if target else "close"
+
     if "symbol" in df.columns and len(df.symbol.unique()) > 1:
-        df = df.pivot(columns="symbol", values=target if target else "close")
+        df = df.pivot(columns="symbol", values=target)
 
     if "symbol" not in df.columns and target in df.columns:
-        df = df[[target]]
+        df = df[[target]]  # type: ignore
 
     y = y.split(",") if isinstance(y, str) else y
 
@@ -104,11 +106,11 @@ def line_chart(  # noqa: PLR0912
         auto_layout = False
 
     if returns is True:
-        df = df.apply(calculate_returns)
+        df = df.apply(calculate_returns)  # type: ignore
         auto_layout = False
 
     if normalize is True:
-        df = df.apply(z_score_standardization)
+        df = df.apply(z_score_standardization)  # type: ignore
         auto_layout = False
 
     if layout_kwargs is None:
@@ -147,7 +149,7 @@ def line_chart(  # noqa: PLR0912
         sorted_columns = diff.sort_values(ascending=False).index
         if sorted_columns is None or len(sorted_columns) == 0:
             raise ValueError("Error: expected data with numeric values.")
-        df = df[sorted_columns]
+        df = df[sorted_columns]  # type: ignore
 
         for i, col in enumerate(df.columns):
 
@@ -459,7 +461,7 @@ def bar_chart(  # noqa: PLR0912
             "rgba(0,0,0,0)" if text_color == "white" else "rgba(255,255,255,0)"
         ),
         plot_bgcolor=(
-            "rgba(0,0,0,0)" if text_color == "white" else "rbga(255,255,255,0)"
+            "rgba(0,0,0,0)" if text_color == "white" else "rgba(255,255,255,0)"
         ),
         legend=dict(
             orientation="v",
@@ -480,8 +482,7 @@ def bar_chart(  # noqa: PLR0912
             ),
             ticklen=0,
             showgrid=orientation == "h",
-            tickformat="<b>%{x}</b>",
-            tickfont=dict(size=12),
+            tickfont=dict(size=12, family="sans-serif"),
             categoryorder="array" if orientation == "v" else None,
             categoryarray=bar_df.index if orientation == "v" else None,
         ),
@@ -589,20 +590,20 @@ def bar_increasing_decreasing(  # pylint: disable=W0102
     except Exception as e:
         raise ValueError(f"Error: {e}") from e
 
-    if not increasing_data.empty:
+    if not increasing_data.empty:  # type: ignore
         figure.add_bar(
-            x=increasing_data.index if orientation == "v" else increasing_data,
-            y=increasing_data if orientation == "v" else increasing_data.index,
+            x=increasing_data.index if orientation == "v" else increasing_data,  # type: ignore
+            y=increasing_data if orientation == "v" else increasing_data.index,  # type: ignore
             marker=dict(color=colors[0]),
             orientation=orientation,
             showlegend=False,
             width=0.95 / len(keys) * 0.75 if barmode == "group" else 0.95,
             hoverinfo="y" if orientation == "v" else "x",
         )
-    if not decreasing_data.empty:
+    if not decreasing_data.empty:  # type: ignore
         figure.add_bar(
-            x=decreasing_data.index if orientation == "v" else decreasing_data,
-            y=decreasing_data if orientation == "v" else decreasing_data.index,
+            x=decreasing_data.index if orientation == "v" else decreasing_data,  # type: ignore
+            y=decreasing_data if orientation == "v" else decreasing_data.index,  # type: ignore
             marker=dict(color=colors[1]),
             orientation=orientation,
             showlegend=False,
@@ -653,3 +654,172 @@ def bar_increasing_decreasing(  # pylint: disable=W0102
         )
 
     return figure
+
+
+def surface3d(
+    X: "Series",
+    Y: "Series",
+    Z: "Series",
+    xtitle: Optional[str] = "DTE",
+    ytitle: Optional[str] = "Strike",
+    ztitle: Optional[str] = "IV",
+    colorscale: Optional[Union[str, list]] = None,
+    title: Optional[str] = None,
+    layout_kwargs: Optional[dict[str, Any]] = None,
+    theme: Optional[Literal["dark", "light"]] = None,
+) -> Union["OpenBBFigure", "Figure"]:
+    """Create a 3D surface chart.
+
+    Parameters
+    ----------
+    X : pd.Series
+        The x-axis data.
+    Y : pd.Series
+        The y-axis data.
+    Z : pd.Series
+        The z-axis data.
+    xtitle : str, optional
+        The title for the x-axis, by default "DTE".
+    ytitle : str, optional
+        The title for the y-axis, by default "Strike".
+    ztitle : str, optional
+        The title for the z-axis, by default "IV".
+    colorscale : Union[str, list], optional
+        The colorscale to use for the surface, by default None.
+    title : str, optional
+        The title of the chart, by default None.
+    layout_kwargs : Optional[dict[str, Any]], optional
+        Additional keyword arguments to apply with figure.update_layout(), by default None.
+
+    Returns
+    -------
+    OpenBBFigure
+        The OpenBBFigure object.
+    """
+    # pylint: disable=import-outside-toplevel
+    from openbb_core.app.model.abstract.error import OpenBBError  # noqa
+    from openbb_charting.core.openbb_figure import OpenBBFigure
+    from numpy import vstack
+    from scipy.spatial import Delaunay
+    import numpy as np
+
+    try:
+        points3D = vstack((X, Y, Z)).T
+        points2D = points3D[:, :2]
+        tri = Delaunay(points2D)
+        II, J, K = tri.simplices.T
+    except Exception as e:
+        raise OpenBBError(f"Not enough points to render 3D: {e}") from e
+
+    fig = OpenBBFigure(create_backend=False)
+    chart_style = ChartStyle()
+    if theme:
+        chart_style.plt_style = theme
+    fig.update_layout(chart_style.plotly_template.get("layout", {}))
+    text_color = "white" if chart_style.plt_style == "dark" else "black"
+    fig.set_title(f"{title if title and title != 'OpenBB Platform' else ''}")
+    fig_kwargs = dict(z=Z, x=X, y=Y, i=II, j=J, k=K, intensity=Z)
+    customdata = np.array([[xtitle, ytitle, ztitle]] * len(X))
+
+    fig.add_mesh3d(
+        **fig_kwargs,
+        alphahull=0,
+        opacity=1,
+        contour=dict(color="black", show=True, width=15),
+        colorscale=(
+            colorscale
+            if colorscale
+            else [
+                [0, "darkred"],
+                [0.001, "crimson"],
+                [0.005, "red"],
+                [0.0075, "orangered"],
+                [0.015, "darkorange"],
+                [0.025, "orange"],
+                [0.04, "goldenrod"],
+                [0.055, "gold"],
+                [0.11, "magenta"],
+                [0.15, "plum"],
+                [0.4, "lightblue"],
+                [0.7, "royalblue"],
+                [0.9, "blue"],
+                [1, "darkblue"],
+            ]
+        ),
+        colorbar=dict(
+            len=0.66,
+            y=0.5,
+            thickness=15,
+        ),
+        customdata=customdata,
+        hovertemplate="<b>%{customdata[0]}</b>: %{x} <br>"
+        "<b>%{customdata[1]}</b>: %{y} <br>"
+        "<b>%{customdata[2]}</b>: %{z}<extra></extra>",
+        showscale=True,
+        flatshading=True,
+        lighting=dict(
+            ambient=0.95,
+            diffuse=0.9,
+            roughness=0.8,
+            specular=0.9,
+            fresnel=0.001,
+            vertexnormalsepsilon=0.0001,
+            facenormalsepsilon=0.0001,
+        ),
+    )
+    fig.update_layout(
+        scene=dict(
+            xaxis=dict(
+                backgroundcolor="rgb(94, 94, 94)",
+                gridcolor="white",
+                showbackground=True,
+                zerolinecolor="white",
+                title=dict(text=xtitle if xtitle else "DTE", font=dict(size=18)),
+                autorange="reversed",
+                tickfont=dict(size=12),
+            ),
+            yaxis=dict(
+                backgroundcolor="rgb(94, 94, 94)",
+                gridcolor="white",
+                showbackground=True,
+                zerolinecolor="white",
+                title=dict(text=ytitle if ytitle else "Strike", font=dict(size=18)),
+                tickfont=dict(size=12),
+            ),
+            zaxis=dict(
+                backgroundcolor="rgb(94, 94, 94)",
+                gridcolor="white",
+                showbackground=True,
+                zerolinecolor="white",
+                title=dict(text=ztitle if ztitle else "IV", font=dict(size=18)),
+                tickfont=dict(size=12),
+            ),
+            domain=dict(y=[0.0125, 0.95], x=[0.0125, 1]),
+        ),
+        title_x=0.5,
+        title_y=0.98,
+        scene_camera=dict(
+            up=dict(x=0, y=0, z=0.75),
+            center=dict(x=-0.01, y=0, z=-0.3),
+            eye=dict(x=1.75, y=1.75, z=0.69),
+        ),
+        paper_bgcolor=(
+            "rgba(21,21,21,1)" if text_color == "white" else "rgba(255,255,255,1)"
+        ),
+        plot_bgcolor=(
+            "rgba(21,21,21,1)" if text_color == "white" else "rgba(255,255,255,1)"
+        ),
+        font=dict(color=text_color),
+        # margin=dict(t=100, b=10, r=10, l=10),
+    )
+
+    fig.update_scenes(
+        aspectmode="manual",
+        aspectratio=dict(x=1.5, y=2.0, z=0.75),
+        dragmode="turntable",
+    )
+
+    if layout_kwargs:
+        fig.update_layout(layout_kwargs, overwrite=False)
+
+    return fig

{openbb_charting-2.3.2 → openbb_charting-2.4.0}/openbb_charting/charts/helpers.py

@@ -38,7 +38,7 @@ def z_score_standardization(data: "Series") -> "Series":
 
 def calculate_returns(data: "Series") -> "Series":
     """Calculate the returns of a column."""
-    return ((1 + data.pct_change().dropna()).cumprod() - 1) * 100
+    return ((1 + data.pct_change(fill_method=None).fillna(0)).cumprod() - 1) * 100
 
 
 def should_share_axis(