plotly-stubs 0.0.1__py3-none-any.whl

plotly-stubs/__init__.pyi

@@ -0,0 +1,41 @@
+from typing import Any
+
+import pandas as pd
+import plotly.colors as colors
+import plotly.data as data
+import plotly.graph_objs as graph_objs
+import plotly.io as io
+import plotly.offline as offline
+import plotly.tools as tools
+import plotly.utils as utils
+from plotly.graph_objs import Figure
+from plotly.version import __version__
+
+__all__ = [
+    "__version__",
+    "colors",
+    "data",
+    "graph_objs",
+    "io",
+    "offline",
+    "tools",
+    "utils",
+]
+
+def plot(
+    data_frame: pd.DataFrame,
+    kind: str,
+    **kwargs: Any,
+) -> Figure: ...
+def boxplot_frame(
+    data_frame: pd.DataFrame,
+    **kwargs: Any,
+) -> Figure: ...
+def hist_frame(
+    data_frame: pd.DataFrame,
+    **kwargs: Any,
+) -> Figure: ...
+def hist_series(
+    data_frame: pd.DataFrame,
+    **kwargs: Any,
+) -> Figure: ...

plotly-stubs/basedatatypes.pyi

@@ -0,0 +1,416 @@
+import os
+from collections import OrderedDict
+from collections.abc import Callable, Generator, Iterator, Sequence
+from contextlib import contextmanager
+from pathlib import Path
+from typing import Any
+
+from plotly._subplots import SubplotDomain, SubplotXY
+from plotly.callbacks import BoxSelector, InputDeviceState, LassoSelector, Points
+from plotly.graph_objs import Figure, Layout
+from plotly.graph_objs.layout import Annotation
+
+Undefined = ...
+
+class BaseFigure:
+    _bracket_re = ...
+    _valid_underscore_properties = ...
+    _set_trace_uid = ...
+    _allow_disable_validation = ...
+    def __init__(
+        self,
+        data: Sequence[BaseTraceType] | Sequence[dict[str, Any]] | BaseTraceType | BaseFigure | dict[str, Any] = ...,
+        layout_plotly: BaseLayoutType | dict[str, Any] = ...,
+        frames: Sequence[BaseFrameHierarchyType] | dict[str, Any] = ...,
+        skip_invalid: bool = ...,
+        **kwargs: Any,
+    ) -> None: ...
+    def __reduce__(self) -> tuple[type[BaseFigure], tuple[dict[str, Any]]]: ...
+    def __setitem__(self, prop: str, value: Any) -> None: ...
+    def __setattr__(self, prop: str, value: Any) -> None: ...
+    def __getitem__(self, prop: str) -> Any: ...
+    def __iter__(self) -> Iterator[str]:  # -> Iterator[Literal['data', 'layout', 'frames']]:
+        ...
+    def __contains__(self, prop: str) -> bool: ...
+    def __eq__(self, other: object) -> bool: ...
+    def update(
+        self,
+        dict1: dict[str, Any] = ...,
+        overwrite: bool = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def pop(self, key: str, dflt: Any | None = ...) -> Any: ...
+    @property
+    def data(self) -> Sequence[BaseTraceType]: ...
+    @data.setter
+    def data(self, new_data: Sequence[BaseTraceType]) -> None: ...
+    def select_traces(
+        self,
+        selector: dict[str, Any] | Callable[[BaseTraceType], bool] | int | str | None = ...,
+        row: int | None = ...,
+        col: int | None = ...,
+        secondary_y: bool | None = ...,
+    ) -> Generator[BaseTraceType, None, None]: ...
+    def for_each_trace(
+        self,
+        fn: Callable[[BaseTraceType], Any],
+        selector: dict[str, Any] | Callable[[BaseTraceType], bool] | int | str | None = ...,
+        row: int | None = ...,
+        col: int | None = ...,
+        secondary_y: bool | None = ...,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def update_traces(
+        self,
+        patch: dict[str, Any] | None = ...,
+        selector: dict[str, Any] | Callable[[BaseTraceType], bool] | int | str | None = ...,
+        row: int | None = ...,
+        col: int | None = ...,
+        secondary_y: bool | None = ...,
+        overwrite: bool = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def update_layout(
+        self,
+        dict1: dict[str, Any] = ...,
+        overwrite: bool = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def plotly_restyle(
+        self,
+        restyle_data: dict[str, Any | Sequence[Any]],
+        trace_indexes: int | Sequence[int] | None = ...,
+        **kwargs: Any,
+    ) -> None: ...
+    def add_trace(
+        self,
+        trace: BaseTraceType | dict[str, Any],
+        row: int | str | None = ...,
+        col: int | str | None = ...,
+        secondary_y: bool | None = ...,
+        exclude_empty_subplots: bool = ...,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def add_traces(
+        self,
+        data: Sequence[BaseTraceType | dict[str, Any]],
+        rows: Sequence[int] | int | None = ...,
+        cols: Sequence[int] | int | None = ...,
+        secondary_ys: Sequence[bool] | None = ...,
+        exclude_empty_subplots: bool = ...,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def print_grid(self) -> None: ...
+    def append_trace(
+        self,
+        trace: BaseTraceType,
+        row: int,
+        col: int,
+    ) -> None: ...
+    def get_subplot(
+        self,
+        row: int,
+        col: int,
+        secondary_y: bool = ...,
+    ) -> (
+        BaseLayoutHierarchyType | SubplotDomain | SubplotXY | None
+    ):  # -> Scene | Polar | Ternary | Mapbox | SubplotDomain | SubplotXY | None:
+        ...
+    @property
+    def layout(self) -> Layout:  # -> Layout:
+        ...
+    @layout.setter
+    def layout(self, new_layout: Layout) -> None: ...
+    def plotly_relayout(
+        self,
+        relayout_data: dict[str, Any],
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def frames(self) -> Sequence[BaseFrameHierarchyType]:  # -> tuple[plotly.graph_objs.Frame]
+        ...
+    @frames.setter
+    def frames(self, new_frames: Sequence[BaseFrameHierarchyType]) -> None: ...
+    def plotly_update(
+        self,
+        restyle_data: dict[str, Any] = ...,
+        relayout_data: dict[str, Any] = ...,
+        trace_indexes: int | Sequence[int] | None = ...,
+        **kwargs: Any,
+    ) -> None: ...
+    @contextmanager
+    def batch_update(self) -> Generator[None, Any, None]: ...
+    @contextmanager
+    def batch_animate(
+        self,
+        duration: int | float = ...,
+        easing: str = ...,
+    ) -> Generator[None, Any, None]: ...
+    def to_dict(self) -> dict[str, Any]: ...
+    def to_plotly_json(self) -> dict[str, Any]: ...
+    def to_ordered_dict(self, skip_uid: bool = ...) -> OrderedDict[str, Any]: ...
+    def show(
+        self,
+        renderer: str | None = ...,
+        validate: bool = ...,
+        width: int | float = ...,
+        height: int | float = ...,
+        config: dict[str, Any] = ...,
+    ) -> None: ...
+    def to_json(
+        self,
+        validate: bool = ...,
+        pretty: bool = ...,
+        remove_uids: bool = ...,
+        engine: str | None = ...,
+    ) -> str: ...
+    def full_figure_for_development(
+        self,
+        warn: bool = ...,
+        as_dict: bool = ...,
+    ) -> Figure | dict[str, Any]: ...
+    def write_json(
+        self,
+        file: Path | os.PathLike[str],
+        pretty: bool = ...,
+        remove_uids: bool = ...,
+        engine: str | None = ...,
+    ) -> None: ...
+    def to_html(
+        self,
+        config: dict[str, Any] | None = ...,
+        auto_play: bool = ...,
+        include_plotlyjs: bool | str = ...,
+        include_mathjax: bool | str = ...,
+        post_script: str | Sequence[str] | None = ...,
+        full_html: bool = ...,
+        animation_opts: dict[str, Any] | None = ...,
+        default_width: int | float | str = ...,
+        default_height: int | float | str = ...,
+        validate: bool = ...,
+        div_id: str | None = ...,
+    ) -> str: ...
+    def write_html(
+        self,
+        file: Path | os.PathLike[str],
+        config: dict[str, Any] | None = ...,
+        auto_play: bool = ...,
+        include_plotlyjs: bool | str = ...,
+        include_mathjax: bool | str = ...,
+        post_script: str | Sequence[str] | None = ...,
+        full_html: bool = ...,
+        animation_opts: dict[str, Any] | None = ...,
+        default_width: int | float | str = ...,
+        default_height: int | float | str = ...,
+        validate: bool = ...,
+        auto_open: bool = ...,
+        div_id: str | None = ...,
+    ) -> None: ...
+    def to_image(
+        self,
+        format: str | None = ...,
+        width: int | None = ...,
+        height: int | None = ...,
+        scale: int | float | None = ...,
+        validate: bool = ...,
+        engine: str = ...,
+    ) -> bytes: ...
+    def write_image(
+        self,
+        file: Path | os.PathLike[str],
+        format: str | None = ...,
+        width: int | None = ...,
+        height: int | None = ...,
+        scale: int | float | None = ...,
+        validate: bool = ...,
+        engine: str = ...,
+    ) -> None: ...
+    def add_vline(
+        self,
+        x: int | float,
+        row: int | str | None = ...,
+        col: int | str | None = ...,
+        exclude_empty_subplots: bool = ...,
+        annotation: Annotation | dict[str, Any] = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def add_hline(
+        self,
+        y: int | float,
+        row: int | str | None = ...,
+        col: int | str | None = ...,
+        exclude_empty_subplots: bool = ...,
+        annotation: Annotation | dict[str, Any] = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def add_vrect(
+        self,
+        x0: int | float,
+        x1: int | float,
+        row: int | str | None = ...,
+        col: int | str | None = ...,
+        exclude_empty_subplots: bool = ...,
+        annotation: Annotation | dict[str, Any] = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def add_hrect(
+        self,
+        y0: int | float,
+        y1: int | float,
+        row: int | str | None = ...,
+        col: int | str | None = ...,
+        exclude_empty_subplots: bool = ...,
+        annotation: Annotation | dict[str, Any] = ...,
+        **kwargs: Any,
+    ) -> BaseFigure:  # -> Self:
+        ...
+    def set_subplots(
+        self,
+        rows: int = ...,
+        cols: int = ...,
+        shared_xaxes: bool | str = ...,
+        shared_yaxes: bool | str = ...,
+        start_cell: str = ...,
+        print_grid: bool = ...,
+        horizontal_spacing: float = ...,
+        vertical_spacing: float = ...,
+        subplot_titles: list[str] | None = ...,
+        column_widths: list[float] | None = ...,
+        row_heights: list[float] | None = ...,
+        specs: list[list[dict[str, str | bool | int | float] | None]] | None = ...,
+        insets: list[dict[str, tuple[int, int] | str | float]] | None = ...,
+        column_titles: list[str] | None = ...,
+        row_titles: list[str] | None = ...,
+        x_title: str | None = ...,
+        y_title: str | None = ...,
+        figure: BaseFigure | None = ...,
+        **kwargs: Any,
+    ) -> BaseFigure: ...
+
+class BasePlotlyType:
+    _mapped_properties = ...
+    _parent_path_str = ...
+    _path_str = ...
+    _valid_props = ...
+    def __init__(
+        self,
+        plotly_name: str,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def plotly_name(self) -> str: ...
+    @property
+    def parent(self) -> BasePlotlyType | BaseFigure: ...
+    @property
+    def figure(self) -> BaseFigure | None: ...
+    def __reduce__(self) -> Any: ...
+    def __getitem__(self, prop: str) -> Any: ...
+    def __contains__(self, prop: str) -> bool: ...
+    def __setitem__(self, prop: str, value: Any) -> None: ...
+    def __setattr__(self, prop: str, value: Any) -> None: ...
+    def __iter__(self) -> Iterator[str]: ...
+    def __eq__(self, other: object) -> bool: ...
+    def update(
+        self,
+        dict1: dict[str, Any] = ...,
+        overwrite: bool = ...,
+        **kwargs: Any,
+    ) -> BasePlotlyType:  # -> Self:
+        ...
+    def pop(self, key: str, dflt: Any) -> Any: ...
+    def on_change(
+        self,
+        callback: Callable[..., None],
+        args: list[str | tuple[int | str]],
+        append: bool = ...,
+    ) -> None: ...
+    def to_plotly_json(self) -> dict[str, Any]: ...
+    def to_json(
+        self,
+        validate: bool = ...,
+        pretty: bool = ...,
+        remove_uids: bool = ...,
+        engine: str | None = ...,
+    ) -> str: ...
+
+class BaseLayoutHierarchyType(BasePlotlyType):
+    def __init__(
+        self,
+        plotly_name: str,
+        **kwargs: Any,
+    ) -> None: ...
+
+class BaseLayoutType(BaseLayoutHierarchyType):
+    def __init__(
+        self,
+        plotly_name: str,
+        **kwargs: Any,
+    ) -> None: ...
+    def __getattr__(self, prop: str) -> Any: ...
+    def __getitem__(self, prop: str) -> Any: ...
+    def __contains__(self, prop: str) -> bool: ...
+    def __setitem__(self, prop: str, value: Any) -> None: ...
+    def __setattr__(self, prop: str, value: Any) -> None: ...
+    def __dir__(self) -> list[str]: ...
+
+class BaseTraceHierarchyType(BasePlotlyType):
+    def __init__(
+        self,
+        plotly_name: str,
+        **kwargs: Any,
+    ) -> None: ...
+
+class BaseTraceType(BaseTraceHierarchyType):
+    def __init__(
+        self,
+        plotly_name: str,
+        **kwargs: Any,
+    ) -> None: ...
+    @property
+    def uid(self) -> str | int: ...
+    @uid.setter
+    def uid(self, val: str | int) -> None: ...
+    def on_hover(
+        self,
+        callback: Callable[[BaseTraceType, Points, InputDeviceState], None],
+        append: bool = ...,
+    ) -> None: ...
+    def on_unhover(
+        self,
+        callback: Callable[[BaseTraceType, Points, InputDeviceState], None],
+        append: bool = ...,
+    ) -> None: ...
+    def on_click(
+        self,
+        callback: Callable[[BaseTraceType, Points, InputDeviceState], None],
+        append: bool = ...,
+    ) -> None: ...
+    def on_selection(
+        self,
+        callback: Callable[[BaseTraceType, Points, BoxSelector | LassoSelector], None],
+        append: bool = ...,
+    ) -> None: ...
+    def on_deselect(
+        self,
+        callback: Callable[[BaseTraceType, Points], None],
+        append: bool = ...,
+    ) -> None: ...
+
+class BaseFrameHierarchyType(BasePlotlyType):
+    def __init__(
+        self,
+        plotly_name: str,
+        **kwargs: Any,
+    ) -> None: ...
+    def on_change(
+        self,
+        callback: Callable[..., None],
+        args: list[str | tuple[int | str]],
+        append: bool = ...,
+    ) -> None: ...

plotly-stubs/callbacks.pyi

@@ -0,0 +1,80 @@
+from typing import Any
+
+__all__ = [
+    "BoxSelector",
+    "InputDeviceState",
+    "LassoSelector",
+    "Points",
+]
+
+class InputDeviceState:
+    def __init__(
+        self,
+        ctrl: bool = ...,
+        alt: bool = ...,
+        shift: bool = ...,
+        meta: bool = ...,
+        button: int = ...,
+        buttons: int = ...,
+        **_: Any,
+    ) -> None: ...
+    @property
+    def alt(self) -> bool: ...
+    @property
+    def ctrl(self) -> bool: ...
+    @property
+    def shift(self) -> bool: ...
+    @property
+    def meta(self) -> bool: ...
+    @property
+    def button(self) -> int: ...
+    @property
+    def buttons(self) -> int: ...
+
+class Points:
+    def __init__(
+        self,
+        point_inds: list[int] = ...,
+        xs: list[float] = ...,
+        ys: list[float] = ...,
+        trace_name: str = ...,
+        trace_index: int = ...,
+    ) -> None: ...
+    @property
+    def point_inds(self) -> list[int]: ...
+    @property
+    def xs(self) -> list[float]: ...
+    @property
+    def ys(self) -> list[float]: ...
+    @property
+    def trace_name(self) -> str: ...
+    @property
+    def trace_index(self) -> int: ...
+
+class BoxSelector:
+    def __init__(
+        self,
+        xrange: tuple[float, float] = ...,
+        yrange: tuple[float, float] = ...,
+        **_: Any,
+    ) -> None: ...
+    @property
+    def type(self) -> str: ...
+    @property
+    def xrange(self) -> tuple[float, float]: ...
+    @property
+    def yrange(self) -> tuple[float, float]: ...
+
+class LassoSelector:
+    def __init__(
+        self,
+        xs: list[float] = ...,
+        ys: list[float] = ...,
+        **_: Any,
+    ) -> None: ...
+    @property
+    def type(self) -> str: ...
+    @property
+    def xs(self) -> list[float]: ...
+    @property
+    def ys(self) -> list[float]: ...

plotly-stubs/colors/__init__.pyi

@@ -0,0 +1,35 @@
+from _plotly_utils.colors import *
+
+__all__ = [
+    "DEFAULT_PLOTLY_COLORS",
+    "PLOTLY_SCALES",
+    "carto",
+    "cmocean",
+    "color_parser",
+    "colorbrewer",
+    "colorscale_to_colors",
+    "colorscale_to_scale",
+    "convert_colors_to_same_type",
+    "convert_colorscale_to_rgb",
+    "convert_dict_colors_to_same_type",
+    "convert_to_RGB_255",
+    "cyclical",
+    "diverging",
+    "find_intermediate_color",
+    "get_colorscale",
+    "hex_to_rgb",
+    "label_rgb",
+    "make_colorscale",
+    "n_colors",
+    "named_colorscales",
+    "plotlyjs",
+    "qualitative",
+    "sample_colorscale",
+    "sequential",
+    "unconvert_from_RGB_255",
+    "unlabel_rgb",
+    "validate_colors",
+    "validate_colors_dict",
+    "validate_colorscale",
+    "validate_scale_values",
+]

plotly-stubs/express/__init__.pyi

@@ -0,0 +1,95 @@
+from plotly.express import colors
+from plotly.express._chart_types import (
+    area,
+    bar,
+    bar_polar,
+    box,
+    choropleth,
+    choropleth_map,
+    choropleth_mapbox,
+    density_contour,
+    density_heatmap,
+    density_map,
+    density_mapbox,
+    ecdf,
+    funnel,
+    funnel_area,
+    histogram,
+    icicle,
+    line,
+    line_3d,
+    line_geo,
+    line_map,
+    line_mapbox,
+    line_polar,
+    line_ternary,
+    parallel_categories,
+    parallel_coordinates,
+    pie,
+    scatter,
+    scatter_3d,
+    scatter_geo,
+    scatter_map,
+    scatter_mapbox,
+    scatter_matrix,
+    scatter_polar,
+    scatter_ternary,
+    strip,
+    sunburst,
+    timeline,
+    treemap,
+    violin,
+)
+from plotly.express._core import NO_COLOR, get_trendline_results, set_mapbox_access_token
+from plotly.express._imshow import imshow
+from plotly.express._special_inputs import Constant, IdentityMap, Range
+
+__all__ = [
+    "NO_COLOR",
+    "Constant",
+    "IdentityMap",
+    "Range",
+    "area",
+    "bar",
+    "bar_polar",
+    "box",
+    "choropleth",
+    "choropleth_map",
+    "choropleth_mapbox",
+    "colors",
+    "density_contour",
+    "density_heatmap",
+    "density_map",
+    "density_mapbox",
+    "ecdf",
+    "funnel",
+    "funnel_area",
+    "get_trendline_results",
+    "histogram",
+    "icicle",
+    "imshow",
+    "line",
+    "line_3d",
+    "line_geo",
+    "line_map",
+    "line_mapbox",
+    "line_polar",
+    "line_ternary",
+    "parallel_categories",
+    "parallel_coordinates",
+    "pie",
+    "scatter",
+    "scatter_3d",
+    "scatter_geo",
+    "scatter_map",
+    "scatter_mapbox",
+    "scatter_matrix",
+    "scatter_polar",
+    "scatter_ternary",
+    "set_mapbox_access_token",
+    "strip",
+    "sunburst",
+    "timeline",
+    "treemap",
+    "violin",
+]