openbb-charting 2.3.5__tar.gz → 2.4.1__tar.gz

{openbb_charting-2.3.5 → openbb_charting-2.4.1}/PKG-INFO

@@ -1,21 +1,22 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: openbb-charting
-Version: 2.3.5
+Version: 2.4.1
 Summary: Charting extension for OpenBB
 License: AGPL-3.0-only
 Author: OpenBB Team
 Author-email: hello@openbb.co
-Requires-Python: >=3.9.21,<3.13
+Requires-Python: >=3.10,<3.14
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Programming Language :: Python :: 3
 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.8,<2.0.0)
-Requires-Dist: pandas-ta-openbb (>=0.4.20,<0.5.0)
-Requires-Dist: plotly (>=6.2.0,<7.0.0)
+Requires-Dist: openbb-core (>=1.5.7,<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.5 → openbb_charting-2.4.1}/openbb_charting/charting.py

@@ -2,17 +2,12 @@
 
 # pylint: disable=too-many-arguments,unused-argument,too-many-positional-arguments
 
+from collections.abc import Callable
 from typing import (
     TYPE_CHECKING,
     Any,
-    Callable,
     ClassVar,
-    Dict,
-    List,
     Literal,
-    Optional,
-    Tuple,
-    Type,
     Union,
 )
 from warnings import warn
