spinetoolbox.widgets.spine_datapackage_widget

Widget shown to user when opening a ‘datapackage.json’ file in Data Connection item.

author:

13. Marin (KTH)

date:

7.7.2018

Module Contents

Classes

SpineDatapackageWidget	A widget to edit CSV files in a Data Connection and create a tabular datapackage.
CustomPackage	Custom datapackage class.

class spinetoolbox.widgets.spine_datapackage_widget.SpineDatapackageWidget(data_connection)

Bases: PySide2.QtWidgets.QMainWindow

A widget to edit CSV files in a Data Connection and create a tabular datapackage.

Initialize class.

Parameters:data_connection (DataConnection) – Data Connection associated to this widget

msg

msg_error

undo_stack

add_menu_actions(self)

Add extra menu actions.

connect_signals(self)

Connect signals to slots.

update_window_modified(self, _clean=None)

Updates window modified status and save actions depending on the state of the undo stack.

is_resource_dirty(self, resource_index)

get_undo_stack(self, resource_index)

showEvent(self, e)

Called when the form shows. Init datapackage (either from existing datapackage.json or by inferring a new one from sources) and update ui.

load_datapackage(self)

_handle_source_dir_changed(self, _path)

_handle_source_file_changed(self, path)

append_save_resource_actions(self)

_handle_menu_edit_about_to_show(self)

Adjusts copy and paste actions depending on which widget has the focus.

add_message(self, msg)

Prepend regular message to status bar.

Parameters:msg (str) – String to show in QStatusBar

add_error_message(self, msg)

Show error message.

Parameters:msg (str) – String to show

save_all(self, checked=False)

_save_datapackage(self, datapackage_path)

save_resource(self, resource_index)

_save_resource(self, resource_index, filepath)

get_permission(self, *filepaths)

copy(self, checked=False)

Copies data to clipboard.

paste(self, checked=False)

Pastes data from clipboard.

_handle_current_resource_changed(self, current, _previous)

Resets resource data and schema models whenever a new resource is selected.

refresh_models(self, current=None)

_handle_fields_data_changed(self, top_left, bottom_right, roles)

show_foreign_keys_context_menu(self, pos)

_remove_foreign_key(self, checked=False)

restore_ui(self)

Restore UI state from previous session.

closeEvent(self, event=None)

Handle close event.

Parameters:event (QEvent) – Closing event if ‘X’ is clicked.

class spinetoolbox.widgets.spine_datapackage_widget.CustomPackage(*args, **kwargs)

Bases: datapackage.Package

Custom datapackage class.

sources

set_resource_data(self, resource_index, row, column, value)

resource_data(self, resource_index)

add_resource(self, descriptor)

difference_infer(self, path)

Infers only what’s new in the given path.

Parameters:path (str) –

check_resource_name(self, new_name)

rename_resource(self, index, new)

valid_field_names(self, resource_index, new_names)

rename_fields(self, resource_index, field_indexes, old_names, new_names)

Renames fields.

append_to_primary_key(self, resource_index, field_index)

Append field to resources’s primary key.

remove_from_primary_key(self, resource_index, field_index)

Remove field from resources’s primary key.

check_foreign_key(self, resource_index, foreign_key)

Check foreign key.

append_foreign_key(self, resource_index, foreign_key)

insert_foreign_key(self, resource_index, fk_index, foreign_key)

update_foreign_key(self, resource_index, fk_index, foreign_key)

remove_foreign_key(self, resource_index, fk_index)

update_descriptor(self, descriptor_filepath)

Updates this package’s schema from other package’s.