kedro.contrib.io.gcs.CSVGCSDataSet¶
-
class
kedro.contrib.io.gcs.
CSVGCSDataSet
(filepath, bucket_name=None, credentials=None, load_args=None, save_args=None, version=None, project=None, gcsfs_args=None)[source]¶ Bases:
kedro.contrib.io.core.DefaultArgumentsMixIn
,kedro.io.core.AbstractVersionedDataSet
CSVGCSDataSet
loads and saves data to a file in GCS (Google Cloud Storage). It uses google-cloud-storage to read and write from GCS and pandas to handle the CSV file.Example:
from kedro.contrib.io.gcs.csv_gcs import CSVGCSDataSet import pandas as pd data = pd.DataFrame({'col1': [1, 2], 'col2': [4, 5], 'col3': [5, 6]}) data_set = CSVGCSDataSet(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
CSVGCSDataSet.DEFAULT_LOAD_ARGS
CSVGCSDataSet.DEFAULT_SAVE_ARGS
Methods
CSVGCSDataSet.__init__
(filepath[, …])Creates a new instance of CSVGCSDataSet
pointing to a concrete csv file on GCS.CSVGCSDataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. CSVGCSDataSet.from_config
(name, config[, …])Create a data set instance using the configuration provided. CSVGCSDataSet.get_last_load_version
()Versioned datasets should override this property to return last loaded version CSVGCSDataSet.get_last_save_version
()Versioned datasets should override this property to return last saved version. CSVGCSDataSet.invalidate_cache
()Invalidate underlying filesystem caches. CSVGCSDataSet.load
()Loads data by delegation to the provided load method. CSVGCSDataSet.release
()Release any cached data. CSVGCSDataSet.save
(data)Saves data by delegation to the provided save method. -
DEFAULT_LOAD_ARGS
= {}¶
-
DEFAULT_SAVE_ARGS
= {}¶
-
__init__
(filepath, bucket_name=None, credentials=None, load_args=None, save_args=None, version=None, project=None, gcsfs_args=None)[source]¶ Creates a new instance of
CSVGCSDataSet
pointing to a concrete csv file on GCS.Parameters: - filepath (
str
) – Path to a CSV file. May contain the full path in Google Cloud Storage including bucket and protocol, e.g.gcs://bucket-name/path/to/file.csv
. - bucket_name (
Optional
[str
]) – GCS bucket name. Must be specified only if not present infilepath
. - credentials (
Optional
[Dict
[str
,Any
]]) – Credentials to access the GCS bucket. Authentication is performed by gcsfs according to https://gcsfs.readthedocs.io/en/latest/#credentials - 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 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. - project (
Optional
[str
]) – The GCP project. If not specified, then the default is inferred by a remote request. https://cloud.google.com/resource-manager/docs/creating-managing-projects - gcsfs_args (
Optional
[Dict
[str
,Any
]]) – Extra arguments to pass intoGCSFileSystem
. See https://gcsfs.readthedocs.io/en/latest/api.html#gcsfs.core.GCSFileSystem
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
-