floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

revisit/improve docstrings

This commit is contained in:
Daniel Hahler 2020-02-01 23:28:27 +01:00
parent 2681b0aed7
commit 50f81db817
1 changed files with 8 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/_pytest/pytester.py
View File

@ -1341,29 +1341,18 @@ class LineMatcher:
return lines2 return lines2
def fnmatch_lines_random(self, lines2: Sequence[str]) -> None: def fnmatch_lines_random(self, lines2: Sequence[str]) -> None:
"""Check lines exist in the output using in any order. """Check lines exist in the output in any order (using :func:`python:fnmatch.fnmatch`).
Lines are checked using ``fnmatch.fnmatch``. The argument is a list of
lines which have to occur in the output, in any order.
""" """
self._match_lines_random(lines2, fnmatch) self._match_lines_random(lines2, fnmatch)
def re_match_lines_random(self, lines2: Sequence[str]) -> None: def re_match_lines_random(self, lines2: Sequence[str]) -> None:
"""Check lines exist in the output using ``re.match``, in any order. """Check lines exist in the output in any order (using :func:`python:re.match`).
The argument is a list of lines which have to occur in the output, in
any order.
""" """
self._match_lines_random(lines2, lambda name, pat: bool(re.match(pat, name))) self._match_lines_random(lines2, lambda name, pat: bool(re.match(pat, name)))
def _match_lines_random( def _match_lines_random(
self, lines2: Sequence[str], match_func: Callable[[str, str], bool] self, lines2: Sequence[str], match_func: Callable[[str, str], bool]
) -> None: ) -> None:
"""Check lines exist in the output.
The argument is a list of lines which have to occur in the output, in
any order. Each line can contain glob whildcards.
"""
lines2 = self._getlines(lines2) lines2 = self._getlines(lines2)
for line in lines2: for line in lines2:
for x in self.lines: for x in self.lines:
@ -1392,22 +1381,26 @@ class LineMatcher:
return "\n".join(self._log_output) return "\n".join(self._log_output)
def fnmatch_lines(self, lines2: Sequence[str]) -> None: def fnmatch_lines(self, lines2: Sequence[str]) -> None:
"""Search captured text for matching lines using ``fnmatch.fnmatch``. """Check lines exist in the output (using :func:`python:fnmatch.fnmatch`).
The argument is a list of lines which have to match and can use glob The argument is a list of lines which have to match and can use glob
wildcards. If they do not match a pytest.fail() is called. The wildcards. If they do not match a pytest.fail() is called. The
matches and non-matches are also shown as part of the error message. matches and non-matches are also shown as part of the error message.
:param lines2: string patterns to match.
""" """
__tracebackhide__ = True __tracebackhide__ = True
self._match_lines(lines2, fnmatch, "fnmatch") self._match_lines(lines2, fnmatch, "fnmatch")
def re_match_lines(self, lines2: Sequence[str]) -> None: def re_match_lines(self, lines2: Sequence[str]) -> None:
"""Search captured text for matching lines using ``re.match``. """Check lines exist in the output (using :func:`python:re.match`).
The argument is a list of lines which have to match using ``re.match``. The argument is a list of lines which have to match using ``re.match``.
If they do not match a pytest.fail() is called. If they do not match a pytest.fail() is called.
The matches and non-matches are also shown as part of the error message. The matches and non-matches are also shown as part of the error message.
:param lines2: string patterns to match.
""" """
__tracebackhide__ = True __tracebackhide__ = True
self._match_lines( self._match_lines(