Skip to content

Commit

Permalink
We decided to change RF 5.1 to RF 6.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
pekkaklarck committed Sep 29, 2022
1 parent 10654e8 commit 209967d
Show file tree
Hide file tree
Showing 19 changed files with 37 additions and 37 deletions.
6 changes: 3 additions & 3 deletions doc/userguide/src/CreatingTestData/CreatingTestCases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -657,14 +657,14 @@ preserve the exact name used in the data. When tags are compared, for example,
to collect statistics, to select test to be executed, or to remove duplicates,
comparisons are case, space and underscore insensitive.

.. note:: The :setting:`Test Tags` setting is new in Robot Framework 5.1.
.. note:: The :setting:`Test Tags` setting is new in Robot Framework 6.0.
Earlier versions support :setting:`Force Tags` and :setting:`Default Tags`
settings discussed below.

Deprecation of :setting:`Force Tags` and :setting:`Default Tags`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Prior to Robot Framework 5.1, tags could be specified to tests in the Setting section
Prior to Robot Framework 6.0, tags could be specified to tests in the Setting section
using two different settings:

:setting:`Force Tags`
Expand All @@ -684,7 +684,7 @@ Robot Framework 5.2 will introduce a new way for tests to indicate they
`should not get certain globally specified tags`__. Instead of using a separate
setting that tests can override, tests can use syntax `-tag` with their
:setting:`[Tags]` setting to tell they should not get a tag named `tag`.
This syntax *does not* yet work in Robot Framework 5.1, but using
This syntax *does not* yet work in Robot Framework 6.0, but using
:setting:`[Tags]` with a literal value like `-tag` `is now deprecated`__.
If such tags are needed, they can be set using :setting:`Test Tags` or
escaped__ syntax `\-tag` can be used with :setting:`[Tags]`.
Expand Down
12 changes: 6 additions & 6 deletions doc/userguide/src/CreatingTestData/CreatingUserKeywords.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,13 @@ prefix are reserved__ for special features by Robot Framework
itself. Users should thus not use any tag with these prefixes unless actually
activating the special functionality.

.. note:: :setting:`Keyword Tags` is new in Robot Framework 5.1. With earlier
.. note:: :setting:`Keyword Tags` is new in Robot Framework 6.0. With earlier
versions all keyword tags need to be specified using the
:setting:`[Tags]` setting.

.. note:: Robot Framework 5.2 will support `removing globally set tags`__ using
the `-tag` syntax with the :setting:`[Tags]` setting. Creating tags
with literal value like `-tag` `is deprecated`__ in Robot Framework 5.1
with literal value like `-tag` `is deprecated`__ in Robot Framework 6.0
and escaped__ syntax `\-tag` must be used if such tags are actually
needed.

Expand Down Expand Up @@ -689,7 +689,7 @@ after looking for best matches, Robot Framework checks can they be
resolved based on the `library search order`_.

.. note:: Automatically resolving conflicts if multiple keywords with embedded
arguments match is a new feature in Robot Framework 5.1. With older
arguments match is a new feature in Robot Framework 6.0. With older
versions custom regular expressions explained below can be used instead.

Using custom regular expressions
Expand Down Expand Up @@ -792,7 +792,7 @@ to parse the variable syntax correctly. If there are matching braces like in
This syntax is unfortunately not supported by Robot Framework 3.2
or newer and keywords using it must be updated when upgrading.

.. note:: Prior to Robot Framework 5.1, using literal backslashes in the pattern
.. note:: Prior to Robot Framework 6.0, using literal backslashes in the pattern
required double escaping them like `${path:c:\\\\temp\\\\.*}`.
Patterns using literal backslashes need to be updated when upgrading.

Expand All @@ -818,7 +818,7 @@ using the keywords from the earlier example.
A limitation of using variables is that their actual values are not matched against
custom regular expressions. As the result keywords may be called with
values that their custom regexps would not allow. This behavior is deprecated
starting from Robot Framework 5.1 and values will be validated in the future.
starting from Robot Framework 6.0 and values will be validated in the future.
For more information see issue `#4462`__.

__ https://github.com/robotframework/robotframework/issues/4462
Expand Down Expand Up @@ -1080,6 +1080,6 @@ the public one will be used but also this situation causes a warning.
Private keywords are included in spec files created by Libdoc_ but not in its
HTML output files.

