pasteur.kedro.dataset.modified.PatternDataset

pasteur.kedro.dataset.modified.PatternDataset#

class pasteur.kedro.dataset.modified.PatternDataset(path, dataset, filepath_arg='filepath', filename_suffix='', credentials=None, load_args=None, fs_args=None, overwrite=False, pattern='', replace_pattern='', replace_format='')[source]#

Adds pattern support to Partitioned Dataset

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.

save(data)

Saves data by delegation to the provided save method.
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()#

Loads data by delegation to the provided load method.

Return type:

None

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 (dict[str, Any]) – 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