Adds values to the end of list.

Arguments

Examples

=>

Combines the given lists together and returns the result.

Arguments

The given lists are not altered by this keyword.

Examples

=>

Converts the given item to a Python dict type.

Arguments

Mainly useful for converting other mappings to normal dictionaries. This includes converting Robot Framework's own DotDict instances that it uses if variables are created using the &{var} syntax.

Use Create Dictionary from the BuiltIn library for constructing new dictionaries.

Converts the given item to a Python list type.

Arguments

Mainly useful for converting tuples and other iterable to lists. Use Create List from the BuiltIn library for constructing new lists.

Returns a copy of the given dictionary.

Arguments

The deepcopy argument controls should the returned dictionary be a shallow or deep copy. By default returns a shallow copy, but that can be changed by giving deepcopy a true value (see Boolean arguments). This is a new option in Robot Framework 3.1.2. Earlier versions always returned shallow copies.

The given dictionary is never altered by this keyword.

Returns a copy of the given list.

Arguments

If the optional deepcopy is given a true value, the returned list is a deep copy. New option in Robot Framework 3.1.2.

The given list is never altered by this keyword.

Returns the number of occurrences of the given value in list.

Arguments

The search can be narrowed to the selected sublist by the start and end indexes having the same semantics as with Get Slice From List keyword. The given list is never altered by this keyword.

Examples

=>

Fails if the given dictionaries are not equal.

Arguments

First the equality of dictionaries' keys is checked and after that all the key value pairs. If there are differences between the values, those are listed in the error message. The types of the dictionaries do not need to be same.

See Lists Should Be Equal for more information about configuring the error message with msg and values arguments.

An item of key / value must be found in a dictionary.

Arguments

Value is converted to unicode for comparison.

Use the msg argument to override the default error message.

Fails if key is not found from dictionary.

Arguments

Use the msg argument to override the default error message.

Fails unless all items in dict2 are found from dict1.

Arguments

See Lists Should Be Equal for more information about configuring the error message with msg and values arguments.

Fails if value is not found from dictionary.

Arguments

Use the msg argument to override the default error message.

Fails if key is found from dictionary.

Arguments

Use the msg argument to override the default error message.

Fails if value is found from dictionary.

Arguments

Use the msg argument to override the default error message.

Returns items of the given dictionary as a list.

Arguments

Uses Get Dictionary Keys to get keys and then returns corresponding items. By default keys are sorted and items returned in that order, but this can be changed by giving sort_keys a false value (see Boolean arguments). Notice that with Python 3.5 and earlier dictionary order is undefined unless using ordered dictionaries.

Items are returned as a flat list so that first item is a key, second item is a corresponding value, third item is the second key, and so on.

The given dictionary is never altered by this keyword.

Examples

=>

sort_keys is a new option in Robot Framework 3.1.2. Earlier items were always sorted based on keys.

Returns keys of the given dictionary as a list.

Arguments

By default keys are returned in sorted order (assuming they are sortable), but they can be returned in the original order by giving sort_keys a false value (see Boolean arguments). Notice that with Python 3.5 and earlier dictionary order is undefined unless using ordered dictionaries.

The given dictionary is never altered by this keyword.

Examples

=>

sort_keys is a new option in Robot Framework 3.1.2. Earlier keys were always sorted.

Returns values of the given dictionary as a list.

Arguments

Uses Get Dictionary Keys to get keys and then returns corresponding values. By default keys are sorted and values returned in that order, but this can be changed by giving sort_keys a false value (see Boolean arguments). Notice that with Python 3.5 and earlier dictionary order is undefined unless using ordered dictionaries.

The given dictionary is never altered by this keyword.

Examples

=>

sort_keys is a new option in Robot Framework 3.1.2. Earlier values were always sorted based on keys.

Returns a value from the given dictionary based on the given key.

Arguments

If the given key cannot be found from the dictionary, this keyword fails.

The given dictionary is never altered by this keyword.

Examples

=>

Returns the value specified with an index from list.

Arguments

The given list is never altered by this keyword.

Index 0 means the first position, 1 the second, and so on. Similarly, -1 is the last position, -2 the second last, and so on. Using an index that does not exist on the list causes an error. The index can be either an integer or a string that can be converted to an integer.

Examples (including Python equivalents in comments):

=>

Returns the index of the first occurrence of the value on the list.

Arguments

The search can be narrowed to the selected sublist by the start and end indexes having the same semantics as with Get Slice From List keyword. In case the value is not found, -1 is returned. The given list is never altered by this keyword.

Examples

=>

Returns the count of matches to pattern in list.

Arguments

For more information on pattern, case_insensitive, and whitespace_insensitive, see Should Contain Match.

Examples:

Returns a list of matches to pattern in list.

Arguments

For more information on pattern, case_insensitive, and whitespace_insensitive, see Should Contain Match.

Examples:

Returns a slice of the given list between start and end indexes.

Arguments

The given list is never altered by this keyword.

If both start and end are given, a sublist containing values from start to end is returned. This is the same as list[start:end] in Python. To get all items from the beginning, use 0 as the start value, and to get all items until and including the end, use None (default) as the end value.

Using start or end not found on the list is the same as using the largest (or smallest) available index.

Examples (incl. Python equivalents in comments):

=>

Inserts value into list to the position specified with index.

Arguments

Index 0 adds the value into the first position, 1 to the second, and so on. Inserting from right works with negative indices so that -1 is the second last position, -2 third last, and so on. Use Append To List to add items to the end of the list.