.. note:: Private user keywords are new in Robot Framework 5.1.
.. note:: Private user keywords are new in Robot Framework 6.0.

__ `User keyword tags`_
2 changes: 1 addition & 1 deletion doc/userguide/src/CreatingTestData/UsingTestLibraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ different arguments:
Setting a custom name to a test library works both when importing a
library in the Setting section and when using the :name:`Import Library` keyword.

.. note:: Prior to Robot Framework 5.1 the marker to use when giving a custom name
.. note:: Prior to Robot Framework 6.0 the marker to use when giving a custom name
to a library was `WITH NAME` instead of `AS`. The old syntax continues
to work, but it is considered deprecated and will eventually be removed.

Expand Down
2 changes: 1 addition & 1 deletion doc/userguide/src/ExecutingTestCases/PostProcessing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ How merging tests works is explained in the following sections discussing
the two main merge use cases.

.. note:: Getting suite documentation and metadata from merged suites is new in
Robot Framework 5.1.
Robot Framework 6.0.

Merging re-executed tests
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions doc/userguide/src/ExecutingTestCases/TestExecution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,7 @@ test case keywords are executed.

.. note:: The `robot:continue-on-failure` and `robot:recursive-continue-on-failure`
tags are new in Robot Framework 4.1. They do not work properly with
`WHILE` loops prior to Robot Framework 5.1.
`WHILE` loops prior to Robot Framework 6.0.

Disabling continue-on-failure using tags
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -544,7 +544,7 @@ __ `Special failures from keywords`_
__ `Run Keyword And Continue On Failure keyword`_

.. note:: The `robot:stop-on-failure` and `robot:recursive-stop-on-failure`
tags are new in Robot Framework 5.1.
tags are new in Robot Framework 6.0.

