Skip to content

[bugfix] Fix "New in version" annotation for some sanity functions #1754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 8, 2021
Merged

[bugfix] Fix "New in version" annotation for some sanity functions #1754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4bc34bb
Correct "New in version" annotation for some sanity functions
Feb 8, 2021
eebff5a
Fix versionadded annotation in documetation
Feb 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/config_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1017,7 +1017,7 @@ Common scheduler options
As an example, you could have ReFrame trying to resubmit a job in case that the maximum submission limit per user is reached by setting this field to ``["QOSMaxSubmitJobPerUserLimit"]``.
You can ignore multiple errors at the same time if you add more error strings in the list.

.. versionadded:: 3.5
.. versionadded:: 3.4.1

.. warning::
Job submission is a synchronous operation in ReFrame.
Expand Down
14 changes: 7 additions & 7 deletions reframe/utility/sanity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ def assert_found_s(patt, string, msg=None):
:returns: ``True`` on success.
:raises reframe.core.exceptions.SanityError: if assertion fails.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
num_matches = count(finditer_s(patt, string))
try:
Expand Down Expand Up @@ -470,7 +470,7 @@ def assert_not_found_s(patt, string, msg=None):
:returns: ``True`` on success.
:raises reframe.core.exceptions.SanityError: if assertion fails.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
try:
evaluate(assert_found_s(patt, string, msg))
Expand Down Expand Up @@ -587,7 +587,7 @@ def finditer_s(patt, string):
a generator object instead of a list, which you can use to iterate over
the raw matches.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
yield from re.finditer(patt, string, re.MULTILINE)

Expand Down Expand Up @@ -621,7 +621,7 @@ def findall_s(patt, string):
:arg string: The string to examine.
:returns: same as :func:`finall`.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
return list(evaluate(x) for x in finditer_s(patt, string))

Expand Down Expand Up @@ -712,7 +712,7 @@ def extractiter_s(patt, string, tag=0, conv=None):
a generator object, instead of a list, which you can use to iterate over
the extracted values.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
if isinstance(tag, collections.abc.Iterable) and not isinstance(tag, str):
yield from _extractiter_multitag(patt, string, tag, conv)
Expand Down Expand Up @@ -773,7 +773,7 @@ def extractall_s(patt, string, tag=0, conv=None):
:arg conv: as in :func:`extractall`.
:returns: same as :func:`extractall`.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
return list(evaluate(x) for x in extractiter_s(patt, string, tag, conv))

Expand Down Expand Up @@ -826,7 +826,7 @@ def extractsingle_s(patt, string, tag=0, conv=None, item=0):
:returns: The extracted value.
:raises reframe.core.exceptions.SanityError: In case of errors.

.. versionadded:: 3.5
.. versionadded:: 3.4.1
'''
try:
# Explicitly evaluate the expression here, so as to force any exception
Expand Down