@@ -30,11 +25,11 @@ from openbb_charting.charts.helpers import (
 
 if TYPE_CHECKING:
     from numpy import ndarray  # noqa
-    from pandas import DataFrame, Series  # noqa
-    from plotly.graph_objs import Figure  # noqa
-    from openbb_charting.core.openbb_figure import OpenBBFigure  # noqa
-    from openbb_charting.query_params import ChartParams  # noqa
-    from openbb_charting.core.backend import Backend  # noqa
+    from pandas import DataFrame, Series
+    from plotly.graph_objs import Figure
+    from openbb_charting.core.openbb_figure import OpenBBFigure
+    from openbb_charting.query_params import ChartParams
+    from openbb_charting.core.backend import Backend
 
 
 class Charting:
@@ -64,7 +59,7 @@ class Charting:
         Toggle the chart style, of an existing chart, between light and dark mode.
     """
 
-    _extension_views: ClassVar[List[Type]] = [
+    _extension_views: ClassVar[list[type]] = [
         entry_point.load()
         for entry_point in entry_points(group="openbb_charting_extension")
     ]
@@ -86,7 +81,7 @@ class Charting:
             system_settings=self._obbject._system_settings,  # type: ignore
         )
         self._backend = self._handle_backend()
-        self._functions: Dict[str, Callable] = self._get_functions()
+        self._functions: dict[str, Callable] = self._get_functions()
 
     @classmethod
     def indicators(cls):
@@ -100,17 +95,17 @@ class Charting:
         return IndicatorsParams()
 
     @classmethod
-    def functions(cls) -> List[str]:
+    def functions(cls) -> list[str]:
         """Return a list of the available functions."""
-        functions: List[str] = []
+        functions: list[str] = []
         for view in cls._extension_views:
             functions.extend(get_charting_functions_list(view))
 
         return functions
 
-    def _get_functions(self) -> Dict[str, Callable]:
+    def _get_functions(self) -> dict[str, Callable]:
         """Return a dict with the available functions."""
-        functions: Dict[str, Callable] = {}
+        functions: dict[str, Callable] = {}
         for view in self._extension_views:
             functions.update(get_charting_functions(view))
 
@@ -156,23 +151,21 @@ class Charting:
 
         return help(  # type: ignore
             self._get_chart_function(  # pylint: disable=protected-access
-                self._obbject.extra[  # pylint: disable=protected-access
+                self._obbject.extra[
                     "metadata"
-                ].route
+                ].route  # pylint: disable=protected-access
             )
         )
 
     def _prepare_data_as_df(
-        self, data: Optional[Union["DataFrame", "Series"]]
-    ) -> Tuple["DataFrame", bool]:
+        self, data: Union["DataFrame", "Series"] | None
+    ) -> tuple["DataFrame", bool]:
         """Convert supplied data to a DataFrame."""
         # pylint: disable=import-outside-toplevel
         from openbb_core.app.utils import basemodel_to_df, convert_to_basemodel
         from pandas import DataFrame, Series
 
-        has_data = (
-            isinstance(data, (Data, DataFrame, Series)) and not data.empty  # type: ignore
-        ) or (bool(data))
+        has_data = (isinstance(data, (Data, DataFrame, Series)) and not data.empty) or (bool(data))  # type: ignore
         index = (
             data.index.name
             if has_data and isinstance(data, (DataFrame, Series))
@@ -196,23 +189,23 @@ class Charting:
             list,
             dict,
             "DataFrame",
-            List["DataFrame"],
+            list["DataFrame"],
             "Series",
-            List["Series"],
+            list["Series"],
             "ndarray",
             Data,
         ],
-        index: Optional[str] = None,
-        target: Optional[str] = None,
-        title: Optional[str] = None,
-        x: Optional[str] = None,
-        xtitle: Optional[str] = None,
-        y: Optional[Union[str, List[str]]] = None,
-        ytitle: Optional[str] = None,
-        y2: Optional[Union[str, List[str]]] = None,
-        y2title: Optional[str] = None,
-        layout_kwargs: Optional[dict] = None,
-        scatter_kwargs: Optional[dict] = None,
+        index: str | None = None,
+        target: str | None = None,
+        title: str | None = None,
+        x: str | None = None,
+        xtitle: str | None = None,
+        y: str | list[str] | None = None,
+        ytitle: str | None = None,
+        y2: str | list[str] | None = None,
+        y2title: str | None = None,
+        layout_kwargs: dict | None = None,
+        scatter_kwargs: dict | None = None,
         normalize: bool = False,
         returns: bool = False,
         same_axis: bool = False,
@@ -294,25 +287,25 @@ class Charting:
             list,
             dict,
             "DataFrame",
-            List["DataFrame"],
+            list["DataFrame"],
             "Series",
-            List["Series"],
+            list["Series"],
             "ndarray",
             Data,
         ],
         x: str,
-        y: Union[str, List[str]],
+        y: str | list[str],
         barmode: Literal["group", "stack", "relative", "overlay"] = "group",
         xtype: Literal[
             "category", "multicategory", "date", "log", "linear"
         ] = "category",
-        title: Optional[str] = None,
-        xtitle: Optional[str] = None,
-        ytitle: Optional[str] = None,
+        title: str | None = None,
+        xtitle: str | None = None,
+        ytitle: str | None = None,
         orientation: Literal["h", "v"] = "v",
-        colors: Optional[List[str]] = None,
-        layout_kwargs: Optional[Dict[str, Any]] = None,
-        bar_kwargs: Optional[Dict[str, Any]] = None,
+        colors: list[str] | None = None,
+        layout_kwargs: dict[str, Any] | None = None,
+        bar_kwargs: dict[str, Any] | None = None,
         render: bool = True,
         **kwargs,
     ) -> Union["OpenBBFigure", "Figure", None]:
@@ -375,13 +368,13 @@ class Charting:
         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,
+        xtitle: str | None = "DTE",
+        ytitle: str | None = "Strike",
+        ztitle: str | None = "IV",
+        colorscale: str | list | None = None,
+        title: str | None = None,
+        layout_kwargs: dict[str, Any] | None = None,
+        theme: Literal["dark", "light"] | None = None,
     ) -> Union["OpenBBFigure", "Figure"]:
         """Create a 3D surface chart.
 
@@ -438,7 +431,7 @@ class Charting:
         method: Literal["pearson", "kendall", "spearman"] = "pearson",
         colorscale: str = "RdBu",
         title: str = "Asset Correlation Matrix",
-        layout_kwargs: Optional[Dict[str, Any]] = None,
+        layout_kwargs: dict[str, Any] | None = None,
     ):
         """Create a correlation matrix from external data.
 
@@ -479,23 +472,63 @@ class Charting:
 
     def show(self, render: bool = True, **kwargs):
         """Display chart and save it to the OBBject."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_charting.core.openbb_figure import OpenBBFigure
+
         try:
             charting_function = self._get_chart_function(
-                self._obbject._route  # pylint: disable=protected-access
+                self._obbject._route  # pylint: disable=protected-access   # type: ignore
             )
             kwargs["obbject_item"] = self._obbject.results
             kwargs["charting_settings"] = self._charting_settings
             kwargs["standard_params"] = (
                 self._obbject._standard_params  # pylint: disable=protected-access
             )
