schrodinger.ui.qt.standard.widgets.test.help_button_contract module¶

class schrodinger.ui.qt.standard.widgets.test.help_button_contract.HelpButtonContract¶

Bases: MultiModulePatchMixin

Contract for any class that inherits from HelpButtonMixin.

To use this, the contract must be subclasseed and the following must be defined:

makeHelpButton: a method that returns an instance of the help button

MODULE_MAP = {'maestro': 'schrodinger.ui.qt.standard.widgets._buttons.help_button'}¶

DUMMY_TUTORIALS_JSON_MAP = {'PANEL_A': {'TUTORIAL_ONE': 'Tutorial one text', 'TUTORIAL_TWO': 'Tutorial two text'}}¶

makeHelpButton() → HelpButtonMixin¶

help_btn()¶

test_menu(help_btn)¶: Verify that the help button menu is created correctly based on the tutorials available and show maestro assistant flag.

test_menu_signals(help_btn)¶: Verify that the help button menu signals are emitted correctly.

test_maestro_assistant_option(help_btn)¶: Test that the Maestro Assistant option is hidden when it is set to be hidden or when MAESTRO_ASSISTANT_ENABLED feature flag is disabled.

test_isMaestroAssistantOptionShown(help_btn)¶

test_menu_shown_after_delay(help_btn)¶: Verify that the help menu is shown only if timer’s timeout signal is emitted after mouse enter and before mouse leave events.

test__onClicked_help_menu(help_btn)¶: Test that timer is stopped and help menu is shown when the help button is clicked and menu is available.

test__onClicked_no_help_menu(help_btn)¶: Test that documentationRequested signal is emitted when the help button is clicked and help menu is not available.

test__startShowMenuTimer(help_btn)¶: Test that _startShowMenuTimer starts the timer if it is not active and help menu is available.