Dialogs.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
 
 
from robot.version import get_version
from robot.utils import is_truthy
 
from .dialogs_py import (InputDialog, MessageDialog, MultipleSelectionDialog,
                         PassFailDialog, SelectionDialog)
 
 
__version__ = get_version()
__all__ = ['execute_manual_step', 'get_value_from_user',
           'get_selection_from_user', 'pause_execution', 'get_selections_from_user']
 
 
 
def pause_execution(message='Execution paused. Press OK to continue.'):
    MessageDialog(message).show()
 
 
 
def execute_manual_step(message, default_error=''):
    if not _validate_user_input(PassFailDialog(message)):
        msg = get_value_from_user('Give error message:', default_error)
        raise AssertionError(msg)
 
 
 
def get_value_from_user(message, default_value='', hidden=False):
    return _validate_user_input(InputDialog(message, default_value,
                                            is_truthy(hidden)))
 
 
 
def get_selection_from_user(message, *values):
    return _validate_user_input(SelectionDialog(message, values))
 
 
 
def get_selections_from_user(message, *values):
    return _validate_user_input(MultipleSelectionDialog(message, values))
 
 
def _validate_user_input(dialog):
    value = dialog.show()
    if value is None:
        raise RuntimeError('No value provided by user.')
    return value