`spinetoolbox.spine_io.importers.excel_reader`¶

Contains ExcelConnector class and a help function.

author:	Vennström (VTT)
date:	1.6.2019

Module Contents¶

ExcelConnector Template class to read data from another QThread.

`select_excel_file`(parent=None)	Launches QFileDialog with .xlsx and friends filter
`get_mapped_data_from_xlsx`(filepath)	Returns mapped data from given Excel file assuming it has the default Spine Excel format.
`create_mapping_from_sheet`(worksheet)	Checks if sheet has the default Spine Excel format, if so creates a

spinetoolbox.spine_io.importers.excel_reader.select_excel_file(parent=None)[source]¶: Launches QFileDialog with .xlsx and friends filter

class spinetoolbox.spine_io.importers.excel_reader.ExcelConnector(settings)[source]¶

Template class to read data from another QThread.

Parameters:	settings (dict, optional) – connector specific settings or None

connect_to_source(self, source)[source]¶

saves filepath

Parameters:	{str} -- filepath (source) –

get_tables(self)[source]¶

Method that should return Excel sheets as mappings and their options.

Returns:	Sheets as mappings and options for each sheet or an empty dictionary if no workbook.
Return type:	dict
Raises:	`Exception` – If something goes wrong.

get_data_iterator(self, table, options, max_rows=-1)[source]¶: Return data read from data source table in table. If max_rows is specified only that number of rows.

get_mapped_data(self, tables_mappings, options, table_types, table_row_types, max_rows=-1)[source]¶: Overrides io_api method to check for some parameter_value types.

spinetoolbox.spine_io.importers.excel_reader.get_mapped_data_from_xlsx(filepath)[source]¶

Returns mapped data from given Excel file assuming it has the default Spine Excel format.

Parameters:	filepath (str) – path to Excel file

spinetoolbox.spine_io.importers.excel_reader.create_mapping_from_sheet(worksheet)[source]¶: Checks if sheet has the default Spine Excel format, if so creates a mapping object for each sheet.