spinetoolbox.spine_io.connection_manager

Contains ConnectionManager class.

author:

16. Vennström (VTT)

date:

1.6.2019

Module Contents

Classes

ConnectionManager	Class to manage data connections in another thread.
ConnectionWorker	A class for delegating SourceConnection operations to another QThread.

class spinetoolbox.spine_io.connection_manager.ConnectionManager(connection, connection_settings, parent=None)

Bases: PySide2.QtCore.QObject

Class to manage data connections in another thread.

Parameters:connection (class) – A class derived from SourceConnection, e.g. CSVConnector

start_table_get

start_data_get

start_mapped_data_get

connection_failed

connection_ready

connection_closed

error

fetching_data

data_ready

tables_ready

mapped_data_ready

current_table_changed

Emitted when the current table has changed.

connection

current_table

is_connected

table_options

table_types

table_row_types

source

source_type

set_table(self, table)

Sets the current table of the data source.

Parameters:table (str) – table name

request_tables(self)

Get tables tables from source, emits two singals, fetchingData: ConnectionManager is busy waiting for data startTableGet: a signal that the worker in another thread is listening to know when to run get a list of table names.

request_data(self, table=None, max_rows=-1)

Request data from emits dataReady to with data

Keyword Arguments:  

• {str} -- which table to get data from (default (table) – {None})
• {int} -- how many rows to read (default (max_rows) – {-1})

request_mapped_data(self, table_mappings, max_rows=-1)

Get mapped data from csv file

Parameters:{dict} -- dict with filename as key and a list of mappings as value (table_mappings) – Keyword Arguments:  {int} -- number of rows to read, if -1 read all rows (default (max_rows) – {-1})

connection_ui(self)

launches a modal ui that prompts the user to select source.

ex: fileselect if source is a file.

init_connection(self)

Creates a Worker and a new thread to read source data. If there is an existing thread close that one.

_handle_connection_ready(self)

_handle_tables_ready(self, table_options)

update_options(self, options)

get_current_options(self)

get_current_option_value(self, option_key)

Returns the value for option_key for the current table or the default value.

set_table_options(self, options)

Sets connection manager options for current connector

Parameters:options (dict) – settings for the tables

set_table_types(self, types)

Sets connection manager types for current connector

Parameters:types (dict) – dict with types settings, column (int) as key, type as value

set_table_row_types(self, types)

Sets connection manager types for current connector

Parameters:{dict} -- Dict with types settings, row (types) –

close_connection(self)

Closes and deletes thread and worker

class spinetoolbox.spine_io.connection_manager.ConnectionWorker(source, connection, connection_settings, parent=None)

Bases: PySide2.QtCore.QObject

A class for delegating SourceConnection operations to another QThread.

Parameters:

• source (str) – path of the source file
• connection (class) – A class derived from SourceConnection for connecting to the source file

connectionFailed

error

connectionReady

tablesReady

dataReady

mappedDataReady

init_connection(self)

Connect to data source

tables(self)

data(self, table, options, max_rows)

mapped_data(self, table_mappings, options, types, table_row_types, max_rows)

disconnect(self)