Skip to content

robot.libraries.Dialogs

A library providing dialogs for interacting with users.

Dialogs is Robot Framework's standard library that provides means for pausing the test or task execution and getting input from users.

Long lines in the provided messages are wrapped automatically. If you want to wrap lines manually, you can add newlines using the \n character sequence.

The library has a known limitation that it cannot be used with timeouts.

pause_execution 

1
2
3
pause_execution(
    message="Execution paused. Press OK to continue.",
)

Pauses execution until user clicks Ok button.

message is the message shown in the dialog.

Source code in src/robot/libraries/Dialogs.py 
40
41
42
43
44
45
def pause_execution(message='Execution paused. Press OK to continue.'):
    """Pauses execution until user clicks ``Ok`` button.

    ``message`` is the message shown in the dialog.
    """
    MessageDialog(message).show()

execute_manual_step 

1
execute_manual_step(message, default_error='')

Pauses execution until user sets the keyword status.

User can press either PASS or FAIL button. In the latter case execution fails and an additional dialog is opened for defining the error message.

message is the instruction shown in the initial dialog and default_error is the default value shown in the possible error message dialog.

Source code in src/robot/libraries/Dialogs.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
def execute_manual_step(message, default_error=''):
    """Pauses execution until user sets the keyword status.

    User can press either ``PASS`` or ``FAIL`` button. In the latter case execution
    fails and an additional dialog is opened for defining the error message.

    ``message`` is the instruction shown in the initial dialog and
    ``default_error`` is the default value shown in the possible error message
    dialog.
    """
    if not _validate_user_input(PassFailDialog(message)):
        msg = get_value_from_user('Give error message:', default_error)
        raise AssertionError(msg)

get_value_from_user 

1
2
3
get_value_from_user(
    message, default_value="", hidden=False
)

Pauses execution and asks user to input a value.

Value typed by the user, or the possible default value, is returned. Returning an empty value is fine, but pressing Cancel fails the keyword.

message is the instruction shown in the dialog and default_value is the possible default value shown in the input field.

If hidden is given a true value, the value typed by the user is hidden. hidden is considered true if it is a non-empty string not equal to false, none or no, case-insensitively. If it is not a string, its truth value is got directly using same [http://docs.python.org/library/stdtypes.html#truth|rules as in Python].

Example: | ${username} = | Get Value From User | Input user name | default | | ${password} = | Get Value From User | Input password | hidden=yes |

Source code in src/robot/libraries/Dialogs.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def get_value_from_user(message, default_value='', hidden=False):
    """Pauses execution and asks user to input a value.

    Value typed by the user, or the possible default value, is returned.
    Returning an empty value is fine, but pressing ``Cancel`` fails the keyword.

    ``message`` is the instruction shown in the dialog and ``default_value`` is
    the possible default value shown in the input field.

    If ``hidden`` is given a true value, the value typed by the user is hidden.
    ``hidden`` is considered true if it is a non-empty string not equal to
    ``false``, ``none`` or ``no``, case-insensitively. If it is not a string,
    its truth value is got directly using same
    [http://docs.python.org/library/stdtypes.html#truth|rules as in Python].

    Example:
    | ${username} = | Get Value From User | Input user name | default    |
    | ${password} = | Get Value From User | Input password  | hidden=yes |
    """
    return _validate_user_input(InputDialog(message, default_value,
                                            is_truthy(hidden)))

get_selection_from_user 

1
get_selection_from_user(message, *values, default=None)

Pauses execution and asks user to select a value.

The selected value is returned. Pressing Cancel fails the keyword.

message is the instruction shown in the dialog, values are the options given to the user and default is the optional default value.

The default value can either be one of the specified values or the index of the value starting from 1. For example, default=user1 and default=1 in the examples below have the exact same effect.

Example: | ${user} = | Get Selection From User | Select user | user1 | user2 | admin | | ${user} = | Get Selection From User | Select user | user1 | user2 | admin | default=user1 | | ${user} = | Get Selection From User | Select user | user1 | user2 | admin | default=1 |

default is new in Robot Framework 7.1.

Source code in src/robot/libraries/Dialogs.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def get_selection_from_user(message, *values, default=None):
    """Pauses execution and asks user to select a value.

    The selected value is returned. Pressing ``Cancel`` fails the keyword.

    ``message`` is the instruction shown in the dialog, ``values`` are
    the options given to the user and ``default`` is the optional default value.

    The default value can either be one of the specified values or the index of
    the value starting from ``1``. For example, ``default=user1`` and ``default=1``
    in the examples below have the exact same effect.

    Example:
    | ${user} = | Get Selection From User | Select user | user1 | user2 | admin |
    | ${user} = | Get Selection From User | Select user | user1 | user2 | admin | default=user1 |
    | ${user} = | Get Selection From User | Select user | user1 | user2 | admin | default=1 |

    ``default`` is new in Robot Framework 7.1.
    """
    return _validate_user_input(SelectionDialog(message, values, default))

get_selections_from_user 

1
get_selections_from_user(message, *values)

Pauses execution and asks user to select multiple values.

The selected values are returned as a list. Selecting no values is OK and in that case the returned list is empty. Pressing Cancel fails the keyword.

message is the instruction shown in the dialog and values are the options given to the user.

Example: | ${users} = | Get Selections From User | Select users | user1 | user2 | admin |

Source code in src/robot/libraries/Dialogs.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def get_selections_from_user(message, *values):
    """Pauses execution and asks user to select multiple values.

    The selected values are returned as a list. Selecting no values is OK
    and in that case the returned list is empty. Pressing ``Cancel`` fails
    the keyword.

    ``message`` is the instruction shown in the dialog and ``values`` are
    the options given to the user.

    Example:
    | ${users} = | Get Selections From User | Select users | user1 | user2 | admin |
    """
    return _validate_user_input(MultipleSelectionDialog(message, values))