kedro.contrib.io.gcs.JSONGCSDataSet¶
-
class
kedro.contrib.io.gcs.
JSONGCSDataSet
(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
JSONGCSDataSet
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 JSON file.Example:
from kedro.contrib.io.gcs import JSONGCSDataSet import pandas as pd data = pd.DataFrame({'col1': [1, 2], 'col2': [4, 5], 'col3': [5, 6]}) data_set = JSONGCSDataSet(filepath="test.json", bucket_name="test_bucket", load_args=None, save_args={"index": False}) data_set.save(data) reloaded = data_set.load() assert data.equals(reloaded)
Attributes
JSONGCSDataSet.DEFAULT_LOAD_ARGS
JSONGCSDataSet.DEFAULT_SAVE_ARGS
Methods
JSONGCSDataSet.__init__
(filepath[, …])Creates a new instance of JSONGCSDataSet
pointing to a concrete JSON file on GCS.JSONGCSDataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. JSONGCSDataSet.from_config
(name, config[, …])Create a data set instance using the configuration provided. JSONGCSDataSet.get_last_load_version
()Versioned datasets should override this property to return last loaded version JSONGCSDataSet.get_last_save_version
()Versioned datasets should override this property to return last saved version. JSONGCSDataSet.load
()Loads data by delegation to the provided load method. JSONGCSDataSet.release
()Release any cached data. JSONGCSDataSet.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
JSONGCSDataSet
pointing to a concrete JSON file on GCS.Parameters: - filepath (
str
) – Path to a JSON file. May contain the full path in Google Cloud Storage including bucket and protocol, e.g. gcs://bucket-name/path/to/file.json. - 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 such asclient_email
andtoken_uri
, orrefresh_token
,client_secret
,client_id
. - load_args (
Optional
[Dict
[str
,Any
]]) – Pandas options for loading JSON files. Here you can find all available arguments: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.read_json.html All defaults are preserved. - save_args (
Optional
[Dict
[str
,Any
]]) – Pandas options for saving JSON files. Here you can find all available arguments: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_json.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 ID, as per: 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
-