kedro.io.ExcelLocalDataSet

class kedro.io.ExcelLocalDataSet(filepath, engine='xlsxwriter', load_args=None, save_args=None, version=None)[source]

ExcelLocalDataSet loads and saves data to a local Excel file. The underlying functionality is supported by pandas, so it supports all allowed pandas options for loading and saving Excel files.

Example:

from kedro.io import ExcelLocalDataSet
import pandas as pd

data = pd.DataFrame({'col1': [1, 2], 'col2': [4, 5],
                     'col3': [5, 6]})
data_set = ExcelLocalDataSet(filepath="test.xlsx",
                             load_args={'sheet_name':"Sheet1"},
                             save_args=None)
data_set.save(data)
reloaded = data_set.load()

assert data.equals(reloaded)
__init__(filepath, engine='xlsxwriter', load_args=None, save_args=None, version=None)[source]

Creates a new instance of ExcelLocalDataSet pointing to a concrete filepath.

Parameters:
  • engine (str) – The engine used to write to excel files. The default engine is ‘xlswriter’.
  • filepath (str) – path to an Excel file.
  • load_args (Optional[Dict[str, Any]]) – Pandas options for loading Excel files. Here you can find all available arguments: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.read_excel.html The default_load_arg engine is ‘xlrd’, all others preserved.
  • save_args (Optional[Dict[str, Any]]) – Pandas options for saving Excel files. Here you can find all available arguments: https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DataFrame.to_excel.html All defaults are preserved, but “index”, which is set to False.
  • version (Optional[Version]) – If specified, should be an instance of kedro.io.core.Version. If its load attribute is None, the latest version will be loaded. If its save attribute is None, save version will be autogenerated.
Return type:

None

Methods

__init__(filepath[, engine, load_args, …]) Creates a new instance of ExcelLocalDataSet pointing to a concrete filepath.
exists() Checks whether a data set’s output already exists by calling the provided _exists() method.
from_config(name, config[, load_version, …]) Create a data set instance using the configuration provided.
load() Loads data by delegation to the provided load method.
save(data) Saves data by delegation to the provided save method.