Skip to content

[doc] Document that sanity functions use 're.MULTILINE' #1425

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 3 commits into from
Jul 16, 2020
Merged

[doc] Document that sanity functions use 're.MULTILINE' #1425

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f35b22
Document that sanity functions use 're.MULTILINE'
Jul 16, 2020
59fb5ae
Address PR comments
Jul 16, 2020
cb9960c
Merge branch 'master' into doc/sanity_re_multiline
Jul 16, 2020
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
11 changes: 10 additions & 1 deletion reframe/utility/sanity.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,10 @@ def assert_found(patt, filename, msg=None, encoding='utf-8'):
Any standard Python `regular expression
<https://docs.python.org/3/library/re.html#regular-expression-syntax>`_
is accepted.
The `re.MULTILINE
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
is set for the pattern search.

:arg filename: The name of the file to examine.
Any :class:`OSError` raised while processing the file will be
propagated as a :class:`reframe.core.exceptions.SanityError`.
Expand Down Expand Up @@ -503,6 +507,9 @@ def findall(patt, filename, encoding='utf-8'):
Any standard Python `regular expression
<https://docs.python.org/3/library/re.html#regular-expression-syntax>`_
is accepted.
The `re.MULTILINE
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
is set for the pattern search.
:arg filename: The name of the file to examine.
:arg encoding: The name of the encoding used to decode the file.
:returns: A list of raw `regex match objects
Expand Down Expand Up @@ -556,6 +563,9 @@ def extractall(patt, filename, tag=0, conv=None, encoding='utf-8'):
Any standard Python `regular expression
<https://docs.python.org/3/library/re.html#regular-expression-syntax>`_
is accepted.
The `re.MULTILINE
<https://docs.python.org/3/library/re.html#re.MULTILINE>`_ flag
is set for the pattern search.
:arg filename: The name of the file to examine.
:arg encoding: The name of the encoding used to decode the file.
:arg tag: The regex capturing group to be extracted.
Expand Down Expand Up @@ -589,7 +599,6 @@ def extractsingle(patt, filename, tag=0, conv=None, item=0, encoding='utf-8'):
:arg item: the specific element to extract.
:returns: The extracted value.
:raises reframe.core.exceptions.SanityError: In case of errors.

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