Adds values to the end of list.

Example:

=>

${L1} = ['a', 'xxx']
${L2} = ['a', 'b', 'x', 'y', 'z']

Combines the given lists together and returns the result.

The given lists are not altered by this keyword.

Example:

=>

${x} = ['a', 'a', 'b']
${y} = ['a', 'a', 'b', 'a']
${L1} and ${L2} are not changed.

Converts the given item to a Python dict type.

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.

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.

By default, returns a new dictionary with same items as in the original. Set the deepcopy argument to a true value if also items should be copied.

The given dictionary is never altered by this keyword.

Returns a copy of the given list.

By default, returns a new list with same items as in the original. Set the deepcopy argument to a true value if also items should be copied.

The given list is never altered by this keyword.

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

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.

Example:

=>

${x} = 1
${L3} is not changed

Fails if the given dictionaries are not equal.

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.

ignore_keys can be used to provide a list of keys to ignore in the comparison. It can be an actual list or a Python list literal. This option is new in Robot Framework 6.1. It works recursively with nested dictionaries starting from Robot Framework 7.0.

Examples:

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

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

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

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if key is not found from dictionary.

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails unless all items in dict2 are found from dict1.

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

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if value is not found from dictionary.

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if key is found from dictionary.

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if value is found from dictionary.

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Returns items of the given dictionary as a list.

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.

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.

Example:

Returns keys of the given dictionary as a list.

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.

The given dictionary is never altered by this keyword.

Example:

Returns values of the given dictionary as a list.

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.

The given dictionary is never altered by this keyword.

Example:

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

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

The given dictionary is never altered by this keyword.

Example:

=>

${value} = 2

Support for default is new in Robot Framework 6.0.

Returns the value specified with an index from list.

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):

=>

${x} = 'a'
${y} = 'd'
${L5} is not changed

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

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.

Example:

=>

${x} = 3
${L5} is not changed

Returns the count of matches to pattern in list.

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

Examples:

Returns a list of matches to pattern in list.

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

Examples:

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

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):

=>

${x} = ['c', 'd']
${y} = ['b', 'c', 'd', 'e']
${z} = ['a', 'b', 'c']
${L5} is not changed

Inserts value into list to the position specified with index.

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.

Example:

=>

${L1} = ['xxx', 'a']
${L2} = ['a', 'xxx', 'b']

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

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

Example:

=>

${D5} = {'b': 2, 'd': 4}

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

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.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if the value is not found from list.

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

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

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.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if the value is found from list.

Use the msg argument to override the default error message.

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

Fails if given lists are unequal.

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 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 option works recursively with nested lists starting from Robot Framework 7.0.

Example:

The ignore_case argument can be used to make comparison case-insensitive. See the Ignore case section for more details. This option is new in Robot Framework 7.0.

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

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.

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.

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.

Example:

=>

${val} = 2
${D3} = {'a': 1, 'c': 3}

Returns a list without duplicates based on the given list.

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.

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

Example:

=>

${D3} = {'a': 1, 'c': 3}

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

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.

Example:

=>

${x} = 'a'
${L2} = ['b']

Removes all occurrences of given values from list.

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

Example:

=>

${L4} = ['b', 'd']

Reverses the given list in place.

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

=>

${L3} = ['c', 'b', 'a']

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

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.

Example:

=>

${L3} = ['a', 'xxx', 'yyy']

Starting from Robot Framework 6.1, it is also possible to use the native item assignment syntax. This is equivalent to the above:

Adds the given key_value_pairs and/or items to the dictionary.

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

It is easiest to specify items using the name=value syntax:

=>

${D1} = {'a': 1, 'key': 'value', 'second': 2}

A limitation of the above syntax is that keys must be strings. That can be avoided by passing keys and values as separate arguments:

=>

${D1} = {'a': 1, 'key': 'value', 2: 'value 2'}

Starting from Robot Framework 6.1, it is also possible to use the native item assignment syntax. This is equivalent to the above:

Fails if pattern is not found in list.

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. Notice that the backslash character often used with regular expressions is an escape character in Robot Framework data and needs to be escaped with another backslash like regexp=\\d{6}. See BuiltIn.Should Match Regexp for more details.

Matching is case-sensitive by default, but that can be changed by giving the ignore_case argument a true value (see Boolean arguments). This argument is new in Robot Framework 7.0, but with earlier versions it is possible to use case_insensitive for the same purpose.

It is possible to ignore all whitespace by giving the ignore_whitespace argument a true value. This argument is new in Robot Framework 7.0 as well, and with earlier versions it is possible to use whitespace_insensitive.

Notice that both case_insensitive and whitespace_insensitive are considered deprecated. They will eventually be removed.

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

Use the msg argument to override the default error message.

Examples:

Fails if pattern is found in list.

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

Sorts the given list in place.

Sorting fails if items in the list are not comparable with each others. For example, sorting a list containing strings and numbers is not possible.

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