dotools_py.io.read_excel

Contents

dotools_py.io.read_excel#

dotools_py.io.read_excel(path, filename=None, sheet_name='Sheet1', backend='pandas', **kwargs)[source]#

Read Excel Sheet into a DataFrame.

Parameters:
path str | PathLike[str] | Path

Directory containing the Excel Sheet.

filename str (default: None)

Name of the Excel Sheet file, including its extension. If not specified, assume that path contains the full path to the ExcelSheet.

sheet_name str (default: 'Sheet1')

Name of the Sheet to read.

backend Literal['pandas', 'polars'] (default: 'pandas')

Library to use for reading. If "polars" is selected and reading fails, Pandas is used as a fallback.

**kwargs

Additional arguments passed directly to polars.read_excel or pandas.read_excel.

Return type:

DataFrame

Returns:

Returns a pd.DataFrame containing the content from the selected sheet.