TRY/EXCEPT
~~~~~~~~~~
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1244,7 +1244,7 @@ Other types cause conversion failures.
| | | | | and floats are considered to be seconds. | |
+-------------+---------------+------------+--------------+----------------------------------------------------------------+--------------------------------------+
| `Path | PathLike_ | | str_ | Strings are converted `Path <pathli_>`__ objects. On Windows | | `/tmp/absolute/path` |
| <pathli_>`__| | | | `/` is converted to :codesc:`\\` automatically. New in RF 5.1. | | `relative/path/to/file.ext` |
| <pathli_>`__| | | | `/` is converted to :codesc:`\\` automatically. New in RF 6.0. | | `relative/path/to/file.ext` |
| | | | | | | `name.txt` |
+-------------+---------------+------------+--------------+----------------------------------------------------------------+--------------------------------------+
| Enum_ | | | str_ | The specified type must be an enumeration (a subclass of Enum_ | .. sourcecode:: python |
Expand Down Expand Up @@ -1294,7 +1294,7 @@ Other types cause conversion failures.
| | | | Mapping_ | to the specified types and items not included in the type | |
| | | | | spec are not allowed. | class Config(TypedDict): |
| | | | | | width: int |
| | | | | New in RF 5.1. Normal `dict` conversion was used earlier. | enabled: bool |
| | | | | New in RF 6.0. Normal `dict` conversion was used earlier. | enabled: bool |
| | | | | | |
| | | | | | | `{'width': 1600, 'enabled': True}` |
+-------------+---------------+------------+--------------+----------------------------------------------------------------+--------------------------------------+
Expand Down Expand Up @@ -1460,7 +1460,7 @@ with different generic types works according to these rules:
is the same as with lists.

.. note:: Support for converting nested types with generics is new in
Robot Framework 5.1. Same syntax works also with earlier versions,
Robot Framework 6.0. Same syntax works also with earlier versions,
but arguments are only converted to the base type and nested types
are not used for anything.

Expand Down Expand Up @@ -1753,7 +1753,7 @@ the code above:
def example(argument: StrictType):
assert isinstance(argument, StrictType)

.. note:: Using `None` as a strict converter is new in Robot Framework 5.1.
.. note:: Using `None` as a strict converter is new in Robot Framework 6.0.
An explicit converter function needs to be used with earlier versions.

Converter documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ it. If that is needed, `listener version 3`_ can be used instead.
| | | |
| | | * `values`: Return values from a keyword. |
| | | |
| | | Additional attributes for control structures are new in RF 5.1.|
| | | Additional attributes for control structures are new in RF 6.0.|
| | | |
+------------------+------------------+----------------------------------------------------------------+
| end_keyword | name, attributes | Called when a keyword ends. |
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# Version number typically updated by running `invoke set-version <version>`.
# Run `invoke --help set-version` or see tasks.py for details.
VERSION = '5.1b3.dev1'
VERSION = '6.0rc1.dev1'
with open(join(dirname(abspath(__file__)), 'README.rst')) as f:
LONG_DESCRIPTION = f.read()
base_url = 'https://github.com/robotframework/robotframework/blob/master'
Expand Down
2 changes: 1 addition & 1 deletion src/robot/api/parsing.py
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ class were exposed directly via the :mod:`robot.api` package, but other
- :class:`~robot.parsing.model.statements.Break`
- :class:`~robot.parsing.model.statements.Continue`
- :class:`~robot.parsing.model.statements.Comment`
- :class:`~robot.parsing.model.statements.Config` (new in 5.1)
- :class:`~robot.parsing.model.statements.Config` (new in 6.0)
- :class:`~robot.parsing.model.statements.Error`
- :class:`~robot.parsing.model.statements.EmptyLine`
Expand Down
10 changes: 5 additions & 5 deletions src/robot/libdocpkg/standardtypes.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
lists and other containers.
If the type has nested types like ``list[int]``, items are converted
to those types automatically. This in new in Robot Framework 5.1.
to those types automatically. This in new in Robot Framework 6.0.
Examples: ``['one', 'two']``, ``[('one', 1), ('two', 2)]``
''',
Expand All @@ -138,7 +138,7 @@
tuples and other containers.
If the type has nested types like ``tuple[str, int, int]``, items are converted
to those types automatically. This in new in Robot Framework 5.1.
to those types automatically. This in new in Robot Framework 6.0.
Examples: ``('one', 'two')``, ``(('one', 1), ('two', 2))``
''',
Expand All @@ -150,7 +150,7 @@
dictionaries and other containers.
If the type has nested types like ``dict[str, int]``, items are converted
to those types automatically. This in new in Robot Framework 5.1.
to those types automatically. This in new in Robot Framework 6.0.
Examples: ``{'a': 1, 'b': 2}``, ``{'key': 1, 'nested': {'key': 2}}``
''',
Expand All @@ -161,7 +161,7 @@
function. They can contain any values ``ast.literal_eval`` supports.
If the type has nested types like ``set[int]``, items are converted
to those types automatically. This in new in Robot Framework 5.1.
to those types automatically. This in new in Robot Framework 6.0.
Examples: ``{1, 2, 3, 42}``, ``set()`` (an empty set)
''',
Expand All @@ -173,7 +173,7 @@
any values ``ast.literal_eval`` supports.
If the type has nested types like ``frozenset[int]``, items are converted
to those types automatically. This in new in Robot Framework 5.1.
to those types automatically. This in new in Robot Framework 6.0.
Examples: ``{1, 2, 3, 42}``, ``set()`` (an empty set)
'''
Expand Down
2 changes: 1 addition & 1 deletion src/robot/libraries/BuiltIn.py
Original file line number Diff line number Diff line change
Expand Up @@ -1342,7 +1342,7 @@ def should_match_regexp(self, string, pattern, msg=None, values=True, flags=None
| ${group1} = 'Bar'
| ${group2} = '43'
The ``flags`` argument is new in Robot Framework 5.1.
The ``flags`` argument is new in Robot Framework 6.0.
"""
res = re.search(pattern, string, flags=parse_re_flags(flags))
if res is None:
Expand Down
2 changes: 1 addition & 1 deletion src/robot/libraries/Collections.py
Original file line number Diff line number Diff line change
Expand Up @@ -688,7 +688,7 @@ def get_from_dictionary(self, dictionary, key, default=NOT_SET):
=>
| ${value} = 2
Support for ``default`` is new in Robot Framework 5.1.
Support for ``default`` is new in Robot Framework 6.0.
"""
self._validate_dictionary(dictionary)
try:
Expand Down
2 changes: 1 addition & 1 deletion src/robot/libraries/OperatingSystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ class OperatingSystem:
= ``pathlib.Path`` support =
Starting from Robot Framework 5.1, arguments representing paths can be given
Starting from Robot Framework 6.0, arguments representing paths can be given
as [https://docs.python.org/3/library/pathlib.html pathlib.Path] instances
in addition to strings.
Expand Down
8 changes: 4 additions & 4 deletions src/robot/libraries/String.py
Original file line number Diff line number Diff line change
Expand Up @@ -370,7 +370,7 @@ def get_lines_matching_regexp(self, string, pattern, partial_match=False, flags=
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 5.1.
The ``flags`` argument is new in Robot Framework 6.0.
"""
if is_truthy(partial_match):
match = re.compile(pattern, flags=parse_re_flags(flags)).search
Expand Down Expand Up @@ -417,7 +417,7 @@ def get_regexp_matches(self, string, pattern, *groups, flags=None):
| ${named group} = ['he', 'ri']
| ${two groups} = [('h', 'e'), ('r', 'i')]
The ``flags`` argument is new in Robot Framework 5.1.
The ``flags`` argument is new in Robot Framework 6.0.
"""
regexp = re.compile(pattern, flags=parse_re_flags(flags))
groups = [self._parse_group(g) for g in groups]
Expand Down Expand Up @@ -473,7 +473,7 @@ def replace_string_using_regexp(self, string, pattern, replace_with, count=-1, f
| ${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 |
The ``flags`` argument is new in Robot Framework 5.1.
The ``flags`` argument is new in Robot Framework 6.0.
"""
count = self._convert_to_integer(count, 'count')
# re.sub handles 0 and negative counts differently than string.replace
Expand Down Expand Up @@ -520,7 +520,7 @@ def remove_string_using_regexp(self, string, *patterns, flags=None):
``flags=IGNORECASE | MULTILINE``) or embedded to the pattern (e.g.
``(?im)pattern``).
The ``flags`` argument is new in Robot Framework 5.1.
The ``flags`` argument is new in Robot Framework 6.0.
"""
for pattern in patterns:
string = self.replace_string_using_regexp(string, pattern, '', flags=flags)
Expand Down
2 changes: 1 addition & 1 deletion src/robot/result/flattenkeywordmatcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
def validate_flatten_keyword(options):
for opt in options:
low = opt.lower()
# TODO: deprecate 'foritem' in RF 5.1
# TODO: Deprecate 'foritem' in RF 6.1!
if low == 'foritem':
low = 'iteration'
if not (low in ('for', 'while', 'iteration') or
Expand Down
2 changes: 1 addition & 1 deletion src/robot/running/arguments/embedded.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ def map(self, values):

def validate(self, values):
# Validating that embedded args match custom regexps also if args are
# given as variables was initially implemented in RF 5.1. It needed
# given as variables was initially implemented in RF 6.0. It needed
# to be reverted due to backwards incompatibility reasons:
# https://github.com/robotframework/robotframework/issues/4069
#
Expand Down
2 changes: 1 addition & 1 deletion src/robot/utils/argumentparser.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ def __init__(self, usage, name=None, version=None, arg_limits=None,
self._validator = validator
self._auto_help = auto_help
self._auto_version = auto_version
# TODO: Change DeprecationWarning to more loud UserWarning in RF 5.1.
# TODO: Change DeprecationWarning to more loud UserWarning in RF 6.1.
if auto_pythonpath == 'DEPRECATED':
auto_pythonpath = False
else:
Expand Down
2 changes: 1 addition & 1 deletion src/robot/utils/importer.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def import_module(self, name_or_path):
Use :meth:`import_class_or_module` if it is desired to get a class
from the imported module automatically.
New in Robot Framework 5.1.
New in Robot Framework 6.0.
"""
try:
imported, source = self._import(name_or_path, get_class=False)
Expand Down
2 changes: 1 addition & 1 deletion src/robot/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# Version number typically updated by running `invoke set-version <version>`.
# Run `invoke --help set-version` or see tasks.py for details.
VERSION = '5.1b3.dev1'
VERSION = '6.0rc1.dev1'


def get_version(naked=False):
Expand Down

0 comments on commit 209967d

Please sign in to comment.