kedro.contrib.io.yaml_local.YAMLLocalDataSet¶
-
class
kedro.contrib.io.yaml_local.
YAMLLocalDataSet
(filepath, save_args=None, version=None)[source]¶ Bases:
kedro.contrib.io.core.DefaultArgumentsMixIn
,kedro.io.core.AbstractVersionedDataSet
YAMLLocalDataset
loads and saves data to a local yaml file usingPyYAML
. See https://pyyaml.org/wiki/PyYAMLDocumentation for details.Example:
from kedro.contrib.io.yaml_local import YAMLLocalDataSet my_dict = { 'a_string': 'Hello, World!', 'a_list': [1, 2, 3] } data_set = YAMLLocalDataSet(filepath="test.yml") data_set.save(my_dict) reloaded = data_set.load() assert my_dict == reloaded
Attributes
YAMLLocalDataSet.DEFAULT_LOAD_ARGS
YAMLLocalDataSet.DEFAULT_SAVE_ARGS
Methods
YAMLLocalDataSet.__init__
(filepath[, …])Creates a new instance of YAMLLocalDataset
pointing to a concrete filepath.YAMLLocalDataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. YAMLLocalDataSet.from_config
(name, config[, …])Create a data set instance using the configuration provided. YAMLLocalDataSet.get_last_load_version
()Versioned datasets should override this property to return last loaded version YAMLLocalDataSet.get_last_save_version
()Versioned datasets should override this property to return last saved version. YAMLLocalDataSet.load
()Loads data by delegation to the provided load method. YAMLLocalDataSet.release
()Release any cached data. YAMLLocalDataSet.save
(data)Saves data by delegation to the provided save method. -
DEFAULT_LOAD_ARGS
= {}¶
-
DEFAULT_SAVE_ARGS
= {'default_flow_style': False}¶
-
__init__
(filepath, save_args=None, version=None)[source]¶ Creates a new instance of
YAMLLocalDataset
pointing to a concrete filepath.Parameters: - filepath (
str
) – path to a local yaml file. - save_args (
Optional
[Dict
[str
,Any
]]) – Arguments passed on to`yaml.dump
. See https://pyyaml.org/wiki/PyYAMLDocumentation for details.{"default_flow_style": False}
in default. - 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 (
-
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
-