kedro_datasets.plotly.HTMLDataset

class kedro_datasets.plotly.HTMLDataset(*, filepath, save_args=None, version=None, credentials=None, fs_args=None, metadata=None)[source]

HTMLDataset saves a plotly figure to an HTML file using an underlying filesystem (e.g.: local, S3, GCS).

Example usage for the YAML API:

scatter_plot:
  type: plotly.HTMLDataset
  filepath: data/08_reporting/scatter_plot.html
  save_args:
    auto_open: False

Example usage for the Python API:

from kedro_datasets.plotly import HTMLDataset
import plotly.express as px

fig = px.bar(x=["a", "b", "c"], y=[1, 3, 2])
dataset = HTMLDataset(filepath=tmp_path / "test.html")
dataset.save(fig)

Attributes

DEFAULT_FS_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.

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.
DEFAULT_FS_ARGS: dict[str, Any] = {'open_args_save': {'encoding': 'utf-8', 'mode': 'w'}}
DEFAULT_SAVE_ARGS: dict[str, Any] = {}
__init__(*, filepath, save_args=None, version=None, credentials=None, fs_args=None, metadata=None)[source]

Creates a new instance of HTMLDataset pointing to a concrete HTML file on a specific filesystem.

Parameters:

  • filepath (str) – Filepath in POSIX format to an HTML 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.

  • save_args (Optional[dict[str, Any]]) – Plotly options for saving HTML files. Here you can find all available arguments: https://plotly.com/python-api-reference/generated/plotly.io.write_html.html#plotly.io.write_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()

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)

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:

NoReturn

Returns:

Data returned by the provided load method.

Raises:

DatasetError – When underlying load method raises error.

release()

Release any cached data.

Raises:

DatasetError – when underlying release method raises error.

Return type:

None

resolve_load_version()

Compute the version the dataset should be loaded with.

Return type:

Optional[str]

resolve_save_version()

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 (Figure) – 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