kedro.io.CSVS3DataSet¶
-
class
kedro.io.
CSVS3DataSet
(filepath, bucket_name=None, credentials=None, load_args=None, save_args=None, version=None, s3fs_args=None)[source]¶ Bases:
kedro.io.core.AbstractVersionedDataSet
CSVS3DataSet
loads and saves data to a file in S3. It uses s3fs to read and write from S3 and pandas to handle the csv file.Example:
from kedro.io import CSVS3DataSet import pandas as pd data = pd.DataFrame({'col1': [1, 2], 'col2': [4, 5], 'col3': [5, 6]}) data_set = CSVS3DataSet(filepath="test.csv", bucket_name="test_bucket", load_args=None, save_args={"index": False}) data_set.save(data) reloaded = data_set.load() assert data.equals(reloaded)
Attributes
CSVS3DataSet.DEFAULT_LOAD_ARGS
CSVS3DataSet.DEFAULT_SAVE_ARGS
Methods
CSVS3DataSet.__init__
(filepath[, …])Creates a new instance of CSVS3DataSet
pointing to a concrete csv file on S3.CSVS3DataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. CSVS3DataSet.from_config
(name, config[, …])Create a data set instance using the configuration provided. CSVS3DataSet.get_last_load_version
()Versioned datasets should override this property to return last loaded version CSVS3DataSet.get_last_save_version
()Versioned datasets should override this property to return last saved version. CSVS3DataSet.load
()Loads data by delegation to the provided load method. CSVS3DataSet.release
()Release any cached data. CSVS3DataSet.save
(data)Saves data by delegation to the provided save method. -
DEFAULT_LOAD_ARGS
= {}¶
-
DEFAULT_SAVE_ARGS
= {'index': False}¶
-
__init__
(filepath, bucket_name=None, credentials=None, load_args=None, save_args=None, version=None, s3fs_args=None)[source]¶ Creates a new instance of
CSVS3DataSet
pointing to a concrete csv file on S3.Parameters: - filepath (
str
) – Path to a csv file. May contain the full path in S3 including bucket and protocol, e.g. s3://bucket-name/path/to/file.csv. - bucket_name (
Optional
[str
]) – S3 bucket name. Must be specified only if not present infilepath
. - credentials (
Optional
[Dict
[str
,Any
]]) – Credentials to access the S3 bucket, such asaws_access_key_id
,aws_secret_access_key
. - load_args (
Optional
[Dict
[str
,Any
]]) – Pandas options for loading csv files. You can find all available arguments at: 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. You can find all available arguments at: 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 ofkedro.io.core.Version
. If itsload
attribute is None, the latest version will be loaded. If itssave
attribute is None, save version will be autogenerated. - s3fs_args (
Optional
[Dict
[str
,Any
]]) – S3FileSystem options. You can see all available arguments at: https://s3fs.readthedocs.io/en/latest/api.html#s3fs.core.S3FileSystem
Return type: None
- filepath (
-
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 forload
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 forsave
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.- name (
-
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
-