kedro.io.HDFS3DataSet

class kedro.io.HDFS3DataSet(filepath, key, bucket_name=None, credentials=None, load_args=None, save_args=None, version=None, s3fs_args=None)[source]

Bases: kedro.io.core.AbstractVersionedDataSet

HDFS3DataSet loads and saves data to a S3 bucket. The underlying functionality is supported by pandas, so it supports all allowed pandas options for loading and saving hdf files.

Example:

from kedro.io import HDFS3DataSet
import pandas as pd

data = pd.DataFrame({'col1': [1, 2], 'col2': [4, 5],
                     'col3': [5, 6]})

data_set = HDFS3DataSet(filepath="test.hdf",
                        bucket_name="test_bucket",
                        key="test_hdf_key",
                        load_args=None,
                        save_args=None)
data_set.save(data)
reloaded = data_set.load()

assert data.equals(reloaded)

Attributes

HDFS3DataSet.DEFAULT_LOAD_ARGS
HDFS3DataSet.DEFAULT_SAVE_ARGS

Methods

HDFS3DataSet.__init__(filepath, key[, …]) Creates a new instance of HDFS3DataSet pointing to a concrete hdf file on S3.
HDFS3DataSet.exists() Checks whether a data set’s output already exists by calling the provided _exists() method.
HDFS3DataSet.from_config(name, config[, …]) Create a data set instance using the configuration provided.
HDFS3DataSet.get_last_load_version() Versioned datasets should override this property to return last loaded version
HDFS3DataSet.get_last_save_version() Versioned datasets should override this property to return last saved version.
HDFS3DataSet.load() Loads data by delegation to the provided load method.
HDFS3DataSet.release() Release any cached data.
HDFS3DataSet.save(data) Saves data by delegation to the provided save method.
DEFAULT_LOAD_ARGS = {}
DEFAULT_SAVE_ARGS = {}
__init__(filepath, key, bucket_name=None, credentials=None, load_args=None, save_args=None, version=None, s3fs_args=None)[source]

Creates a new instance of HDFS3DataSet pointing to a concrete hdf file on S3.

Parameters:
  • filepath (str) – Path to an hdf file. May contain the full path in S3 including bucket and protocol, e.g. s3://bucket-name/path/to/file.hdf.
  • bucket_name (Optional[str]) – S3 bucket name. Must be specified only if not present in filepath.
  • key (str) – Identifier to the group in the HDF store.
  • credentials (Optional[Dict[str, Any]]) – Credentials to access the S3 bucket, such as aws_access_key_id, aws_secret_access_key.
  • load_args (Optional[Dict[str, Any]]) – PyTables options for loading hdf files. You can find all available arguments at: https://www.pytables.org/usersguide/libref/top_level.html#tables.open_file All defaults are preserved.
  • save_args (Optional[Dict[str, Any]]) – PyTables options for saving hdf files. You can find all available arguments at: https://www.pytables.org/usersguide/libref/top_level.html#tables.open_file 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.
  • s3fs_args (Optional[Dict[str, Any]]) – S3FileSystem options. You can find all available arguments at: https://s3fs.readthedocs.io/en/latest/api.html#s3fs.core.S3FileSystem
Return type:

None

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 (Optional[str]) – 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 (Optional[str]) – 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.

get_last_load_version()

Versioned datasets should override this property to return last loaded version

Return type:Optional[str]
get_last_save_version()

Versioned datasets should override this property to return last saved version.

Return type:Optional[str]
load()

Loads data by delegation to the provided load method.

Return type:Any
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 exists method raises error.
Return type:None
save(data)

Saves data by delegation to the provided save method.

Parameters:data (Any) – the value to be saved by provided save method.
Raises:DataSetError – when underlying save method raises error.
Return type:None