robotframework--Collections库的API介绍

Adds values to the end of list.在list的后面增加值

Example:

=>

 INFO : ${list} = [u‘a‘, u‘b‘]
 INFO : [u‘a‘, u‘b‘, u‘1‘, u‘2‘]

Combines the given lists together and returns the result.The given lists are not altered by this keyword.将给定的列表组合在一起并返回结果。此关键字不会更改给定的列表。

Example:

=>

20170718 17:14:49.280 : INFO : ${l1} = [u‘a‘, u‘b‘]
20170718 17:14:49.282 : INFO : ${l2} = [u‘1‘, u‘2‘]
20170718 17:14:49.283 : INFO : ${x} = [u‘a‘, u‘b‘, u‘1‘, u‘2‘]
20170718 17:14:49.284 : INFO : [u‘a‘, u‘b‘, u‘1‘, u‘2‘]

Converts the given item to a Python dict type.

Mainly useful for converting other mappings to dictionaries. Use Create Dictionary from the BuiltIn library for constructing new dictionaries.New in Robot Framework 2.9.

将给定项目转换为Python dict类型。主要用于将其他映射转换为字典。 使用BuiltIn库中的“创建字典”来构建新的字典。

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.

The given dictionary is never altered by this keyword.

Returns a copy of the given list.

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.

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

The given dictionaries are never altered by this keyword.

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

Value is converted to unicode for comparison.

See Lists Should Be Equal for an explanation of msg. The given dictionary is never altered by this keyword.

Fails if key is not found from dictionary.

See List Should Contain Value for an explanation of msg.

The given dictionary is never altered by this keyword.

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 given dictionaries are never altered by this keyword.

Fails if value is not found from dictionary.

See List Should Contain Value for an explanation of msg.

The given dictionary is never altered by this keyword.

Fails if key is found from dictionary.

See List Should Contain Value for an explanation of msg.

The given dictionary is never altered by this keyword.

Fails if value is found from dictionary.

See List Should Contain Value for an explanation of msg.

The given dictionary is never altered by this keyword.

Returns items of the given dictionary.

Items are returned sorted by keys. The given dictionary is not altered by this keyword.

Example:

=>

${items} = [‘a‘, 1, ‘b‘, 2, ‘c‘, 3]

Returns keys of the given dictionary. 

If keys are sortable, they are returned in sorted order. The given dictionary is never altered by this keyword.

Example:

=>

${keys} = [‘a‘, ‘b‘, ‘c‘]

Returns values of the given dictionary.

Values are returned sorted according to keys. The given dictionary is never altered by this keyword.

Example:

=>

${values} = [1, 2, 3]

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.

The given dictionary is never altered by this keyword.

Example:

=>

${value} = 2

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, and whitespace_insensitive, see Should Contain Match.

Examples:

New in Robot Framework 2.8.6.

Returns a list of matches to pattern in list.

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

Examples:

New in Robot Framework 2.8.6.

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, -2third 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 of the 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.

Fails if the value is not found from list.

If the keyword fails, the default error messages is <list> does not contain value ‘<value>‘. A custom message can be given using the msg argument.

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.

Fails if the value is found from list.

See List Should Contain Value for an explanation of msg.

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.

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.

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}

New in Robot Framework 2.9.2.

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.

New in Robot Framework 2.7.5.

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‘]

Adds the given key_value_pairs and items to the dictionary.

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

=>

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

Starting from Robot Framework 2.8.1, items can also be given as kwargs using key=value syntax:

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.

See List Should Contain Value for an explanation of msg.

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.

The given list is never altered by this keyword.

See also Should Not Contain Match.

Examples:

New in Robot Framework 2.8.6.

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.

New in Robot Framework 2.8.6.

Sorts the given list in place.

The strings are sorted alphabetically and the numbers numerically.

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

${L} = [2,1,‘a‘,‘c‘,‘b‘]

=>

${L} = [1, 2, ‘a‘, ‘b‘, ‘c‘]