cfme.web_ui.search module

This module operates the Advanced search box located on multiple pages.

exception cfme.web_ui.search.DisabledButtonException(*args, **kwargs)[source]

Bases: exceptions.Exception

cfme.web_ui.search.apply_filter()[source]

Applies an existing filter

cfme.web_ui.search.check_and_click_close()[source]

Check for display of advanced search close button and click it

cfme.web_ui.search.check_and_click_open()[source]

Check for display of advanced search open button and click it

cfme.web_ui.search.delete_filter(cancel=False)[source]

If possible, deletes the currently loaded filter.

cfme.web_ui.search.ensure_advanced_search_closed()[source]

Checks if the advanced search box is open and if it does, closes it.

cfme.web_ui.search.ensure_advanced_search_open()[source]

Make sure the advanced search box is opened.

If the advanced search box is closed, open it if it exists (otherwise exception raised).

cfme.web_ui.search.ensure_no_filter_applied()[source]

If any filter is applied in the quadicon view, it will be disabled.

cfme.web_ui.search.ensure_normal_search_empty()[source]

Makes sure that the normal search field is empty.

cfme.web_ui.search.fill_and_apply_filter(expression_program, fill_callback=None, cancel_on_user_filling=False)[source]

Fill the filtering expression and apply it

Parameters:
  • expression_program – Expression to fill to the filter.
  • fill_callback – Function to be called for each asked user input (_process_user_filling()).
cfme.web_ui.search.fill_expression(expression_program)[source]

Wrapper to open the box and fill the expression

Parameters:expression_program – the expression to be filled.
cfme.web_ui.search.is_advanced_filter_applied()[source]

Checks whether any filter is in effect on quadicon view

cfme.web_ui.search.is_advanced_search_opened()[source]

Checks whether the advanced search box is currently opened

cfme.web_ui.search.is_advanced_search_possible()[source]

Checks for advanced search possibility in the quadicon view

cfme.web_ui.search.load_and_apply_filter(saved_filter=None, report_filter=None, fill_callback=None, cancel_on_user_filling=False)[source]

Load the filtering expression and apply it

Parameters:
  • saved_filterChoose a saved XYZ filter.
  • report_filterChoose a XYZ report filter.
  • fill_callback – Function to be called for each asked user input.
cfme.web_ui.search.load_filter(saved_filter=None, report_filter=None, cancel=False)[source]

Load saved filter

Parameters:
  • saved_filterChoose a saved XYZ filter
  • report_filterChoose a XYZ report filter
  • cancel – Whether to cancel the load dialog without loading

Do normal search via the search bar.

Parameters:search_term – What to search.
cfme.web_ui.search.reset_filter()[source]

Clears the filter expression

Returns result of clicking reset when enabled Returns false when reset is button is disabled

cfme.web_ui.search.save_and_apply_filter(expression_program, save_name, global_search=False)[source]
cfme.web_ui.search.save_filter(expression_program, save_name, global_search=False, cancel=False)[source]

Fill the filtering expression and save it

Parameters:
  • expression_program – the expression to be filled.
  • save_name – Name of the filter to be saved with.
  • global_search – Whether to check the Global search checkbox.
  • cancel – Whether to cancel the save dialog without saving