kedro.io.LambdaDataset

class kedro.io.LambdaDataset(load, save, exists=None, release=None, metadata=None)[source]

LambdaDataset loads and saves data to a data set. It relies on delegating to specific implementation such as csv, sql, etc.

LambdaDataset class captures Exceptions while performing operations on composed Dataset implementations. The composed data set is responsible for providing information on how to resolve the issue when possible. This information should be available through str(error).

Example:

from kedro.io import LambdaDataset
import pandas as pd

file_name = "test.csv"
def load() -> pd.DataFrame:
    raise FileNotFoundError("'{}' csv file not found."
                            .format(file_name))
dataset = LambdaDataset(load, None)

Methods

exists()

Checks whether a data set's output already exists by calling the provided _exists() method.

from_config(name, config[, load_version, ...])

Create a data set instance using the configuration provided.

load()

Loads data by delegation to the provided load method.

release()

Release any cached data.

save(data)

Saves data by delegation to the provided save method.
__init__(load, save, exists=None, release=None, metadata=None)[source]

Creates a new instance of LambdaDataset with references to the required input/output data set methods.

Parameters:

  • load (Callable[[], Any] | None) – Method to load data from a data set.

  • save (Callable[[Any], None] | None) – Method to save data to a data set.

  • exists (Callable[[], bool] | None) – Method to check whether output data already exists.

  • release (Callable[[], None] | None) – Method to release any cached information.

  • metadata (dict[str, Any] | None) – Any arbitrary metadata. This is ignored by Kedro, but may be consumed by users or external plugins.

Raises:

DatasetError – If a method is specified, but is not a Callable.

exists()

Checks whether a data set’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 data set instance using the configuration provided.

Parameters:

  • name (str) – Data set name.

  • config (dict[str, Any]) – Data set config dictionary.

  • load_version (str | None) – Version string to be used for load operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.

  • save_version (str | None) – Version string to be used for save operation if the data set is versioned. Has no effect on the data set if versioning was not enabled.

Return type:

AbstractDataset

Returns:

An instance of an AbstractDataset subclass.

Raises:

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

load()

Loads data by delegation to the provided load method.

Return type:

TypeVar(_DO)

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

save(data)

Saves data by delegation to the provided save method.

Parameters:

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

Raises:
Return type:

None