If the absolute value of the index is greater than the length of the list, the value is added at the end (positive index) or the beginning (negative index). An index can be given either as an integer or a string that can be converted to an integer.

Examples

=>

Keeps the given keys in the dictionary and removes all other.

Arguments

If the given key cannot be found from the dictionary, it is ignored.

Examples

=>

Fails if not all of the elements in list2 are found in list1.

Arguments

The order of values and the number of values are not taken into account.

See Lists Should Be Equal for more information about configuring the error message with msg and values arguments.

Fails if the value is not found from list.

Arguments

Use the msg argument to override the default error message.

Fails if any element in the list is found from it more than once.

Arguments

The default error message lists all the elements that were found from the list multiple times, but it can be overridden by giving a custom msg. All multiple times found items and their counts are also logged.

This keyword works with all iterables that can be converted to a list. The original iterable is never altered.

Fails if the value is found from list.

Arguments

Use the msg argument to override the default error message.

Fails if given lists are unequal.

Arguments

The keyword first verifies that the lists have equal lengths, and then it checks are all their values equal. Possible differences between the values are listed in the default error message like Index 4: ABC != Abc. The types of the lists do not need to be the same. For example, Python tuple and list with same content are considered equal.

The error message can be configured using msg and values arguments:

• If msg is not given, the default error message is used.
• If msg is given and values gets a value considered true (see Boolean arguments), the error message starts with the given msg followed by a newline and the default message.
• If msg is given and values is not given a true value, the error message is just the given msg.

The optional names argument can be used for naming the indices shown in the default error message. It can either be a list of names matching the indices in the lists or a dictionary where keys are indices that need to be named. It is not necessary to name all of the indices. When using a dictionary, keys can be either integers or strings that can be converted to integers.

Examples:

If the items in index 2 would differ in the above examples, the error message would contain a row like Index 2 (email): name@foo.com != name@bar.com.

The optional ignore_order argument can be used to ignore the order of the elements in the lists. Using it requires items to be sortable. This is new in Robot Framework 3.2.

Examples

Logs the size and contents of the dictionary using given level.

Arguments

Valid levels are TRACE, DEBUG, INFO (default), and WARN.

If you only want to log the size, use keyword Get Length from the BuiltIn library.

Logs the length and contents of the list using given level.

Arguments

Valid levels are TRACE, DEBUG, INFO (default), and WARN.

If you only want to the length, use keyword Get Length from the BuiltIn library.

Pops the given key from the dictionary and returns its value.

Arguments

By default the keyword fails if the given key cannot be found from the dictionary. If optional default value is given, it will be returned instead of failing.

Examples

=>

Returns a list without duplicates based on the given list.

Arguments

Creates and returns a new list that contains all items in the given list so that one item can appear only once. Order of the items in the new list is the same as in the original except for missing duplicates. Number of the removed duplicates is logged.

Removes the given keys from the dictionary.

Arguments

If the given key cannot be found from the dictionary, it is ignored.

Examples

=>

Removes and returns the value specified with an index from list.

Arguments

Index 0 means the first position, 1 the second and so on. Similarly, -1 is the last position, -2 the second last, and so on. Using an index that does not exist on the list causes an error. The index can be either an integer or a string that can be converted to an integer.

Examples

=>

Removes all occurrences of given values from list.

Arguments

It is not an error if a value does not exist in the list at all.

Examples

=>

Reverses the given list in place.

Arguments

Note that the given list is changed and nothing is returned. Use Copy List first, if you need to keep also the original order.

=>

Sets the value of list specified by index to the given value.

Arguments

Index 0 means the first position, 1 the second and so on. Similarly, -1 is the last position, -2 second last, and so on. Using an index that does not exist on the list causes an error. The index can be either an integer or a string that can be converted to an integer.

Examples

=>

Adds the given key_value_pairs and items to the dictionary.

Arguments

Giving items as key_value_pairs means giving keys and values as separate arguments:

=>

The latter syntax is typically more convenient to use, but it has a limitation that keys must be strings.

If given keys already exist in the dictionary, their values are updated.

Fails if pattern is not found in list.

Arguments

By default, pattern matching is similar to matching files in a shell and is case-sensitive and whitespace-sensitive. In the pattern syntax, * matches to anything and ? matches to any single character. You can also prepend glob= to your pattern to explicitly use this pattern matching behavior.

If you prepend regexp= to your pattern, your pattern will be used according to the Python re module regular expression syntax. Important note: Backslashes are an escape character, and must be escaped with another backslash (e.g. regexp=\\d{6} to search for \d{6}). See BuiltIn.Should Match Regexp for more details.

If case_insensitive is given a true value (see Boolean arguments), the pattern matching will ignore case.

If whitespace_insensitive is given a true value (see Boolean arguments), the pattern matching will ignore whitespace.

Non-string values in lists are ignored when matching patterns.

Use the msg argument to override the default error message.

See also Should Not Contain Match.

Examples:

Fails if pattern is found in list.

Arguments

Exact opposite of Should Contain Match keyword. See that keyword for information about arguments and usage in general.

Sorts the given list in place.

Arguments

Sorting fails if items in the list are not comparable with each others. On Python 2 most objects are comparable, but on Python 3 comparing, for example, strings with numbers is not possible.

Note that the given list is changed and nothing is returned. Use Copy List first, if you need to keep also the original order.