kedro.io.JSONLocalDataSet¶
-
class
kedro.io.
JSONLocalDataSet
(filepath, load_args=None, save_args=None, version=None)[source]¶ Bases:
kedro.io.core.AbstractDataSet
,kedro.io.core.ExistsMixin
,kedro.io.core.FilepathVersionMixIn
JSONLocalDataSet
encodes data as json and saves it to a local file or reads in and decodes an existing json file. The encoding/decoding functionality is provided by Python’sjson
library.Example:
from kedro.io import JSONLocalDataSet my_dict = { 'a_string': 'Hello, World!', 'a_list': [1, 2, 3] } data_set = JSONLocalDataSet(filepath="test.json") data_set.save(my_dict) reloaded = data_set.load() assert my_dict == reloaded
Methods
JSONLocalDataSet.__init__
(filepath[, …])Creates a new instance of JSONLocalDataSet
pointing to a concrete filepath.JSONLocalDataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. JSONLocalDataSet.from_config
(name, config[, …])Create a data set instance using the configuration provided. JSONLocalDataSet.load
()Loads data by delegation to the provided load method. JSONLocalDataSet.save
(data)Saves data by delegation to the provided save method. -
__init__
(filepath, load_args=None, save_args=None, version=None)[source]¶ Creates a new instance of
JSONLocalDataSet
pointing to a concrete filepath.Parameters: - filepath (
str
) – path to a local json file. - load_args (
Optional
[Dict
[str
,Any
]]) – Arguments passed on to`json.load
. See https://docs.python.org/3/library/json.html for details. All defaults are preserved. - save_args (
Optional
[Dict
[str
,Any
]]) – Arguments passed on to`json.dump
. See https://docs.python.org/3/library/json.html for details. All defaults are preserved. - 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.
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 (
-
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.
-
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
-