kedro_datasets.plotly.PlotlyDataset¶

class kedro_datasets.plotly.PlotlyDataset(*, filepath, plotly_args, load_args=None, save_args=None, version=None, credentials=None, fs_args=None, metadata=None)[source]¶

PlotlyDataset generates a plot from a pandas DataFrame and saves it to a JSON file using an underlying filesystem (e.g.: local, S3, GCS). It loads the JSON into a plotly figure.

PlotlyDataset is a convenience wrapper for plotly.JSONDataset. It generates the JSON file directly from a pandas DataFrame through plotly_args.

Example usage for the YAML API:

bar_plot:
  type: plotly.PlotlyDataset
  filepath: data/08_reporting/bar_plot.json
  plotly_args:
    type: bar
    fig:
      x: features
      y: importance
      orientation: h
    layout:
      xaxis_title: x
      yaxis_title: y
      title: Title

Example usage for the Python API:

 from kedro_datasets.plotly import PlotlyDataset
 import plotly.express as px
 import pandas as pd

 df_data = pd.DataFrame([[0, 1], [1, 0]], columns=("x1", "x2"))

 dataset = PlotlyDataset(
...     filepath=tmp_path / "scatter_plot.json",
...     plotly_args={
...         "type": "scatter",
...         "fig": {"x": "x1", "y": "x2"},
...     },
... )
 dataset.save(df_data)
 reloaded = dataset.load()
 assert px.scatter(df_data, x="x1", y="x2") == reloaded

Attributes

`DEFAULT_FS_ARGS`
`DEFAULT_LOAD_ARGS`
`DEFAULT_SAVE_ARGS`

Methods

`exists`()	Checks whether a dataset's output already exists by calling the provided _exists() method.
`from_config`(name, config[, load_version, ...])	Create a dataset instance using the configuration provided.
`load`()	Loads data by delegation to the provided load method.
`preview`()	Generates a preview of the plotly dataset.
`release`()	Release any cached data.
`resolve_load_version`()	Compute the version the dataset should be loaded with.
`resolve_save_version`()	Compute the version the dataset should be saved with.
`save`(data)	Saves data by delegation to the provided save method.
`to_config`()	Converts the dataset instance into a dictionary-based configuration for serialization.

DEFAULT_FS_ARGS: dict[str, Any] = {'open_args_save': {'mode': 'w'}}¶

DEFAULT_LOAD_ARGS: dict[str, Any] = {}¶

DEFAULT_SAVE_ARGS: dict[str, Any] = {}¶

__init__(*, filepath, plotly_args, load_args=None, save_args=None, version=None, credentials=None, fs_args=None, metadata=None)[source]¶

Creates a new instance of PlotlyDataset pointing to a concrete JSON file on a specific filesystem.

Parameters:

filepath (str) – Filepath in POSIX format to a JSON file prefixed with a protocol like s3://. If prefix is not provided file protocol (local filesystem) will be used. The prefix should be any protocol supported by fsspec. Note: http(s) doesn’t support versioning.
plotly_args (dict[str, Any]) – Plotly configuration for generating a plotly figure from the dataframe. Keys are type (plotly express function, e.g. bar, line, scatter), fig (kwargs passed to the plotting function), theme (defaults to plotly), layout.
load_args (Optional[dict[str, Any]]) – Plotly options for loading JSON files. Here you can find all available arguments: https://plotly.com/python-api-reference/generated/plotly.io.from_json.html#plotly.io.from_json All defaults are preserved.
save_args (Optional[dict[str, Any]]) – Plotly options for saving JSON files. Here you can find all available arguments: https://plotly.com/python-api-reference/generated/plotly.io.write_json.html All defaults are preserved.
version (Optional[Version]) – If specified, should be an instance of kedro.io.core.Version. If its load attribute is None, the latest version will be loaded. If its save attribute is None, save version will be autogenerated.
credentials (Optional[dict[str, Any]]) – Credentials required to get access to the underlying filesystem. E.g. for GCSFileSystem it should look like {‘token’: None}.
fs_args (Optional[dict[str, Any]]) – Extra arguments to pass into underlying filesystem class constructor (e.g. {“project”: “my-project”} for GCSFileSystem), as well as to pass to the filesystem’s open method through nested keys open_args_load and open_args_save. Here you can find all available arguments for open: https://filesystem-spec.readthedocs.io/en/latest/api.html#fsspec.spec.AbstractFileSystem.open All defaults are preserved, except mode, which is set to w when saving.
metadata (Optional[dict[str, Any]]) – Any arbitrary metadata. This is ignored by Kedro, but may be consumed by users or external plugins.

exists()[source]¶

Checks whether a dataset’s output already exists by calling the provided _exists() method.

Return type:: bool
Returns:: Flag indicating whether the output already exists.
Raises:: DatasetError – when underlying exists method raises error.

classmethod from_config(name, config, load_version=None, save_version=None)[source]¶

Create a dataset instance using the configuration provided.

Parameters:

name (str) – Data set name.
config (dict[str, Any]) – Data set config dictionary.
load_version (Optional[str]) – Version string to be used for load operation if the dataset is versioned. Has no effect on the dataset if versioning was not enabled.
save_version (Optional[str]) – Version string to be used for save operation if the dataset is versioned. Has no effect on the dataset if versioning was not enabled.

Return type:

AbstractDataset

Returns:

An instance of an AbstractDataset subclass.

Raises:

DatasetError – When the function fails to create the dataset from its config.

load()[source]¶

Loads data by delegation to the provided load method.

Return type:: Figure | FigureWidget
Returns:: Data returned by the provided load method.
Raises:: DatasetError – When underlying load method raises error.

preview()[source]¶

Generates a preview of the plotly dataset.

Returns:: A dictionary containing the plotly data.
Return type:: dict

release()[source]¶

Release any cached data.

Raises:: DatasetError – when underlying release method raises error.
Return type:: None

resolve_load_version()[source]¶

Compute the version the dataset should be loaded with.

Return type:: Optional[str]

resolve_save_version()[source]¶

Compute the version the dataset should be saved with.

Return type:: Optional[str]

save(data)[source]¶

Saves data by delegation to the provided save method.

Parameters:

data (DataFrame) – the value to be saved by provided save method.

Raises:

DatasetError – when underlying save method raises error.
FileNotFoundError – when save method got file instead of dir, on Windows.
NotADirectoryError – when save method got file instead of dir, on Unix.

Return type:

None

to_config()[source]¶

Converts the dataset instance into a dictionary-based configuration for serialization. Ensures that any subclass-specific details are handled, with additional logic for versioning and caching implemented for CachedDataset.

Adds a key for the dataset’s type using its module and class name and includes the initialization arguments.

For CachedDataset it extracts the underlying dataset’s configuration, handles the versioned flag and removes unnecessary metadata. It also ensures the embedded dataset’s configuration is appropriately flattened or transformed.

If the dataset has a version key, it sets the versioned flag in the configuration.

Removes the metadata key from the configuration if present.

Return type:: dict[str, Any]
Returns:: A dictionary containing the dataset’s type and initialization arguments.