Validation Inspector Dialog

Dialog for viewing NCS validation results.

ValidationInspectorDialog

ValidationInspectorDialog(parent=None, result=None)

Bases: QDialog, WidgetUi

Dialog for showing validation results.

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def __init__(self, parent=None, result=None):
    super().__init__(parent)
    self.setupUi(self)

    flags = self.windowFlags() | QtCore.Qt.WindowMinimizeButtonHint
    self.setWindowFlags(flags)

    QgsGui.enableAutoGeometryRestore(self)

    icon_pixmap = QtGui.QPixmap(ICON_PATH)
    self.icon_la.setPixmap(icon_pixmap)

    help_icon = FileUtils.get_icon("mActionHelpContents_green.svg")
    self.btn_help.setIcon(help_icon)
    self.btn_help.clicked.connect(self.open_help)

    expand_icon = FileUtils.get_icon("mActionExpandTree.svg")
    self.btn_expand.setIcon(expand_icon)
    self.btn_expand.clicked.connect(self.on_expand_all_result_items)

    collapse_icon = FileUtils.get_icon("mActionCollapseTree.svg")
    self.btn_collapse.setIcon(collapse_icon)
    self.btn_collapse.clicked.connect(self.on_collapse_all_result_items)

    revalidate_icon = FileUtils.get_icon("reload_one_direction.svg")
    self.btn_revalidate.setIcon(revalidate_icon)
    self.btn_revalidate.clicked.connect(self.on_revalidate_datasets)

    self.tw_results.setColumnCount(1)
    self.tw_results.setContextMenuPolicy(QtCore.Qt.CustomContextMenu)
    self.tw_results.customContextMenuRequested.connect(
        self.on_custom_menu_requested
    )

    self._revalidation_submit_result = None

    self._validation_result = result
    if self._validation_result is not None:
        self._update()

result property writable

result

Returns the validation result used to show results.

Returns:

Type	Description
ValidationResult	The validation result in the current view or None if not specified.

on_collapse_all_result_items

on_collapse_all_result_items()

Slot raised to collapse all rule result tree items

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_collapse_all_result_items(self):
    """Slot raised to collapse all rule result tree items"""
    self._expand_collapse_all_items(False)

on_copy_detailed_results

on_copy_detailed_results(copy_text)

Slot raised to copy detailed error/warning text.

Parameters:

Name	Type	Description	Default
copy_text	str	Text to be copied to the clipboard.	required

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_copy_detailed_results(self, copy_text: str):
    """Slot raised to copy detailed error/warning text.

    :param copy_text: Text to be copied to the clipboard.
    :type copy_text: str
    """
    # Copy details to the clipboard
    QgsApplication.instance().clipboard().setText(copy_text)

on_custom_menu_requested

on_custom_menu_requested(point)

Slot raised when a custom menu has been requested.

Parameters:

Name	Type	Description	Default
point	QPoint	Position of the context menu event.	required

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_custom_menu_requested(self, point: QtCore.QPoint):
    """Slot raised when a custom menu has been requested.

    :param point: Position of the context menu event.
    :type point: QtCore.QPoint
    """
    item = self.tw_results.itemAt(point)
    if item.type() != DETAILED_RESULT_TYPE:
        return

    # Action for copying detailed result item
    copy_action = QtWidgets.QAction()
    copy_action.setText(tr("Copy"))
    copy_action.setIcon(FileUtils.get_icon("mActionEditCopy.svg"))
    copy_action.triggered.connect(
        lambda: self.on_copy_detailed_results(item.text(0))
    )

    menu = QtWidgets.QMenu(self)
    menu.addAction(copy_action)

    menu.exec_(self.tw_results.mapToGlobal(point))

on_expand_all_result_items

on_expand_all_result_items()

Slot raised to expand all rule result tree items.

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_expand_all_result_items(self):
    """Slot raised to expand all rule result tree items."""
    self._expand_collapse_all_items(True)

on_revalidate_datasets

on_revalidate_datasets()

Revalidate the datasets.

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_revalidate_datasets(self):
    """Revalidate the datasets."""
    ncs_pathways = settings_manager.get_all_ncs_pathways()
    # No need for validating if there are no NCS pathways.
    if len(ncs_pathways) == 0:
        log(message="No datasets for validation.", info=False)

        return

    self._revalidation_submit_result = validation_manager.validate_ncs_pathways(
        ncs_pathways
    )
    if not self._revalidation_submit_result.success:
        QtWidgets.QMessageBox.critical(
            self,
            self.tr("Revalidate NCS Pathways"),
            self.tr("Unable to re-submit NCS pathways for validation"),
        )
        log(message="Unable to re-submit NCS pathways for validation", info=False)

        self.reject()

    self.btn_collapse.setEnabled(False)
    self.btn_expand.setEnabled(False)
    self.btn_revalidate.setEnabled(False)

    self.tw_results.clear()
    status_item = QtWidgets.QTreeWidgetItem()
    status_item.setText(0, tr("Revalidating NCS pathways..."))
    loading_icon = FileUtils.get_icon("loading.svg")
    status_item.setIcon(0, loading_icon)
    self.tw_results.addTopLevelItem(status_item)

    self.progress_dialog = ValidationProgressDialog(
        self._revalidation_submit_result,
        self,
        hide_details_button=True,
        close_on_completion=True,
        cancel_mode=True,
    )
    self.progress_dialog.feedback.validation_completed.connect(
        self.on_validation_complete
    )
    self.progress_dialog.dialog_closed.connect(self.on_revalidation_dialog_closed)
    self.progress_dialog.setModal(False)
    self.progress_dialog.show()

on_revalidation_dialog_closed

on_revalidation_dialog_closed()

Cancel the revalidation process.

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_revalidation_dialog_closed(self):
    """Cancel the revalidation process."""
    if not validation_manager.is_validation_complete(
        self._revalidation_submit_result
    ):
        validation_manager.cancel(self._revalidation_submit_result)
        self.tw_results.clear()
        status_item = QtWidgets.QTreeWidgetItem()
        status_item.setText(0, tr("Validation canceled!"))
        cancel_icon = FileUtils.get_icon("mTaskCancel.svg")
        status_item.setIcon(0, cancel_icon)
        self.tw_results.addTopLevelItem(status_item)

    self.btn_revalidate.setEnabled(True)

on_validation_complete

on_validation_complete(validation_result)

Slot raised when validation has completed.

Parameters:

Name	Type	Description	Default
validation_result	ValidationResult	Result of the validation process.	required

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def on_validation_complete(self, validation_result: ValidationResult):
    """Slot raised when validation has completed.

    :param validation_result: Result of the validation process.
    :type validation_result: ValidationResult
    """
    self.tw_results.clear()

    if validation_result is None:
        status_item = QtWidgets.QTreeWidgetItem()
        status_item.setText(0, tr("Error occurred in the validation process!"))
        error_icon = FileUtils.get_icon("mIconDelete.svg")
        status_item.setIcon(0, error_icon)
        self.tw_results.addTopLevelItem(status_item)
    else:
        self._validation_result = validation_result
        self._update()
        self.btn_collapse.setEnabled(True)
        self.btn_expand.setEnabled(True)

    self.btn_revalidate.setEnabled(True)

open_help

open_help(activated)

Opens the user documentation for the plugin in a browser.

Source code in src/cplus_plugin/gui/validation/inspector_dialog.py

def open_help(self, activated: bool):
    """Opens the user documentation for the plugin in a browser."""
    open_documentation(USER_DOCUMENTATION_SITE)

---

Last update: October 2, 2024