Skip to content

Commit

Permalink
Change Exception message
Browse files Browse the repository at this point in the history
See #7489
  • Loading branch information
Lewiscowles1986 committed Jul 14, 2020
1 parent 358150c commit 90afa50
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 6 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ Kyle Altendorf
Lawrence Mitchell
Lee Kamentsky
Lev Maximov
Lewis Cowles
Llandy Riveron Del Risco
Loic Esteve
Lukas Bednar
Expand Down
1 change: 1 addition & 0 deletions changelog/7489.improvement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The :func:`pytest.raises` function has a clearer error message when ``match`` matches the obtained string but is not regex-escaped.
8 changes: 5 additions & 3 deletions src/_pytest/_code/code.py
Original file line number Diff line number Diff line change
Expand Up @@ -609,9 +609,11 @@ def match(self, regexp: "Union[str, Pattern]") -> "Literal[True]":
If it matches `True` is returned, otherwise an `AssertionError` is raised.
"""
__tracebackhide__ = True
assert re.search(
regexp, str(self.value)
), "Pattern {!r} does not match {!r}".format(regexp, str(self.value))
regextest = re.search(regexp, str(self.value))
msg = "Regex pattern r{!r} does not match {!r}."
if regexp == str(self.value):
msg += " Did you mean to `re.escape()` the regex?"
assert regextest, msg.format(regexp, str(self.value))
# Return True to allow for "assert excinfo.match()".
return True

Expand Down
2 changes: 1 addition & 1 deletion testing/code/test_excinfo.py
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ def test_division_zero():
result = testdir.runpytest()
assert result.ret != 0

exc_msg = "Pattern '[[]123[]]+' does not match 'division by zero'"
exc_msg = "Regex pattern r'[[]123[]]+' does not match 'division by zero'."
result.stdout.fnmatch_lines(["E * AssertionError: {}".format(exc_msg)])
result.stdout.no_fnmatch_line("*__tracebackhide__ = True*")

Expand Down
16 changes: 14 additions & 2 deletions testing/python/raises.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ def test_raises_match(self) -> None:
int("asdf")

msg = "with base 16"
expr = "Pattern {!r} does not match \"invalid literal for int() with base 10: 'asdf'\"".format(
expr = "Regex pattern r{!r} does not match \"invalid literal for int() with base 10: 'asdf'\".".format(
msg
)
with pytest.raises(AssertionError, match=re.escape(expr)):
Expand All @@ -223,7 +223,19 @@ def test_match_failure_string_quoting(self):
with pytest.raises(AssertionError, match="'foo"):
raise AssertionError("'bar")
(msg,) = excinfo.value.args
assert msg == 'Pattern "\'foo" does not match "\'bar"'
assert msg == 'Regex pattern r"\'foo" does not match "\'bar".'

def test_match_failure_exact_string_message(self):
message = "Oh here is a message with (42) numbers in parameters"
with pytest.raises(AssertionError) as excinfo:
with pytest.raises(AssertionError, match=message):
raise AssertionError(message)
(msg,) = excinfo.value.args
assert msg == (
"Regex pattern r'Oh here is a message with (42) numbers in "
"parameters' does not match 'Oh here is a message with (42) "
"numbers in parameters'. Did you mean to `re.escape()` the regex?"
)

def test_raises_match_wrong_type(self):
"""Raising an exception with the wrong type and match= given.
Expand Down

0 comments on commit 90afa50

Please sign in to comment.