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

class widgets.spine_datapackage_widget.SpineDatapackageWidget(data_connection)

Bases: PySide2.QtWidgets.QMainWindow

A widget to allow user to edit a datapackage and convert it to a Spine database in SQLite.

data_connection

Data Connection associated to this widget

Type:DataConnection

msg

msg_proc

msg_error

add_toggle_view_actions(self)

Add toggle view actions to View menu.

show(self)

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

infer_datapackage(self, checked=False)

Called when the user triggers the infer action. Infer datapackage from sources and update ui.

load_datapackage(self)

Load datapackage from ‘datapackage.json’ file in data directory, or infer one from CSV files in that directory.

infer_datapackage_(self)

Infer datapackage from CSV files in data directory.

update_ui(self)

Update ui from datapackage attribute.

connect_signals(self)

Connect signals to slots.

restore_ui(self)

Restore UI state from previous session.

_handle_menu_about_to_show(self)

Called when a menu from the menubar is about to show. Adjust infer action depending on whether or not we have a datapackage. Adjust copy paste actions depending on which widget has the focus. TODO Enable/disable action to save datapackage depending on status.

add_message(self, msg)

Prepend regular message to status bar.

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

add_process_message(self, msg)

Show process message in status bar. This messages stays until replaced.

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

add_error_message(self, msg)

Show error message.

Parameters:msg (str) – String to show

save_datapackage(self, checked=False)

Write datapackage to file ‘datapackage.json’ in data directory.

show_export_to_spine_dialog(self, checked=False)

Show dialog to allow user to select a file to export.

export_to_spine(self, file_path)

Export datapackage into Spine SQlite file.

_handle_converter_progressed(self, step, msg)

_handle_converter_failed(self, msg)

_handle_converter_finished(self)

copy(self, checked=False)

Copy data to clipboard.

paste(self, checked=False)

Paste data from clipboard.

load_resource_data(self)

Load resource data into a local list of tables.

reset_resource_models(self, current, previous)

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

reset_resource_data_model(self)

Reset resource data model with data from newly selected resource.

update_resource_data(self, index, new_value)

Update resource data with newly edited data.

_handle_resource_name_data_committed(self, index, new_name)

Called when line edit delegate wants to edit resource name data. Update resources model and descriptor with new resource name.

_handle_field_name_data_committed(self, index, new_name)

Called when line edit delegate wants to edit field name data. Update name in fields_model, resource_data_model’s header and datapackage descriptor.

_handle_primary_key_data_committed(self, index)

Called when checkbox delegate wants to edit primary key data. Add or remove primary key field accordingly.

_handle_foreign_keys_data_committed(self, index, value)

_handle_foreign_keys_data_changed(self, top_left, bottom_right, roles=None)

Called when foreign keys data is updated in model. Update descriptor accordingly.

_handle_foreign_keys_model_rows_inserted(self, parent, first, last)

create_remove_foreign_keys_row_button(self, index)

Create button to remove foreign keys row.

remove_foreign_key_row(self, button)

closeEvent(self, event=None)

Handle close event.

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

class widgets.spine_datapackage_widget.CustomPackage(descriptor=None, base_path=None, strict=False, storage=None)

Bases: datapackage.Package

Custom datapackage class.

rename_resource(self, old, new)

rename_field(self, resource, old, new)

Rename a field.

set_primary_key(self, resource, *primary_key)

Set primary key for a given resource in the package

append_to_primary_key(self, resource, field)

Append field to resources’s primary key.

remove_from_primary_key(self, resource, field)

Remove field from resources’s primary key.

insert_foreign_key(self, row, resource_name, field_names, reference_resource_name, reference_field_names)

Insert foreign key to a given resource in the package at a given row.

remove_primary_key(self, resource, *primary_key)

Remove the primary key for a given resource in the package

remove_foreign_key(self, resource, fields, reference_resource, reference_fields)

Remove foreign key from the package

remove_foreign_keys_row(self, row, resource)

Remove foreign keys row from the package