kedro.io.AbstractVersionedDataSet¶
-
class
kedro.io.
AbstractVersionedDataSet
(filepath, version, exists_function=None, glob_function=None)[source]¶ Bases:
kedro.io.core.AbstractDataSet
AbstractVersionedDataSet
is the base class for all versioned data set implementations. All data sets that implement versioning should extend this abstract class and implement the methods marked as abstract.Example:
from kedro.io import AbstractVersionedDataSet import pandas as pd class MyOwnDataSet(AbstractVersionedDataSet): def __init__(self, param1, param2, filepath, version): super().__init__(filepath, version) self._param1 = param1 self._param2 = param2 def _load(self) -> pd.DataFrame: load_path = self._get_load_path() return pd.read_csv(load_path) def _save(self, df: pd.DataFrame) -> None: save_path = self._get_save_path() df.to_csv(save_path) def _describe(self): return dict(version=self._version, param1=self._param1, param2=self._param2)
Methods
AbstractVersionedDataSet.__init__
(filepath, …)Creates a new instance of AbstractVersionedDataSet
.AbstractVersionedDataSet.exists
()Checks whether a data set’s output already exists by calling the provided _exists() method. AbstractVersionedDataSet.from_config
(name, …)Create a data set instance using the configuration provided. AbstractVersionedDataSet.load
()Loads data by delegation to the provided load method. AbstractVersionedDataSet.release
()Release any cached data. AbstractVersionedDataSet.save
(data)Saves data by delegation to the provided save method. -
__init__
(filepath, version, exists_function=None, glob_function=None)[source]¶ Creates a new instance of
AbstractVersionedDataSet
.Parameters: - filepath (
PurePath
) – Path to file. - 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. - exists_function (
Optional
[Callable
[[str
],bool
]]) – Function that is used for determining whether a path exists in a filesystem. - glob_function (
Optional
[Callable
[[str
],List
[str
]]]) – Function that is used for finding all paths in a filesystem, which match a given pattern.
- 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.
-
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
-