# 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.
import os
import re
from fnmatch import fnmatchcase
from random import randint
from string import ascii_lowercase, ascii_uppercase, digits
from typing import Callable, Literal
from robot.api import logger
from robot.utils import FileReader, parse_re_flags, plural_or_not as s, type_name
from robot.version import get_version
from .normalizer import Normalizer
MARKERS = {
"[LOWER]": ascii_lowercase,
"[UPPER]": ascii_uppercase,
"[LETTERS]": ascii_lowercase + ascii_uppercase,
"[NUMBERS]": digits,
"[ARABIC]": "".join(chr(c) for c in range(0x0600, 0x0700)),
"[POLISH]": ascii_lowercase + ascii_uppercase + "ąćęłńóśźżĄĆĘŁŃÓŚŹŻ",
}
[docs]
class String:
"""A library for string manipulation and verification.
``String`` is Robot Framework's standard library for manipulating
strings (e.g. `Replace String Using Regexp`, `Split To Lines`) and
verifying their contents (e.g. `Should Be String`).
In addition to strings, most of the keywords work also with bytes.
Bytes support was heavily enhanced in Robot Framework 7.4.
Following keywords from ``BuiltIn`` library can also be used with strings
and bytes:
- `Get Length`
- `Length Should Be`
- `Should (Not) Be Empty`
- `Should (Not) Be Equal (As Strings/Integers/Numbers)`
- `Should (Not) Match (Regexp)`
- `Should (Not) Contain`
- `Should (Not) Start With`
- `Should (Not) End With`
- `Convert To String`
- `Convert To Bytes`
"""
ROBOT_LIBRARY_SCOPE = "GLOBAL"
ROBOT_LIBRARY_VERSION = get_version()
[docs]
def convert_to_lower_case(self, string: "str | bytes") -> "str | bytes":
"""Converts string to lower case.
Uses Python's standard
[https://docs.python.org/library/stdtypes.html#str.lower|lower()]
method.
Examples:
| ${str1} = | Convert To Lower Case | ABC |
| ${str2} = | Convert To Lower Case | 1A2c3D |
| Should Be Equal | ${str1} | abc |
| Should Be Equal | ${str2} | 1a2c3d |
If this keyword is used with bytes, only ASCII characters are lower cased.
"""
return string.lower()
[docs]
def convert_to_upper_case(self, string: "str | bytes") -> "str | bytes":
"""Converts string to upper case.
Uses Python's standard
[https://docs.python.org/library/stdtypes.html#str.upper|upper()]
method.
Examples:
| ${str1} = | Convert To Upper Case | abc |
| ${str2} = | Convert To Upper Case | 1a2C3d |
| Should Be Equal | ${str1} | ABC |
| Should Be Equal | ${str2} | 1A2C3D |
If this keyword is used with bytes, only ASCII characters are upper cased.
"""
return string.upper()
[docs]
def convert_to_title_case(
self,
string: "str | bytes",
exclude: "str | bytes | list[str | bytes] | None" = None,
) -> "str | bytes":
"""Converts string to title case.
Uses the following algorithm:
- Split the string to words from whitespace characters (spaces,
newlines, etc.).
- Exclude words that are not all lower case. This preserves,
for example, "OK" and "iPhone".
- Exclude also words listed in the optional ``exclude`` argument.
- Title case the first alphabetical character of each word that has
not been excluded.
- Join all words together so that original whitespace is preserved.
Explicitly excluded words can be given as a list or as a string with
words separated by a comma and an optional space. Excluded words are
actually considered to be regular expression patterns, so it is
possible to use something like "example[.!?]?" to match the word
"example" on it own and also if followed by ".", "!" or "?".
See `BuiltIn.Should Match Regexp` for more information about Python
regular expression syntax in general and how to use it in Robot
Framework data in particular.
Examples:
| ${str1} = | Convert To Title Case | hello, world! |
| ${str2} = | Convert To Title Case | it's an OK iPhone | exclude=a, an, the |
| ${str3} = | Convert To Title Case | distance is 1 km. | exclude=is, km.? |
| Should Be Equal | ${str1} | Hello, World! |
| Should Be Equal | ${str2} | It's an OK iPhone |
| Should Be Equal | ${str3} | Distance is 1 km. |
The reason this keyword does not use Python's standard
[https://docs.python.org/library/stdtypes.html#str.title|title()]
method is that it can yield undesired results, for example, if
strings contain upper case letters or special characters like
apostrophes. It would, for example, convert "it's an OK iPhone"
to "It'S An Ok Iphone".
If this keyword is used with bytes, only ASCII characters are title cased.
Bytes support is new in Robot Framework 7.4.
"""
if isinstance(exclude, str):
exclude = [e.strip() for e in exclude.split(",")]
elif isinstance(exclude, bytes):
exclude = [e.strip() for e in exclude.split(b",")]
elif not exclude:
exclude = []
if isinstance(string, bytes):
exclude = [
e.encode("latin-1") if isinstance(e, str) else e for e in exclude
]
split, join = rb"(\s+)", b""
else:
split, join = r"(\s+)", ""
exclude = [re.compile(e) for e in exclude]
def title(word):
if any(e.fullmatch(word) for e in exclude) or not word.islower():
return word
for i, char in enumerate(word):
if isinstance(char, int): # iterating bytes
char = bytes([char])
if char.isalpha():
j = i + 1
return word[:i] + word[i:j].title() + word[j:]
return word
tokens = re.split(split, string)
return join.join(title(t) if i % 2 == 0 else t for i, t in enumerate(tokens))
[docs]
def encode_string_to_bytes(
self,
string: str,
encoding: str,
errors: str = "strict",
) -> bytes:
"""Encodes the given ``string`` to bytes using the given ``encoding``.
``errors`` argument controls what to do if encoding some characters fails.
All values accepted by ``encode`` method in Python are valid, but in
practice the following values are most useful:
- ``strict``: fail if characters cannot be encoded (default)
- ``ignore``: ignore characters that cannot be encoded
- ``replace``: replace characters that cannot be encoded with
a replacement character
Examples:
| ${bytes} = | Encode String To Bytes | ${string} | UTF-8 |
| ${bytes} = | Encode String To Bytes | ${string} | ASCII | errors=ignore |
Use `Convert To Bytes` in ``BuiltIn`` if you want to create bytes based
on character or integer sequences. Use `Decode Bytes To String` if you
need to convert bytes to strings and `Convert To String`
in ``BuiltIn`` if you need to convert arbitrary objects to strings.
"""
return bytes(string.encode(encoding, errors))
[docs]
def decode_bytes_to_string(
self,
bytes: bytes,
encoding: str,
errors: str = "strict",
) -> str:
"""Decodes the given ``bytes`` to a string using the given ``encoding``.
``errors`` argument controls what to do if decoding some bytes fails.
All values accepted by ``decode`` method in Python are valid, but in
practice the following values are most useful:
- ``strict``: fail if characters cannot be decoded (default)
- ``ignore``: ignore characters that cannot be decoded
- ``replace``: replace characters that cannot be decoded with
a replacement character
Examples:
| ${string} = | Decode Bytes To String | ${bytes} | UTF-8 |
| ${string} = | Decode Bytes To String | ${bytes} | ASCII | errors=ignore |
Use `Encode String To Bytes` if you need to convert strings to bytes,
and `Convert To String` in ``BuiltIn`` if you need to
convert arbitrary objects to strings.
"""
return bytes.decode(encoding, errors)
def _bytes_to_string(self, value: object) -> object:
return value.decode("latin-1") if isinstance(value, bytes) else value
def _ensure_bytes(self, value: "str | bytes | None") -> "bytes | None":
if isinstance(value, bytes) or value is None:
return value
return value.encode("latin-1")
[docs]
def get_line_count(self, string: "str | bytes") -> int:
"""Returns and logs the number of lines in the given string."""
count = len(string.splitlines())
logger.info(f"{count} lines.")
return count
[docs]
def split_to_lines(
self,
string: "str | bytes",
start: "int | Literal[''] | None" = 0,
end: "int | Literal[''] | None" = None,
) -> "list[str] | list[bytes]":
"""Splits the given string to lines.
It is possible to get only a selection of lines from ``start``
to ``end`` so that ``start`` index is inclusive and ``end`` is
exclusive. Line numbering starts from 0, and it is possible to
use negative indices to refer to lines from the end.
Lines are returned without the newlines. The number of
returned lines is automatically logged.
Examples:
| @{lines} = | Split To Lines | ${manylines} | |
| @{ignore first} = | Split To Lines | ${manylines} | 1 |
| @{ignore last} = | Split To Lines | ${manylines} | end=-1 |
| @{5th to 10th} = | Split To Lines | ${manylines} | 4 | 10 |
| @{first two} = | Split To Lines | ${manylines} | end=1 |
| @{last two} = | Split To Lines | ${manylines} | -2 |
Use `Get Line` if you only need to get a single line.
"""
start = self._deprecate_empty_string("start", start, 0)
end = self._deprecate_empty_string("end", end, 0)
lines = string.splitlines()[start:end]
logger.info(f"{len(lines)} line{s(lines)} returned.")
return lines
[docs]
def get_line(self, string: "str | bytes", line_number: int) -> "str | bytes":
"""Returns the specified line from the given ``string``.
Line numbering starts from 0, and it is possible to use
negative indices to refer to lines from the end. The line is
returned without the newline character.
Examples:
| ${first} = | Get Line | ${string} | 0 |
| ${2nd last} = | Get Line | ${string} | -2 |
Use `Split To Lines` if all lines are needed.
"""
return string.splitlines()[line_number]
[docs]
def get_lines_containing_string(
self,
string: "str | bytes",
pattern: "str | bytes",
case_insensitive: "bool | None" = None,
ignore_case: bool = False,
) -> "str | bytes":
"""Returns lines of the given ``string`` that contain the ``pattern``.
The ``pattern`` is always considered to be a normal string, not a glob
or regexp pattern. A line matches if the ``pattern`` is found anywhere
on it.
The match is case-sensitive by default, but that can be changed by
giving ``ignore_case`` a true value. This option is new in Robot
Framework 7.0, but with older versions it is possible to use the
nowadays deprecated ``case_insensitive`` argument.
Lines are returned as a string with lines joined together with
a newline. Possible trailing newline is never returned. The number
of matching lines is automatically logged.
Examples:
| ${lines} = | Get Lines Containing String | ${result} | An example |
| ${ret} = | Get Lines Containing String | ${ret} | FAIL | ignore_case=True |
See `Get Lines Matching Pattern` and `Get Lines Matching Regexp`
if you need more complex pattern matching.
If the first argument is bytes, the second argument is automatically
converted to bytes as well.
Bytes support is new in Robot Framework 7.4.
"""
if isinstance(string, bytes):
pattern = self._ensure_bytes(pattern)
if case_insensitive is not None:
ignore_case = case_insensitive
normalize = Normalizer(ignore_case=ignore_case).normalize
pattern = normalize(pattern)
return self._get_matching_lines(string, lambda line: pattern in normalize(line))
[docs]
def get_lines_matching_pattern(
self,
string: "str | bytes",
pattern: "str | bytes",
case_insensitive: "bool | None" = None,
ignore_case: bool = False,
) -> "str | bytes":
"""Returns lines of the given ``string`` that match the ``pattern``.
The ``pattern`` is a _glob pattern_ where:
| ``*`` | matches everything |
| ``?`` | matches any single character |
| ``[chars]`` | matches any character inside square brackets (e.g. ``[abc]`` matches either ``a``, ``b`` or ``c``) |
| ``[!chars]`` | matches any character not inside square brackets |
A line matches only if it matches the ``pattern`` fully.
The match is case-sensitive by default, but that can be changed by
giving ``ignore_case`` a true value. This option is new in Robot
Framework 7.0, but with older versions it is possible to use the
nowadays deprecated ``case_insensitive`` argument.
Lines are returned as a string with lines joined together with
a newline. Possible trailing newline is never returned. The number
of matching lines is automatically logged.
Examples:
| ${lines} = | Get Lines Matching Pattern | ${result} | Wild???? example |
| ${ret} = | Get Lines Matching Pattern | ${ret} | FAIL: * | ignore_case=True |
See `Get Lines Matching Regexp` if you need more complex
patterns and `Get Lines Containing String` if searching
literal strings is enough.
If the first argument is bytes, the second argument is automatically
converted to bytes as well.
Bytes support is new in Robot Framework 7.4.
"""
if isinstance(string, bytes):
pattern = self._ensure_bytes(pattern)
if case_insensitive is not None:
ignore_case = case_insensitive
normalize = Normalizer(ignore_case=ignore_case).normalize
pattern = normalize(pattern)
return self._get_matching_lines(
string,
lambda line: fnmatchcase(normalize(line), pattern),
)
[docs]
def get_lines_matching_regexp(
self,
string: "str | bytes",
pattern: "str | bytes",
partial_match: bool = False,
flags: "str | None" = None,
) -> "str | bytes":
"""Returns lines of the given ``string`` that match the regexp ``pattern``.
See `BuiltIn.Should Match Regexp` for more information about
Python regular expression syntax in general and how to use it
in Robot Framework data in particular.
Lines match only if they match the pattern fully by default, but
partial matching can be enabled by giving the ``partial_match``
argument a true value.
If the pattern is empty, it matches only empty lines by default.
When partial matching is enabled, empty pattern matches all lines.
Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
``re.VERBOSE``) can be given using the ``flags`` argument (e.g.
``flags=IGNORECASE | VERBOSE``) or embedded to the pattern (e.g.
``(?ix)pattern``).
Lines are returned as one string concatenated back together with
newlines. Possible trailing newline is never returned. The
number of matching lines is automatically logged.
Examples:
| ${lines} = | Get Lines Matching Regexp | ${result} | Reg\\\\w{3} example |
| ${lines} = | Get Lines Matching Regexp | ${result} | Reg\\\\w{3} example | partial_match=true |
| ${ret} = | Get Lines Matching Regexp | ${ret} | (?i)FAIL: .* |
| ${ret} = | Get Lines Matching Regexp | ${ret} | FAIL: .* | flags=IGNORECASE |
See `Get Lines Matching Pattern` and `Get Lines Containing String` if you
do not need the full regular expression powers (and complexity).
The ``flags`` argument is new in Robot Framework 6.0.
If the first argument is bytes, the second argument is automatically
converted to bytes as well. This is new in Robot Framework 7.4.
"""
if isinstance(string, bytes):
pattern = self._ensure_bytes(pattern)
regexp = re.compile(pattern, flags=parse_re_flags(flags))
match = regexp.search if partial_match else regexp.fullmatch
return self._get_matching_lines(string, match)
def _get_matching_lines(
self,
string: "str | bytes",
matches: "Callable[[str | bytes], bool | re.Match[str] | None]",
) -> "str | bytes":
lines = string.splitlines()
matching = [line for line in lines if matches(line)]
logger.info(f"{len(matching)} out of {len(lines)} lines matched.")
return ("\n" if isinstance(string, str) else b"\n").join(matching)
[docs]
def get_regexp_matches(
self,
string: "str | bytes",
pattern: "str | bytes",
*groups: "int | str",
flags: "str | None" = None,
) -> "list[str] | list[tuple[str, ...]] | list[bytes] | list[tuple[bytes, ...]]":
"""Returns a list of all non-overlapping matches in the given string.
``string`` is the string to find matches from and ``pattern`` is the
regular expression. See `BuiltIn.Should Match Regexp` for more
information about Python regular expression syntax in general and how
to use it in Robot Framework data in particular.
If no groups are used, the returned list contains full matches. If one
group is used, the list contains only contents of that group. If
multiple groups are used, the list contains tuples that contain
individual group contents. All groups can be given as indexes (starting
from 1) and named groups also as names.
Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
``re.MULTILINE``) can be given using the ``flags`` argument (e.g.
``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
``(?im)pattern``).
Examples:
| ${no match} = | Get Regexp Matches | the string | xxx |
| ${matches} = | Get Regexp Matches | the string | t.. |
| ${matches} = | Get Regexp Matches | the string | T.. | flags=IGNORECASE |
| ${one group} = | Get Regexp Matches | the string | t(..) | 1 |
| ${named group} = | Get Regexp Matches | the string | t(?P<name>..) | name |
| ${two groups} = | Get Regexp Matches | the string | t(.)(.) | 1 | 2 |
=>
| ${no match} = []
| ${matches} = ['the', 'tri']
| ${one group} = ['he', 'ri']
| ${named group} = ['he', 'ri']
| ${two groups} = [('h', 'e'), ('r', 'i')]
If the first argument is bytes, the second argument is automatically
converted to bytes as well. This is new in Robot Framework 7.4.
The ``flags`` argument is new in Robot Framework 6.0.
"""
if isinstance(string, bytes):
pattern = self._ensure_bytes(pattern)
regexp = re.compile(pattern, flags=parse_re_flags(flags))
groups = [self._parse_group(g) for g in groups]
return [m.group(*groups) for m in regexp.finditer(string)]
def _parse_group(self, group: "str | int") -> "str | int":
try:
return int(group)
except ValueError:
return group
[docs]
def replace_string(
self,
string: "str | bytes",
search_for: "str | bytes",
replace_with: "str | bytes",
count: int = -1,
) -> "str | bytes":
"""Replaces ``search_for`` in the given ``string`` with ``replace_with``.
``search_for`` is used as a literal string. See `Replace String
Using Regexp` if more powerful pattern matching is needed.
If you need to just remove a string see `Remove String`.
If the optional argument ``count`` is given, only that many
occurrences from left are replaced. Negative ``count`` means
that all occurrences are replaced (default behaviour) and zero
means that nothing is done.
A modified version of the string is returned and the original
string is not altered.
Examples:
| ${str} = | Replace String | Hello, world! | world | tellus |
| Should Be Equal | ${str} | Hello, tellus! | | |
| ${str} = | Replace String | Hello, world! | l | ${EMPTY} | count=1 |
| Should Be Equal | ${str} | Helo, world! | | |
If the first argument is bytes, the following two arguments are automatically
converted to bytes as well. This is new in Robot Framework 7.4.
"""
if isinstance(string, bytes):
search_for = self._ensure_bytes(search_for)
replace_with = self._ensure_bytes(replace_with)
return string.replace(search_for, replace_with, count)
[docs]
def replace_string_using_regexp(
self,
string: "str | bytes",
pattern: "str | bytes",
replace_with: "str | bytes",
count: int = -1,
flags: "str | None" = None,
) -> "str | bytes":
"""Replaces ``pattern`` in the given ``string`` with ``replace_with``.
This keyword is otherwise identical to `Replace String`, but
the ``pattern`` to search for is considered to be a regular
expression. See `BuiltIn.Should Match Regexp` for more
information about Python regular expression syntax in general
and how to use it in Robot Framework data in particular.
Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
``re.MULTILINE``) can be given using the ``flags`` argument (e.g.
``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
``(?im)pattern``).
If you need to just remove a string see `Remove String Using Regexp`.
Examples:
| ${str} = | Replace String Using Regexp | ${str} | 20\\\\d\\\\d-\\\\d\\\\d-\\\\d\\\\d | <DATE> |
| ${str} = | Replace String Using Regexp | ${str} | (Hello|Hi) | ${EMPTY} | count=1 |
If the first argument is bytes, the following two arguments are automatically
converted to bytes as well. This is new in Robot Framework 7.4.
The ``flags`` argument is new in Robot Framework 6.0.
"""
# re.sub handles 0 and negative counts differently than string.replace
if count == 0:
return string
if isinstance(string, bytes):
pattern = self._ensure_bytes(pattern)
replace_with = self._ensure_bytes(replace_with)
return re.sub(
pattern,
replace_with,
string,
count=max(count, 0),
flags=parse_re_flags(flags),
)
[docs]
def remove_string(
self,
string: "str | bytes",
*removables: "str | bytes",
) -> "str | bytes":
"""Removes all ``removables`` from the given ``string``.
``removables`` are used as literal strings. Each removable will be
matched to a temporary string from which preceding removables have
been already removed. See second example below.
Use `Remove String Using Regexp` if more powerful pattern matching is
needed. If only a certain number of matches should be removed,
`Replace String` or `Replace String Using Regexp` can be used.
A modified version of the string is returned and the original
string is not altered.
Examples:
| ${str} = | Remove String | Robot Framework | work |
| Should Be Equal | ${str} | Robot Frame |
| ${str} = | Remove String | Robot Framework | o | bt |
| Should Be Equal | ${str} | R Framewrk |
If the first argument is bytes, the second argument is automatically
converted to bytes as well.
Bytes support is new in Robot Framework 7.4.
"""
for removable in removables:
string = self.replace_string(string, removable, "")
return string
[docs]
def remove_string_using_regexp(
self,
string: "str | bytes",
*patterns: "str | bytes",
flags: "str | None" = None,
) -> "str | bytes":
"""Removes ``patterns`` from the given ``string``.
This keyword is otherwise identical to `Remove String`, but
the ``patterns`` to search for are considered to be a regular
expression. See `Replace String Using Regexp` for more information
about the regular expression syntax. That keyword can also be
used if there is a need to remove only a certain number of
occurrences.
Possible flags altering how the expression is parsed (e.g. ``re.IGNORECASE``,
``re.MULTILINE``) can be given using the ``flags`` argument (e.g.
``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
``(?im)pattern``).
If the first argument is bytes, the second argument is automatically
converted to bytes as well.
The ``flags`` argument is new in Robot Framework 6.0.
Bytes support is new in Robot Framework 7.4.
"""
for pattern in patterns:
string = self.replace_string_using_regexp(string, pattern, "", flags=flags)
return string
[docs]
def split_string(
self,
string: "str | bytes",
separator: "str | bytes | None" = None,
max_split: int = -1,
) -> "list[str] | list[bytes]":
"""Splits the ``string`` using ``separator`` as a delimiter string.
If a ``separator`` is not given, any whitespace string is a
separator. In that case also possible consecutive whitespace
as well as leading and trailing whitespace is ignored.
Split words are returned as a list. If the optional
``max_split`` is given, at most ``max_split`` splits are done, and
the returned list will have maximum ``max_split + 1`` elements.
Examples:
| @{words} = | Split String | ${string} |
| @{words} = | Split String | ${string} | ,${SPACE} |
| ${pre} | ${post} = | Split String | ${string} | :: | 1 |
See `Split String From Right` if you want to start splitting
from right, and `Fetch From Left` and `Fetch From Right` if
you only want to get first/last part of the string.
If the first argument is bytes, the second argument is automatically
converted to bytes as well. This is new in Robot Framework 7.4.
"""
separator = self._deprecate_empty_string("separator", separator, None)
if isinstance(string, bytes) and separator is not None:
separator = self._ensure_bytes(separator)
return string.split(separator, max_split)
[docs]
def split_string_from_right(
self,
string: "str | bytes",
separator: "str | bytes | None" = None,
max_split: int = -1,
) -> "list[str] | list[bytes]":
"""Splits the ``string`` using ``separator`` starting from right.
Same as `Split String`, but splitting is started from right. This has
an effect only when ``max_split`` is given.
Examples:
| ${first} | ${rest} = | Split String | ${string} | - | 1 |
| ${rest} | ${last} = | Split String From Right | ${string} | - | 1 |
If the first argument is bytes, the second argument is automatically
converted to bytes as well. This is new in Robot Framework 7.4.
"""
separator = self._deprecate_empty_string("separator", separator, None)
if isinstance(string, bytes) and separator is not None:
separator = self._ensure_bytes(separator)
return string.rsplit(separator, max_split)
[docs]
def split_string_to_characters(
self,
string: "str | bytes",
) -> "list[str] | list[bytes]":
"""Splits the given ``string`` to characters.
Example:
| @{characters} = | Split String To Characters | ${string} |
Bytes support is new in Robot Framework 7.4.
"""
if isinstance(string, bytes):
return [bytes([o]) for o in string]
return list(string)
[docs]
def fetch_from_left(
self,
string: "str | bytes",
marker: "str | bytes",
) -> "str | bytes":
"""Returns contents of the ``string`` before the first occurrence of ``marker``.
If the ``marker`` is not found, whole string is returned.
If the first argument is bytes, the second argument is automatically
converted to bytes as well. This is new in Robot Framework 7.4.
See also `Fetch From Right`, `Split String` and `Split String From Right`.
"""
if isinstance(string, bytes):
marker = self._ensure_bytes(marker)
return string.split(marker)[0]
[docs]
def fetch_from_right(
self,
string: "str | bytes",
marker: "str | bytes",
) -> "str | bytes":
"""Returns contents of the ``string`` after the last occurrence of ``marker``.
If the ``marker`` is not found, whole string is returned.
If the first argument is bytes, the second argument is automatically
converted to bytes as well. This is new in Robot Framework 7.4.
See also `Fetch From Left`, `Split String` and `Split String From Right`.
"""
if isinstance(string, bytes):
marker = self._ensure_bytes(marker)
return string.split(marker)[-1]
[docs]
def generate_random_string(
self,
length: "int | str" = 8,
chars: str = "[LETTERS][NUMBERS]",
) -> str:
"""Generates a string with a desired ``length`` from the given ``chars``.
``length`` can be given as a number, a string representation of a number,
or as a range of numbers, such as ``5-10``. When a range of values is given
the range will be selected by random within the range.
The population sequence ``chars`` contains the characters to use
when generating the random string. It can contain any
characters, and it is possible to use special markers
explained in the table below:
| = Marker = | = Explanation = |
| ``[LOWER]`` | Lowercase ASCII characters from ``a`` to ``z``. |
| ``[UPPER]`` | Uppercase ASCII characters from ``A`` to ``Z``. |
| ``[LETTERS]`` | Lowercase and uppercase ASCII characters. |
| ``[NUMBERS]`` | Numbers from 0 to 9. |
| ``[ARABIC]`` | Arabic characters from U+0600 to U+06FF (inclusive). |
| ``[POLISH]`` | ASCII characters and Polish diacritical signs. |
Examples:
| ${ret} = | Generate Random String |
| ${low} = | Generate Random String | 12 | [LOWER] |
| ${bin} = | Generate Random String | 8 | 01 |
| ${hex} = | Generate Random String | 4 | [NUMBERS]abcdef |
| ${rnd} = | Generate Random String | 5-10 | # Generates a string 5 to 10 characters long |
Giving ``length`` as a range of values is new in Robot Framework 5.0.
Support for markers ``[POLISH]`` and ``[ARABIC]`` is new in Robot Framework 7.4.
"""
length = self._deprecate_empty_string("length", length, 8)
if isinstance(length, str) and re.match(r"^\d+-\d+$", length):
min_length, max_length = length.split("-")
length = randint(
self._length_to_int(min_length),
self._length_to_int(max_length),
)
else:
length = self._length_to_int(length)
for name, value in MARKERS.items():
chars = chars.replace(name, value)
maxi = len(chars) - 1
return "".join(chars[randint(0, maxi)] for _ in range(length))
def _length_to_int(self, value: "int | str") -> int:
try:
return int(value)
except ValueError:
raise ValueError(
f"Cannot convert 'length' argument {value!r} to an integer."
)
[docs]
def get_substring(
self,
string: "str | bytes",
start: "int | Literal[''] | None" = 0,
end: "int | Literal[''] | None" = None,
) -> "str | bytes":
"""Returns a substring from ``start`` index to ``end`` index.
The ``start`` index is inclusive and ``end`` is exclusive.
Indexing starts from 0, and it is possible to use
negative indices to refer to characters from the end.
Examples:
| ${ignore first} = | Get Substring | ${string} | 1 | |
| ${ignore last} = | Get Substring | ${string} | 0 | -1 |
| ${5th to 10th} = | Get Substring | ${string} | 4 | 10 |
| ${first two} = | Get Substring | ${string} | 0 | 1 |
| ${last two} = | Get Substring | ${string} | -2 | |
Default value with ``start`` is new in Robot Framework 7.4.
"""
start = self._deprecate_empty_string("start", start, 0)
end = self._deprecate_empty_string("end", end, 0)
return string[start:end]
[docs]
def strip_string(
self,
string: "str | bytes",
mode: Literal["left", "right", "both", "none"] = "both",
characters: "str | bytes | None" = None,
) -> "str | bytes":
"""Remove leading and/or trailing whitespaces from the given string.
``mode`` is either ``left`` to remove leading characters, ``right`` to
remove trailing characters, ``both`` (default) to remove the
characters from both sides of the string or ``none`` to return the
unmodified string.
If the optional ``characters`` is given, it must be a string and the
characters in the string will be stripped in the string. Please note,
that this is not a substring to be removed but a list of characters,
see the example below.
Examples:
| ${stripped}= | Strip String | ${SPACE}Hello${SPACE} | |
| Should Be Equal | ${stripped} | Hello | |
| ${stripped}= | Strip String | ${SPACE}Hello${SPACE} | mode=left |
| Should Be Equal | ${stripped} | Hello${SPACE} | |
| ${stripped}= | Strip String | aabaHelloeee | characters=abe |
| Should Be Equal | ${stripped} | Hello | |
If the first argument is bytes, the ``characters`` argument is automatically
converted to bytes as well.
Bytes support is new in Robot Framework 7.4.
"""
if isinstance(string, bytes) and characters is not None:
characters = self._ensure_bytes(characters)
method = {
"both": string.strip,
"left": string.lstrip,
"right": string.rstrip,
"none": lambda chars: string,
}[mode.lower()]
return method(characters)
[docs]
def should_be_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is not a string.
The default error message can be overridden with the optional ``msg`` argument.
"""
if not isinstance(item, str):
raise AssertionError(msg or f"{item!r} is {type_name(item)}, not a string.")
[docs]
def should_not_be_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is a string.
The default error message can be overridden with the optional ``msg`` argument.
"""
if isinstance(item, str):
raise AssertionError(msg or f"{item!r} is a string.")
[docs]
def should_be_unicode_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is not a Unicode string.
On Python 3 this keyword behaves exactly the same way `Should Be String`.
That keyword should be used instead and this keyword will be deprecated.
"""
self.should_be_string(item, msg)
[docs]
def should_be_byte_string(self, item: object, msg: "str | None" = None):
"""Fails if the given ``item`` is not a byte string.
Use `Should Be String` if you want to verify the ``item`` is a string.
The default error message can be overridden with the optional ``msg`` argument.
"""
if not isinstance(item, bytes):
raise AssertionError(msg or f"{item!r} is not a byte string.")
[docs]
def should_be_lower_case(self, string: "str | bytes", msg: "str | None" = None):
"""Fails if the given ``string`` is not in lower case.
For example, ``'string'`` and ``'with specials!'`` would pass, and
``'String'``, ``''`` and ``' '`` would fail.
The default error message can be overridden with the optional
``msg`` argument.
See also `Should Be Upper Case` and `Should Be Title Case`.
"""
if not string.islower():
raise AssertionError(msg or f"{string!r} is not lower case.")
[docs]
def should_be_upper_case(self, string: "str | bytes", msg: "str | None" = None):
"""Fails if the given ``string`` is not in upper case.
For example, ``'STRING'`` and ``'WITH SPECIALS!'`` would pass, and
``'String'``, ``''`` and ``' '`` would fail.
The default error message can be overridden with the optional
``msg`` argument.
See also `Should Be Title Case` and `Should Be Lower Case`.
"""
if not string.isupper():
raise AssertionError(msg or f"{string!r} is not upper case.")
[docs]
def should_be_title_case(
self,
string: "str | bytes",
msg: "str | None" = None,
exclude: "str | bytes | list[str | bytes] | None" = None,
):
"""Fails if given ``string`` is not title.
``string`` is a title cased string if there is at least one upper case
letter in each word.
For example, ``'This Is Title'`` and ``'OK, Give Me My iPhone'``
would pass. ``'all words lower'`` and ``'Word In lower'`` would fail.
This logic changed in Robot Framework 4.0 to be compatible with
`Convert to Title Case`. See `Convert to Title Case` for title case
algorithm and reasoning.
The default error message can be overridden with the optional
``msg`` argument.
Words can be explicitly excluded with the optional ``exclude`` argument.
Explicitly excluded words can be given as a list or as a string with
words separated by a comma and an optional space. Excluded words are
actually considered to be regular expression patterns, so it is
possible to use something like "example[.!?]?" to match the word
"example" on it own and also if followed by ".", "!" or "?".
See `BuiltIn.Should Match Regexp` for more information about Python
regular expression syntax in general and how to use it in Robot
Framework data in particular.
See also `Should Be Upper Case` and `Should Be Lower Case`.
"""
if string != self.convert_to_title_case(string, exclude):
raise AssertionError(msg or f"{string!r} is not title case.")
def _deprecate_empty_string(
self, name: str, value: object, instead: object
) -> object:
# Deprecated in RF 7.4. TODO: Remove in RF 9.
if value == "":
logger.warn(
f"Using an empty string as a value with argument '{name}' is "
f"deprecated. Use '{instead}' instead."
)
return instead
return value