spinetoolbox.spine_db_editor.widgets.spine_db_editor

Contains the SpineDBEditor class.

Module Contents

Classes

SpineDBEditorBase	Base class for SpineDBEditor (i.e. Spine database editor).
SpineDBEditor	A widget to visualize Spine dbs.

class spinetoolbox.spine_db_editor.widgets.spine_db_editor.SpineDBEditorBase(db_mngr)

Bases: PySide6.QtWidgets.QMainWindow

Base class for SpineDBEditor (i.e. Spine database editor).

Parameters

db_mngr (SpineDBManager) – The manager to use

property toolbox

property settings_subgroup

property db_names

property first_db_map

property db_url_codenames

msg

msg_error

file_exported

filepath, progress between 0 and 1, True if sqlite file

static is_db_map_editor()

Always returns True as SpineDBEditors are truly database editors.

Unless, of course, the database can one day be opened in read-only mode. In that case this method should return False.

Returns

Always True

Return type

bool

load_db_urls(db_url_codenames, create=False, update_history=True, window=False)

init_add_undo_redo_actions()

load_previous_urls(_=False)

load_next_urls(_=False)

open_db_file(_=False)

add_db_file(_=False)

create_db_file(_=False)

reset_docs()

Resets the layout of the dock widgets for this URL

_make_docks_menu()

Returns a menu with all dock toggle/view actions. Called by self.add_main_menu().

Returns

QMenu

add_main_menu()

Adds a menu with main actions to toolbar.

_browse_commits()

connect_signals()

Connects signals to slots.

vacuum(_checked=False)

update_undo_redo_actions(_)

_replace_undo_redo_actions(new_undo_action, new_redo_action)

_refresh_undo_redo_actions()

update_commit_enabled(_clean=False)

init_models()

Initializes models.

add_message(msg)

Pushes message to notification stack.

Parameters

msg (str) – String to show in the notification

refresh_copy_paste_actions()

Runs when menus are about to show. Enables or disables actions according to selection status.

copy(checked=False)

Copies data to clipboard.

paste(checked=False)

Pastes data from clipboard.

import_data(data)

Imports data to all database mappings open in the editor.

Parameters

data (dict) – data to import

import_file(checked=False)

Imports file.

It supports SQLite, JSON, and Excel.

import_from_json(file_path)

import_from_sqlite(file_path)

import_from_excel(file_path)

show_mass_export_items_dialog(checked=False)

Shows dialog for user to select dbs and items for export.

_store_export_settings(state)

Stores export items dialog settings.

_clean_up_export_items_dialog()

Cleans up export items dialog.

export_session(checked=False)

Exports changes made in the current session.

mass_export_items(db_map_item_types)

duplicate_entity(entity_item)

Duplicates an entity.

Parameters

entity_item (EntityItem) –

duplicate_scenario(db_map, scen_id)

Duplicates a scenario.

Parameters

• db_map (DiffDatabaseMapping) –

• scen_id (int) –

export_data(db_map_ids_for_export)

Exports data from given dictionary into a file.

Parameters

db_map_ids_for_export – Dictionary mapping db maps to keyword arguments for spinedb_api.export_data

refresh_session(checked=False)

commit_session(checked=False)

Commits dirty database maps.

rollback_session(checked=False)

Rolls back dirty database maps.

receive_session_committed(db_maps, cookie)

receive_session_rolled_back(db_maps)

receive_session_refreshed(db_maps)

show_mass_remove_items_form(checked=False)

Opens the purge items dialog.

_store_purge_settings(state)

Stores Purge items dialog state.

Parameters

state (dict) – dialog state

_clean_up_purge_items_dialog()

Removes references to purge items dialog.

show_parameter_value_editor(index, plain=False)

Shows the parameter_value editor for the given index of given table view.

receive_error_msg(db_map_error_log)

_update_export_enabled()

Updates export enabled.

_log_items_change(msg)

Enables or disables actions and informs the user about what just happened.

_handle_items_added(item_type, db_map_data)

_handle_items_updated(item_type, db_map_data)

_handle_items_removed(item_type, db_map_data)

restore_ui(view_type, fresh=False)

Restores UI state from previous session.

Parameters

• view_type (str) – What the selected view type is.

• fresh (bool) – If true, the view specified with subgroup will be applied, instead of loading the previous window state of the said view.

save_window_state()

Saves window state parameters (size, position, state) via QSettings.

tear_down()

Performs clean up duties.

Returns

True if editor is ready to close, False otherwise

Return type

bool

_prompt_to_commit_changes()

Prompts the user to commit or rollback changes to ‘dirty’ db maps.

Returns

QMessageBox status code

Return type

int

_get_commit_msg(db_names)

Prompts user for commit message.

Parameters

db_names (Iterable of str) – database names

Returns

commit message

Return type

str

_get_rollback_confirmation(db_names)

Prompts user for confirmation before rolling back the session.

Parameters

db_names (Iterable of str) – database names

Returns

True if user confirmed, False otherwise

Return type

bool

_purge_change_notifiers()

Tears down change notifiers.

closeEvent(event)

Handle close window.

Parameters

event (QCloseEvent) – Closing event

static _get_base_dir()

class spinetoolbox.spine_db_editor.widgets.spine_db_editor.SpineDBEditor(db_mngr, db_url_codenames=None)

Bases: spinetoolbox.spine_db_editor.widgets.tabular_view_mixin.TabularViewMixin, spinetoolbox.spine_db_editor.widgets.graph_view_mixin.GraphViewMixin, spinetoolbox.spine_db_editor.widgets.stacked_view_mixin.StackedViewMixin, spinetoolbox.spine_db_editor.widgets.tree_view_mixin.TreeViewMixin, SpineDBEditorBase

A widget to visualize Spine dbs.

Initializes everything.

Parameters

db_mngr (SpineDBManager) – The manager to use

pinned_values_updated

emit_pinned_values_updated()

connect_signals()

Connects signals to slots.

init_models()

Initializes models.

_restart_timer_refresh_tab_order(_visible=False)

_refresh_tab_order()

tabify_and_raise(docks)

Tabifies docks in given list, then raises the first.

Parameters

docks (list) –

restore_dock_widgets()

Docks all floating and or hidden QDockWidgets back to the window.

update_last_view()

begin_style_change()

Begins a style change operation.

end_style_change()

Ends a style change operation.

apply_stacked_style(_checked=None)

Applies the stacked style, inspired in the former tree view.

_finish_stacked_style()

apply_pivot_style(_checked=None)

Applies the pivot style, inspired in the former tabular view.

apply_graph_style(_checked=None)

Applies the graph style, inspired in the former graph view.

static _get_base_dir()