-            kwargs["extra_params"] = (
-                self._obbject._extra_params  # pylint: disable=protected-access
+            # If the provider interface isn't used, endpoint kwargs are already here.
+            # Don't overwrite them.
+            obb_kwargs = (
+                self._obbject._extra_params or {}  # pylint: disable=protected-access
             )
+            if obb_kwargs:
+                for k, v in obb_kwargs.items():
+                    kwargs["extra_params"].update({k: v})
+
             kwargs["provider"] = self._obbject.provider
             kwargs["extra"] = self._obbject.extra
-            fig, content = charting_function(**kwargs)
-            self._obbject.chart = Chart(fig=fig, content=content, format=self._format)
-            if render:
+
+            # Handle different types of output from the charting endpoint.
+            chart_response: Any = charting_function(**kwargs)
+
+            # If returned a Chart object, set as-is.
+            if isinstance(chart_response, Chart):
+                self._obbject.chart = chart_response
+            # If just an OpenBBFigure gets returned, create the serialized version for the API.
+            elif isinstance(chart_response, OpenBBFigure):
+                fig = chart_response
+                content = fig.show(external=True, **kwargs).to_plotly_json()
+                self._obbject.chart = Chart(
+                    fig=fig, content=content, format=self._format
+                )
+            # Current functions return this.
+            elif isinstance(chart_response, tuple) and len(chart_response) == 2:
+                fig, content = chart_response
+
+                if isinstance(fig, OpenBBFigure):
+                    content = fig.show(external=True, **kwargs).to_plotly_json()  # type: ignore
+                    self._obbject.chart = Chart(
+                        fig=fig, content=content, format=self._format
+                    )
+                else:
+                    self._obbject.chart = Chart(
+                        fig=fig, content=content, format=type(fig).__name__
+                    )
+
+            else:
+                self._obbject.chart = Chart(
+                    fig=chart_response, content=None, format="unknown"
+                )
+
+            if render and hasattr(fig, "show"):
                 fig.show(**kwargs)
 
         except (RuntimeError, OpenBBError) as e:
@@ -520,21 +553,22 @@ class Charting:
     # pylint: disable=too-many-locals,inconsistent-return-statements
     def to_chart(
         self,
-        data: Optional[
+        data: (
             Union[
                 list,
                 dict,
                 "DataFrame",
-                List["DataFrame"],
+                list["DataFrame"],
                 "Series",
-                List["Series"],
+                list["Series"],
                 "ndarray",
                 Data,
             ]
-        ] = None,
-        target: Optional[str] = None,
-        index: Optional[str] = None,
-        indicators: Optional[Dict[str, Dict[str, Any]]] = None,
+            | None
+        ) = None,
+        target: str | None = None,
+        index: str | None = None,
+        indicators: dict[str, dict[str, Any]] | None = None,
         symbol: str = "",
         candles: bool = True,
         volume: bool = True,
@@ -635,11 +669,14 @@ class Charting:
         style = self._charting_settings.chart_style
         font_color = "black" if style == "light" else "white"
         paper_bgcolor = "white" if style == "light" else "black"
+        plot_bgcolor = "white" if style == "light" else "black"
         figure = figure.update_layout(
-            dict(  # pylint: disable=R1735
-                font_color=font_color, paper_bgcolor=paper_bgcolor
+            dict(
+                font_color=font_color,
+                paper_bgcolor=paper_bgcolor,
+                plot_bgcolor=plot_bgcolor,
             )
-        )
+        )  # pylint: disable=R1735
         return figure
 
     def toggle_chart_style(self):
@@ -686,7 +723,7 @@ class Charting:
 
     def table(
         self,
-        data: Optional[Union["DataFrame", "Series"]] = None,
+        data: Union["DataFrame", "Series"] | None = None,
         title: str = "",
     ):
         """Display an interactive table.
@@ -714,8 +751,9 @@ class Charting:
                 self._backend.send_table(
                     df_table=data_as_df,
                     title=title
-                    or self._obbject._route,  # pylint: disable=protected-access
-                    theme=self._charting_settings.table_style,
+                    or ""
+                    or self._obbject._route,  # pylint: disable=protected-access  # type: ignore
+                    theme=self._charting_settings.table_style,  # pylint: disable=protected-access
                 )
             except Exception as e:  # pylint: disable=W0718
                 warn(f"Failed to show figure with backend. {e}")
@@ -733,8 +771,8 @@ class Charting:
         self,
         url: str,
         title: str = "",
-        width: Optional[int] = None,
-        height: Optional[int] = None,
+        width: int | None = None,
+        height: int | None = None,
     ):
         """Return the URL of the chart."""
         try:

{openbb_charting-2.3.5 → openbb_charting-2.4.1}/openbb_charting/charts/correlation_matrix.py

@@ -25,7 +25,8 @@ def correlation_matrix(  # noqa: PLR0912
         corr = basemodel_to_df(kwargs["data"], index=kwargs.get("index", "date"))  # type: ignore
     else:
         corr = basemodel_to_df(
-            kwargs["obbject_item"], index=kwargs.get("index", "date")  # type: ignore
+            kwargs["obbject_item"],
+            index=kwargs.get("index", "date"),  # type: ignore
         )
     if (
         "symbol" in corr.columns
@@ -100,15 +101,6 @@ def correlation_matrix(  # noqa: PLR0912
     )
     fig = Figure(data=[heatmap], layout=layout)
     figure = OpenBBFigure(fig=fig)
-    figure.update_layout(
-        font=dict(color=text_color),
-        paper_bgcolor=(
-            "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 "rgba(255,255,255,0)"
-        ),
-    )
     layout_kwargs = kwargs.get("layout_kwargs", {})
 
     if layout_kwargs:

{openbb_charting-2.3.5 → openbb_charting-2.4.1}/openbb_charting/charts/generic_charts.py

@@ -2,7 +2,7 @@
 
 # pylint: disable=too-many-arguments,unused-argument,too-many-locals, too-many-branches, too-many-lines, too-many-statements, use-dict-literal, broad-exception-caught, too-many-nested-blocks, too-many-positional-arguments
 
-from typing import TYPE_CHECKING, Any, Dict, List, Literal, Optional, Union
+from typing import TYPE_CHECKING, Any, Literal, Union
 
 from openbb_core.app.utils import basemodel_to_df, convert_to_basemodel
 from openbb_core.provider.abstract.data import Data
@@ -27,23 +27,23 @@ def line_chart(  # noqa: PLR0912
         list,
         dict,
         "DataFrame",
-        List["DataFrame"],
+        list["DataFrame"],
         "Series",
-        List["Series"],
+        list["Series"],
         "ndarray",
         Data,
     ],
-    index: Optional[str] = None,
-    target: Optional[str] = None,
-    title: Optional[str] = None,
-    x: Optional[str] = None,
-    xtitle: Optional[str] = None,
-    y: Optional[Union[str, List[str]]] = None,
-    ytitle: Optional[str] = None,
-    y2: Optional[Union[str, List[str]]] = None,
-    y2title: Optional[str] = None,
-    layout_kwargs: Optional[dict] = None,
-    scatter_kwargs: Optional[dict] = None,
+    index: str | None = None,
+    target: str | None = None,
+    title: str | None = None,
+    x: str | None = None,
+    xtitle: str | None = None,
+    y: str | list[str] | None = None,
+    ytitle: str | None = None,
+    y2: str | list[str] | None = None,
+    y2title: str | None = None,
+    layout_kwargs: dict | None = None,
+    scatter_kwargs: dict | None = None,
     normalize: bool = False,
     returns: bool = False,
     same_axis: bool = False,
@@ -152,7 +152,6 @@ def line_chart(  # noqa: PLR0912
         df = df[sorted_columns]  # type: ignore
 
         for i, col in enumerate(df.columns):
-
             if col in y:  # type: ignore[operator]
                 hovertemplate = (
                     hovertemplate
@@ -247,12 +246,6 @@ def line_chart(  # noqa: PLR0912
     fig.update_layout(
         title=dict(text=title if title else None, x=0.5, font=dict(size=16)),
         font=dict(color=text_color),
-        paper_bgcolor=(
-            "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 "rgba(255,255,255,0)"
-        ),
         legend=dict(
             orientation="v",
             yanchor="top",
@@ -346,23 +339,23 @@ def bar_chart(  # noqa: PLR0912
         list,
         dict,
         "DataFrame",
-        List["DataFrame"],
+        list["DataFrame"],
         "Series",
-        List["Series"],
+        list["Series"],
         "ndarray",
         Data,
     ],
     x: str,
-    y: Union[str, List[str]],
+    y: str | list[str],
     barmode: Literal["group", "stack", "relative", "overlay"] = "group",
     xtype: Literal["category", "multicategory", "date", "log", "linear"] = "category",
-    title: Optional[str] = None,
-    xtitle: Optional[str] = None,
-    ytitle: Optional[str] = None,
+    title: str | None = None,
+    xtitle: str | None = None,
+    ytitle: str | None = None,
     orientation: Literal["h", "v"] = "v",
-    colors: Optional[List[str]] = None,
-    bar_kwargs: Optional[Dict[str, Any]] = None,
-    layout_kwargs: Optional[Dict[str, Any]] = None,
+    colors: list[str] | None = None,
+    bar_kwargs: dict[str, Any] | None = None,
+    layout_kwargs: dict[str, Any] | None = None,
     **kwargs,
 ) -> Union["OpenBBFigure", "Figure"]:
     """Create a vertical bar chart on a single x-axis with one or more values for the y-axis.
@@ -457,12 +450,6 @@ def bar_chart(  # noqa: PLR0912
 
     figure.update_layout(
         title=dict(text=title if title else None, x=0.5, font=dict(size=16)),
-        paper_bgcolor=(
-            "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 "rgba(255,255,255,0)"
-        ),
         legend=dict(
             orientation="v",
             yanchor="top",
@@ -524,15 +511,15 @@ def bar_chart(  # noqa: PLR0912
 
 
 def bar_increasing_decreasing(  # pylint: disable=W0102
-    keys: List[str],
-    values: List[Union[int, float]],
-    title: Optional[str] = None,
-    xtitle: Optional[str] = None,
-    ytitle: Optional[str] = None,
-    colors: List[str] = ["blue", "red"],
+    keys: list[str],
+    values: list[int | float],
+    title: str | None = None,
+    xtitle: str | None = None,
+    ytitle: str | None = None,
+    colors: list[str] = ["blue", "red"],
     orientation: Literal["h", "v"] = "h",
     barmode: Literal["group", "stack", "relative", "overlay"] = "relative",
-    layout_kwargs: Optional[Dict[str, Any]] = None,
+    layout_kwargs: dict[str, Any] | None = None,
 ) -> Union["OpenBBFigure", "Figure"]:
     """Create a bar chart with increasing and decreasing values represented by two colors.
 
@@ -638,12 +625,6 @@ def bar_increasing_decreasing(  # pylint: disable=W0102
             categoryorder="array" if orientation == "v" else None,
             categoryarray=keys if orientation == "v" else None,
         ),
-        paper_bgcolor=(
-            "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 "rgba(255,255,255,0)"
-        ),
         font=dict(color="white" if text_color == "white" else "black"),
         margin=dict(pad=5),
     )
@@ -660,13 +641,13 @@ 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,
+    xtitle: str | None = "DTE",
+    ytitle: str | None = "Strike",
+    ztitle: str | None = "IV",
+    colorscale: str | list | None = None,
+    title: str | None = None,
+    layout_kwargs: dict[str, Any] | None = None,
+    theme: Literal["dark", "light"] | None = None,
 ) -> Union["OpenBBFigure", "Figure"]:
     """Create a 3D surface chart.
 
@@ -803,14 +784,7 @@ def surface3d(
             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(

{openbb_charting-2.3.5 → openbb_charting-2.4.1}/openbb_charting/charts/helpers.py

@@ -2,18 +2,19 @@
 
 # pylint: disable=R0917
 
-from typing import TYPE_CHECKING, Callable, Dict, List, Type
+from collections.abc import Callable
+from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
     from pandas import DataFrame, Series
 
 
-def get_charting_functions(view: Type) -> Dict[str, Callable]:
+def get_charting_functions(view: type) -> dict[str, Callable]:
     """Discover charting functions."""
     # pylint: disable=import-outside-toplevel
     from inspect import getmembers, getsource, isfunction
 
-    implemented_functions: Dict[str, Callable] = {}
+    implemented_functions: dict[str, Callable] = {}
 
     for name, obj in getmembers(view, isfunction):
         if (
@@ -26,7 +27,7 @@ def get_charting_functions(view: Type) -> Dict[str, Callable]:
     return implemented_functions
 
 
-def get_charting_functions_list(view: Type) -> List[str]:
+def get_charting_functions_list(view: type) -> list[str]:
     """Get a list of all the charting functions."""
     return list(get_charting_functions(view).keys())
 
@@ -86,9 +87,7 @@ def heikin_ashi(data: "DataFrame") -> "DataFrame":
     for item in check_columns:
         if item not in df.columns:
             raise ValueError(
-                "The expected column labels, "
-                f"{check_columns}"
-                ", were not found in DataFrame."
+                f"The expected column labels, {check_columns}, were not found in DataFrame."
             )
 
     ha = candles.ha(