spinetoolbox.project_item.logging_connection

Contains logging connection and jump classes.

Module Contents

Classes

HeadlessConnection	A project item connection that is compatible with headless mode.
LoggingConnection	A project item connection that is compatible with headless mode.
LoggingJump	Represents a conditional jump between two project items.

Attributes

_DATABASE_ITEM_TYPE

spinetoolbox.project_item.logging_connection._DATABASE_ITEM_TYPE

class spinetoolbox.project_item.logging_connection.HeadlessConnection(source_name, source_position, destination_name, destination_position, options=None, filter_settings=None, legacy_resource_filter_ids=None)

Bases: spine_engine.project_item.connection.ResourceConvertingConnection

A project item connection that is compatible with headless mode.

Parameters

• source_name (str) – source project item’s name

• source_position (str) – source anchor’s position

• destination_name (str) – destination project item’s name

• destination_position (str) – destination anchor’s position

• options (dict, optional) – any additional options

• filter_settings (FilterSettings, optional) – filter settings

property database_resources

Connection’s database resources

set_filter_enabled(resource_label, filter_type, filter_name, enabled)

Enables or disables a filter.

Parameters

• resource_label (str) – database resource name

• filter_type (str) – filter type

• filter_name (str) – filter name

• enabled (bool) – True to enable the filter, False to disable it

set_filter_type_enabled(filter_type, enabled)

Enables or disables a filter type.

Parameters

• filter_type (str) – filter type

• enabled (bool) – True to enable the filter type, False to disable it

_convert_legacy_resource_filter_ids_to_filter_settings()

Converts legacy resource filter ids to filter settings.

This method should be called once after constructing the connection from potentially legacy dict using from_dict().

static _constructor_args_from_dict(connection_dict)

See base class.

classmethod from_dict(connection_dict, **kwargs)

Deserializes a connection from dict.

Parameters

• connection_dict (dict) – serialized LoggingConnection

• **kwargs – additional keyword arguments to be forwarded to class constructor

receive_resources_from_source(resources)

See base class.

replace_resources_from_source(old, new)

Replaces existing resources by new ones.

Parameters

• old (list of ProjectItemResource) – old resources

• new (list of ProjectItemResource) – new resources

class spinetoolbox.project_item.logging_connection.LoggingConnection(*args, toolbox, **kwargs)

Bases: spinetoolbox.log_mixin.LogMixin, HeadlessConnection

A project item connection that is compatible with headless mode.

Parameters

• source_name (str) – source project item’s name

• source_position (str) – source anchor’s position

• destination_name (str) – destination project item’s name

• destination_position (str) – destination anchor’s position

• options (dict, optional) – any additional options

• filter_settings (FilterSettings, optional) – filter settings

property graphics_item

__hash__()

Return hash(self).

static item_type()

has_filters()

Returns True if connection has any filters.

Returns

True if connection has filters, False otherwise

Return type

bool

_get_db_map(url, ignore_version_error=False)

_pop_unused_db_maps()

Removes unused database maps and unregisters from listening the DB manager.

_make_fetch_parent(db_map, item_type)

_fetch_more_if_possible()

_receive_data_changed()

receive_session_committed(db_maps, cookie)

receive_session_rolled_back(db_map)

receive_error_msg(_db_map_error_log)

get_filter_item_names(filter_type, url)

_do_purge_before_writing(resources)

may_have_filters()

Returns whether this connection may have filters.

Returns

True if it is possible for the connection to have filters, False otherwise

Return type

bool

may_have_write_index()

Returns whether this connection may have write index.

Returns

True if it is possible for the connection to have write index, False otherwise

Return type

bool

may_use_memory_db()

Returns whether this connection may use memory DB.

Returns

True if it is possible for the connection to use memory DB, False otherwise

Return type

bool

may_use_datapackage()

Returns whether this connection may use datapackage.

Returns

True if it is possible for the connection to use datapackage, False otherwise

Return type

bool

may_purge_before_writing()

Returns whether this connection may purge before writing.

Returns

True if it is possible for the connection to purge before writing, False otherwise

Return type

bool

online_filters(resource_label, filter_type)

Returns filter online states for given resource and filter type.

Parameters

• resource_label (str) – resource label

• filter_type (str) – filter type

Returns

mapping from filter names to online states

Return type

dict

set_online(resource, filter_type, online)

Sets the given filters online or offline.

Parameters

• resource (str) – Resource label

• filter_type (str) – filter type

• online (dict) – mapping from scenario name to online flag

set_filter_default_online_status(auto_online)

Sets the auto_online flag.

Parameters

auto_online (bool) – If True, unknown filters are online by default

refresh_resource_filter_model()

Makes resource filter mode fetch filter data from database.

set_filter_type_enabled(filter_type, enabled)

See base class.

receive_resources_from_source(resources)

See base class.

replace_resources_from_source(old, new)

See base class.

set_connection_options(options)

Overwrites connections options.

Parameters

options (dict) – new options

_check_available_filters()

Cross-checks filter settings with source databases.

Returns

filter settings containing only filters that exist in source databases

Return type

FilterSettings

_resource_filters_online(resource, filter_type)

to_dict()

See base class.

tear_down()

Releases system resources held by the connection.

class spinetoolbox.project_item.logging_connection.LoggingJump(*args, toolbox=None, **kwargs)

Bases: spinetoolbox.log_mixin.LogMixin, spine_engine.project_item.connection.Jump

Represents a conditional jump between two project items.

Parameters

• source_name (str) – source project item’s name

• source_position (str) – source anchor’s position

• destination_name (str) – destination project item’s name

• destination_position (str) – destination anchor’s position

• condition (dict) – jump condition

property graphics_item

static item_type()