kedro.io.CSVLocalDataSet

class kedro.io.CSVLocalDataSet(filepath, load_args=None, save_args=None, version=None)

Bases: kedro.io.core.AbstractVersionedDataSet

CSVLocalDataSet loads and saves data to a local csv file. The underlying functionality is supported by pandas, so it supports all allowed pandas options for loading and saving csv files.

Example:

from kedro.io import CSVLocalDataSet
import pandas as pd

data = pd.DataFrame({'col1': [1, 2], 'col2': [4, 5],
                     'col3': [5, 6]})
data_set = CSVLocalDataSet(filepath="test.csv",
                                 load_args=None,
                                 save_args={"index": False})
data_set.save(data)
reloaded = data_set.load()

assert data.equals(reloaded)

Attributes

CSVLocalDataSet.DEFAULT_LOAD_ARGS
CSVLocalDataSet.DEFAULT_SAVE_ARGS

Methods

CSVLocalDataSet.__init__(filepath[, …])	Creates a new instance of CSVLocalDataSet pointing to a concrete filepath.
CSVLocalDataSet.exists()	Checks whether a data set’s output already exists by calling the provided _exists() method.
CSVLocalDataSet.from_config(name, config[, …])	Create a data set instance using the configuration provided.
CSVLocalDataSet.get_last_load_version()	Versioned datasets should override this property to return last loaded version
CSVLocalDataSet.get_last_save_version()	Versioned datasets should override this property to return last saved version.
CSVLocalDataSet.load()	Loads data by delegation to the provided load method.
CSVLocalDataSet.release()	Release any cached data.
CSVLocalDataSet.save(data)	Saves data by delegation to the provided save method.

DEFAULT_LOAD_ARGS = {}

DEFAULT_SAVE_ARGS = {'index': False}

__init__(filepath, load_args=None, save_args=None, version=None)

Creates a new instance of CSVLocalDataSet pointing to a concrete filepath.

Parameters:

• filepath (str) – path to a csv file.
• load_args (Optional[Dict[str, Any]]) – Pandas options for loading csv files. Here you can find all available arguments: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.read_csv.html All defaults are preserved.
• save_args (Optional[Dict[str, Any]]) – Pandas options for saving csv files. Here you can find all available arguments: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_csv.html All defaults are preserved, but “index”, which is set to False.
• 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.

Raises:

ValueError – If ‘filepath’ looks like a remote path.

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